The ui5-toggle-button component is an enhanced ui5-button
that can be toggled between pressed and normal states.
Users can use the ui5-toggle-button as a switch to turn a setting on or off.
It can also be used to represent an independent choice similar to a check box.
Clicking or tapping on a ui5-toggle-button changes its state to pressed. The button returns to
its initial state when the user clicks or taps on it again.
By applying additional custom CSS-styling classes, apps can give a different style to any ui5-toggle-button.
Defines the icon, displayed as graphical element within the component. The SAP-icons font provides numerous options. Example: See all the available icons within the Icon Explorer.
When set to true, the component will automatically submit the nearest HTML form element on press. Note: For the submits property to have effect, you must add the following import to your project: import "@ui5/webcomponents/dist/features/InputElementsFormSupport.js";
Type
boolean
Default
false
Deprecated
Set the "type" property to "Submit" to achieve the same result. The "submits" property is ignored if "type" is set to any value other than "Button".
Defines the tooltip of the component. Note: A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function.
An object of strings that defines several additional accessibility attribute values for customization depending on the use case. It supports the following fields: - expanded: Indicates whether the button, or another grouping element it controls, is currently expanded or collapsed. Accepts the following string values: - true - false - hasPopup: Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by the button. Accepts the following string values: - Dialog - Grid - ListBox - Menu - Tree - controls: Identifies the element (or elements) whose contents or presence are controlled by the button element. Accepts a string value.
Defines whether the button has special form-related functionality. Note: For the type property to have effect, you must add the following import to your project: import "@ui5/webcomponents/dist/features/InputElementsFormSupport.js";
Describes the accessibility role of the button. Note: Use link role only with a press handler, which performs a navigation. In all other scenarios the default button semantics are recommended.
Defines the text of the component. Note: Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.
Fired when the component is activated either with a mouse/tap or by using the Enter or Space key. Note: The event will not be fired if the disabled property is set to true.