CheckBox Typescript API

Interface

CheckBox

Checkbox is a component used for allowing a user to make a multiple choice. Broadly used in the forms and surveys.

Selector

smart-check-box

Properties

animationAnimation

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

Default valueadvanced

checkedboolean

Sets or gets the checked state.

Default valuefalse

checkModeCheckMode

Determines which part of the element can be used to toggle it.

Default valueboth

clickModeClickMode

Sets the click mode of the checkbox.

Default valuerelease

disabledboolean

Enables or disables the checkbox.

Default valuefalse

innerHTMLstring

Sets or gets the elements's innerHTML.

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 element is readonly, users cannot interact with it.

Default valuefalse

rightToLeftboolean

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

Default valuefalse

unfocusableboolean

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

Default valuefalse

themestring

Determines the theme. Theme defines the look of the element

Default value"

valuestring

Sets or gets the value of the element.

Default value"""

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

This event is triggered when the widget is checked/unchecked.

Arguments

evEvent
ev.detailObject
ev.detail.value - A boolean value indicating the new state of the button ( checked or not ).
ev.detail.oldValue - A boolean value indicating the previous state of the button ( checked or not ).
ev.detail.changeType - A string flag indicating whether the change event was triggered via API or an event.

Enums

Animation

None Simple Advanced

CheckMode

Both Input Label

ClickMode

Press Release PressAndRelease