PanelButton
A button on your Blocks panel. Learn more.
Additional information about this section
Store values associated with an object
- buttonLabel
Sets or gets the button's label (the text that appears on the button).
- divider
Sets or gets the type of divider displayed under the element.
- label
Sets or gets the text above the button (field title). Maximum length is 120 characters.
- size
Sets or gets the button's size.
- skin
Sets or gets the button's skin.
- stretched
Sets or gets whether the button is stretched to the full width of the panel.
- tooltip
Sets or gets an element's tooltip.
- hidden
Indicates if the element is visible or hidden.
- isVisible
Indicates if the element is actually visible.
- collapsed
Indicates if the element is collapsed or expanded.
- customClassList
A property that represents an element's custom CSS classes.
- deleted
Indicates if an element was temporarily deleted from the DOM. Use the restore function to restore the deleted element.
- rendered
Indicates if an element is currently in the DOM structure.
- global
Indicates if an element appears on all pages or only on the current page.
- id
Gets the element's ID.
- parent
Gets the element's parent element.
- type
Gets the element's type.
- enabled
Indicates if the element is enabled or disabled.
The endpoints exposed by this API
Adds an event handler that runs when the element is clicked.
Hides the element and sets its hidden property to true, using an effect if specified.
Shows the element and sets its hidden property to false, using an effect if specified.
Collapses the element and sets its collapsed property to true.
Expands the element and sets its collapsed property to false.
Deletes an element from the DOM. This is a temporary deletion. Use restore to restore the deleted element. SEO crawlers cannot find content in an element whose ...
Adds an event handler that runs when the pointer is moved onto the element. You can also define an event handler using the Properties and Events panel.
Adds an event handler that runs when the pointer is moved off of the element. You can also define an event handler using the Properties and Events panel.
Restores a deleted element to the DOM.
Scrolls the page to the top of the element using an animation.
Adds an event handler that runs when an element is displayed in the viewable part of the current window.
Adds an event handler that runs when an element is no longer displayed in the viewable part of the current window.
Disables the element and sets its enabled property to false.
Enables the element and sets its enabled property to true.