JavaScript/jQuery ButtonGroup Options
This section describes properties that configure the ButtonGroup UI component's contents, behavior and appearance.
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
accessKey
Specifies the shortcut key that sets focus on the UI component.
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
activeStateEnabled
Specifies whether or not the UI component changes its state when interacting with a user.
This property is used when the UI component is displayed on a platform whose guidelines include the active state change for UI components.
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.
jQuery
$(function() { $("#buttonGroupContainer").dxButtonGroup({ // ... buttonTemplate: function(itemData, $buttonContent) { $buttonContent.append( // Custom jQuery elements go here ) // ===== or ===== return /* your markup goes here */ } }); });
Angular
<dx-button-group ... buttonTemplate="myTemplate"> <div *dxTemplate="let buttonData of 'myTemplate'"> <!-- your markup goes here --> </div> </dx-button-group>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxButtonGroupModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxButtonGroupModule ], providers: [], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxButtonGroup ... button-template="myTemplate"> <template #myTemplate="{ data }"> <!-- your markup goes here --> </template> </DxButtonGroup> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import { DxButtonGroup } from 'devextreme-vue'; export default { components: { DxButtonGroup }, data() { return { // ... } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import { ButtonGroup } from 'devextreme-react'; const renderButton = (data) => { return ( {/* your markup goes here */} ); } class App extends React.Component { render() { return ( <ButtonGroup ... buttonRender={renderButton} /> ); } } export default App;
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.
jQuery
$(function(){ $("#buttonGroupContainer").dxButtonGroup({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-button-group ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-button-group>
import { DxButtonGroupModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxButtonGroupModule ], // ... })
Vue
<template> <DxButtonGroup ... :element-attr="buttonGroupAttributes"> </DxButtonGroup> </template> <script> import DxButtonGroup from 'devextreme-vue/button-group'; export default { components: { DxButtonGroup }, data() { return { buttonGroupAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React from 'react'; import ButtonGroup from 'devextreme-react/button-group'; class App extends React.Component { buttonGroupAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <ButtonGroup ... elementAttr={this.buttonGroupAttributes}> </ButtonGroup> ); } } export default App;
focusStateEnabled
Specifies whether the UI component can be focused using keyboard navigation.
height
Specifies the UI component's height.
This property accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
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.
itemComponent
An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
itemRender
An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
items[]
Configures buttons in the group.
The items array can contain:
- Objects with fields described in this section
- Objects with any other fields. In this case, specify the buttonTemplate.
If you need to update the UI component items, reassign the entire items[] array as shown in the following example:
buttonGroupInstance.option('items', newItems);
See Also
itemTemplate
Use the buttonTemplate property instead.
Specifies a custom button template.
See Also
keyExpr
Specifies which data field provides keys used to distinguish between the selected buttons.
See Also
onContentReady
A function that is executed when the UI component's content is ready and each time the content is changed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only when using Knockout. |
onDisposing
A function that is executed before the UI component is disposed of.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if you use Knockout. |
onInitialized
A function used in JavaScript frameworks to save the UI component instance.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onItemClick
A function that is executed when a button is clicked or tapped.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. |
itemData |
The clicked button's data. |
|
itemElement |
The button's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemIndex |
The clicked button's index. |
|
model |
Model data. Available only if you use Knockout. |
onOptionChanged
A function that is executed after a UI component property is changed.
Information about the event.
Name | Type | Description |
---|---|---|
model |
Model data. Available only if you use Knockout. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
value | any |
The modified property's new value. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#buttonGroupContainer").dxButtonGroup({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<dx-button-group ... (onOptionChanged)="handlePropertyChange($event)"> </dx-button-group>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... handlePropertyChange(e) { if(e.name === "changedProperty") { // handle the property change here } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxButtonGroupModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxButtonGroupModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxButtonGroup ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxButtonGroup from 'devextreme-vue/button-group'; export default { components: { DxButtonGroup }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import ButtonGroup from 'devextreme-react/button-group'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <ButtonGroup ... onOptionChanged={handlePropertyChange} /> ); }
onSelectionChanged
A function that is executed when a button is selected or selection is canceled.
Information about the event that caused the function's execution.
Name | Type | Description |
---|---|---|
addedItems | Array<any> |
The data objects that correspond to the selected buttons. |
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if you use Knockout. |
|
removedItems | Array<any> |
The data objects that correspond to the buttons whose selection has been canceled. |
See Also
rtlEnabled
Switches the UI component to a right-to-left representation.
When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
DevExpress.config({ rtlEnabled: true });
See Also
- Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors
selectedItemKeys
Contains the keys of the selected buttons and allows selecting buttons initially.
Array<any>
The data field that provides the keys can be specified using the keyExpr property.
See Also
selectedItems
Contains the data objects that correspond to the selected buttons. The data objects are taken from the items array.
Array<any>
See Also
selectionMode
Specifies whether a single or multiple buttons can be in the selected state simultaneously.
Use the ButtonGroupSelectionMode
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Single
and Multiple
.
stylingMode
Specifies how buttons in the group are styled.
The following styles are available:
Use the ButtonStylingMode
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Text
, Outlined
, and Contained
.
tabIndex
Specifies the number of the element when the Tab key is used for navigating.
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
width
Specifies the UI component's width.
This property accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
If you have technical questions, please create a support ticket in the DevExpress Support Center.