ToggleButton Typescript API

Interface

ToggleButton

ToggleButton allows the user to change a setting between two states.

Selector

smart-toggle-button

Properties

animationAnimation

Sets or gets the animation mode. Animation is disabled when the property is set to 'none'

Default valueadvanced

checkedboolean

Sets the state of the element.

Default valuefalse

clickModeClickMode

Sets the click mode of the button.

Default valuerelease

disabledboolean

Enables or disables the ratio button.

Default valuefalse

innerHTMLstring

Sets the inner HTML of the element.

Default value"""

localestring

Sets or gets the language. Used in conjunction with the property messages.

Default value"en

localizeFormatFunctionany

Callback, related to localization module.

messagesany

Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.

Default value


"en": {

"propertyUnknownType": "'{{name}}' property is with undefined 'type' member!",

"propertyInvalidValue": "Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!",

"propertyInvalidValueType": "Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!",

"elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",

"moduleUndefined": "Module is undefined.",

"missingReference": "{{elementType}}: Missing reference to {{files}}.",

"htmlTemplateNotSuported": "{{elementType}}: Browser doesn't support HTMLTemplate elements.",

"invalidTemplate": "{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM."

}


namestring

Sets or gets the widget's name.

Default value"""

readonlyboolean

If the custom element is readonly, it cannot be interacted with.

Default valuefalse

themestring

Determines the theme. Theme defines the look of the element

Default value"

unfocusableboolean

If is set to true, the element cannot be focused.

Default valuefalse

valuestring

Sets or gets the widget's value.

Default value"""

onchange((this: Window, ev: Event) => any) | null

This event is triggered when the state of the element is changed.

Arguments

evEvent

Enums

Animation

None Simple Advanced

ClickMode

Hover Press Release PressAndRelease