DashboardToggleSwitch
An element for creating a single binary choice on your dashboard page. Learn more.
Additional information about this section
Store values associated with an object
- checked
Sets or gets the state of the toggle switch.
- customClassList
Note: This standard element property is not relevant for this DashboardToggleSwitch.
- label
Sets or gets the toggle switch label. Max: 120 characters
- tooltip
Sets or gets the toggle switch's tooltip content.
- 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.
- 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.
- enabled
Indicates if the element is enabled or disabled.
Perform actions on an object
- delete( )
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 ...
- onMouseIn( )
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.
- onMouseOut( )
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.
- restore( )
Restores a deleted element to the DOM.
- scrollTo( )
Scrolls the page to the top of the element using an animation.
- onViewportEnter( )
Adds an event handler that runs when an element is displayed in the viewable part of the current window.
- onViewportLeave( )
Adds an event handler that runs when an element is no longer displayed in the viewable part of the current window.
- hide( )
Hides the element and sets its hidden property to true, using an effect if specified.
- show( )
Shows the element and sets its hidden property to false, using an effect if specified.
- collapse( )
Collapses the element and sets its collapsed property to true.
- expand( )
Expands the element and sets its collapsed property to false.
- disable( )
Disables the element and sets its enabled property to false.
- enable( )
Enables the element and sets its enabled property to true.