ButtonGroup
The ButtonGroup is a widget that contains a set of toggle buttons and can be used as a mode switcher.
Configuration
This section describes options that configure the ButtonGroup widget's contents, behavior and appearance.
| Name | Description |
|---|---|
| accessKey | Specifies the shortcut key that sets focus on the widget. |
| activeStateEnabled | Specifies whether or not the widget changes its state when interacting with a user. |
| disabled | Specifies whether the widget responds to user interaction. |
| elementAttr | Specifies the attributes to be attached to the widget's root element. |
| focusStateEnabled | Specifies whether the widget can be focused using keyboard navigation. |
| height | Specifies the widget's height. |
| hint | Specifies text for a hint that appears when a user pauses on the widget. |
| hoverStateEnabled | Specifies whether the widget changes its state when a user pauses on it. |
| items | Configures buttons in the group. |
| itemTemplate | Specifies a custom button template. |
| keyExpr | Specifies which data field provides keys used to distinguish between the selected buttons. |
| onContentReady | A function that is executed when the widget's content is ready and each time the content is changed. |
| onDisposing | A function that is executed before the widget is disposed of. |
| onInitialized | A function that is executed only once, after the widget is initialized. |
| onItemClick | A function that is executed when a button is clicked or tapped. |
| onOptionChanged | A function that is executed after a widget option is changed. |
| onSelectionChanged | A function that is executed when a button is selected or selection is canceled. |
| rtlEnabled | Switches the widget to a right-to-left representation. |
| selectedItemKeys | Contains the keys of the selected buttons and allows selecting buttons initially. |
| selectedItems | Contains the data objects that correspond to the selected buttons. The data objects are taken from the items array. |
| selectionMode | Specifies whether a single or multiple buttons can be in the selected state simultaneously. |
| stylingMode | Specifies how buttons in the group are styled. |
| tabIndex | Specifies the number of the element when the Tab key is used for navigating. |
| visible | Specifies whether the widget is visible. |
| width | Specifies the widget's width. |
Methods
This section describes members used to manipulate the widget.
| Name | Description |
|---|---|
| beginUpdate() | Prevents the widget from refreshing until the endUpdate() method is called. |
| defaultOptions(rule) | Specifies the device-dependent default configuration options for this component. |
| dispose() | Disposes of all the resources allocated to the ButtonGroup instance. |
| element() | Gets the root widget element. |
| endUpdate() | Refreshes the widget after a call of the beginUpdate() method. |
| focus() | Sets focus on the widget. |
| getInstance(element) | Gets the instance of a widget found using its DOM node. |
| instance() | Gets the widget's instance. Use it to access other methods of the widget. |
| off(eventName) | Detaches all event handlers from a single event. |
| off(eventName, eventHandler) | Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) | Subscribes to an event. |
| on(events) | Subscribes to events. |
| option() | Gets all widget options. |
| option(optionName) | Gets the value of a single option. |
| option(optionName, optionValue) | Updates the value of a single option. |
| option(options) | Updates the values of several options. |
| registerKeyHandler(key, handler) | Registers a handler to be executed when a user presses a specific key. |
| repaint() | Repaints the widget without reloading data. Call it to update the widget's markup. |
Events
This section describes events that the ButtonGroup widget raises.
| Name | Description |
|---|---|
| contentReady | Raised when the widget's content is ready. |
| disposing | Raised before the widget is disposed of. |
| initialized | Raised only once, after the widget is initialized. |
| itemClick | Raised when a button is clicked or tapped. |
| optionChanged | Raised after a widget option is changed. |
| selectionChanged | Raised when a button is selected or selection is canceled. |
Default Item Template
This section describes object fields that can be used in the default item template.