JavaScript/jQuery ButtonGroup API

The ButtonGroup is a UI component that contains a set of toggle buttons and can be used as a mode switcher.

import ButtonGroup from "devextreme/ui/button_group"

Start Tutorial View Demo

See Also
jQuery
Angular
Vue
React
jQuery
Angular
Vue
React

Options

This section describes properties that configure the ButtonGroup UI component's contents, behavior and appearance.

Name Description
accessKey

Specifies the shortcut key that sets focus on the UI component.
activeStateEnabled

Specifies whether the UI component changes its visual state as a result of user interaction.
buttonComponent

An alias for the buttonTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
buttonRender

An alias for the buttonTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
buttonTemplate

Specifies a template for all the buttons in the group.
disabled

Specifies whether the UI component responds to user interaction.
elementAttr

Specifies the global attributes to be attached to the UI component's container element.
focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.
height

Specifies the UI component's height.
hint

Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.
items

Configures buttons in the group.
keyExpr

Specifies which data field provides keys used to distinguish between the selected buttons.
onContentReady

A function that is executed when the UI component is rendered and each time the component is repainted.
onDisposing

A function that is executed before the UI component is disposed of.
onInitialized

A function used in JavaScript frameworks to save the UI component instance.
onItemClick

A function that is executed when a button is clicked or tapped.
onOptionChanged

A function that is executed after a UI component property is changed.
onSelectionChanged

A function that is executed when a button is selected or selection is canceled.
rtlEnabled

Switches the UI component to a right-to-left representation.
selectedItemKeys

Contains keys of selected buttons and allows you to specify initial button selection state.
selectedItems

Contains the data objects that correspond to the selected buttons. The data objects are taken from the items array.
selectionMode

Specifies the button selection mode.
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 UI component is visible.
width

Specifies the UI component's width.

See Also
jQuery
Angular
Vue
React

Methods

This section describes members used to manipulate the UI component.

Name Description
beginUpdate()

Postpones rendering that can negatively affect performance until the endUpdate() method is called.
defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.
dispose()

Disposes of all the resources allocated to the ButtonGroup instance.
element()

Gets the root UI component element.
endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.
focus()

Sets focus on the UI component.
getInstance(element)

Gets the instance of a UI component found using its DOM node.
instance()

Gets the UI component's instance. Use it to access other methods of the UI component.
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 UI component properties.
option(optionName)

Gets the value of a single property.
option(optionName, optionValue)

Updates the value of a single property.
option(options)

Updates the values of several properties.
registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.
repaint()

Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
resetOption(optionName)

Resets a property to its default value.

Events

This section describes events that the ButtonGroup UI component raises.

Name Description
contentReady

Raised when the UI component's content is ready.
disposing

Raised before the UI component is disposed of.
initialized

Raised only once, after the UI component is initialized.
itemClick

Raised when a button is clicked or tapped.
optionChanged

Raised after a UI component property is changed.
selectionChanged

Raised when a button is selected or selection is canceled.

See Also
jQuery
Angular
Vue
React

Types

Name Description
ContentReadyEvent

The type of the contentReady event handler's argument.
DisposingEvent

The type of the disposing event handler's argument.
InitializedEvent

The type of the initialized event handler's argument.
ItemClickEvent

The type of the itemClick event handler's argument.
OptionChangedEvent

The type of the optionChanged event handler's argument.
SelectionChangedEvent

The type of the selectionChanged event handler's argument.