Button Typescript API

Interface

Button

Buttons allow users to take actions, and make choices, with a single tap. Buttons communicate actions that users can take.

Selector

smart-button

Properties

animationAnimation

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

Default valueadvanced

clickModeClickMode

Determines the click mode for the element.

Default valuerelease

contentany

Sets the content of the element.

Default value""

disabledboolean

Enables or disables the 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 used to customize the format of the messages that are returned from the 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 name attribute for the element. Name is used when submiting HTML forms.

Default value"""

readonlyboolean

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

Default valuefalse

rightToLeftboolean

Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.

Default valuefalse

themestring

Determines the theme. Theme defines the look of the element

Default value"

typestring

Sets or gets the type of the button.

Default value"Reset

valuestring

Sets or gets the button's value.

Default value"

unfocusableboolean

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

Default valuefalse

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

Click event is triggered regardiong to the chosen clickMode.

Arguments

evEvent

Enums

Animation

None Simple Advanced

ClickMode

Hover Press Release PressAndRelease