JavaScript/jQuery ButtonGroup Options
This section describes properties that configure the ButtonGroup UI component's contents, behavior and appearance.
See Also
accessKey
The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.
activeStateEnabled
The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.
Use this property when you display the component on a platform whose guidelines include the active state change for UI components.
buttonTemplate
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.light.css';
import { DxButtonGroup } from 'devextreme-vue';
export default {
components: {
DxButtonGroup
},
data() {
return {
// ...
}
}
}
</script>React
import React from 'react';
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;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;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","20vh","80%","inherit".Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
items[]
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
onContentReady
A function that is executed when the UI component is rendered and each time the component is repainted.
| Name | Type | Description |
|---|---|---|
| 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. |
onDisposing
A function that is executed before the UI component is disposed of.
| Name | Type | Description |
|---|---|---|
| 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. |
onInitialized
| Name | Type | Description |
|---|---|---|
| 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. |
Angular
<dx-button-group ...
(onInitialized)="saveInstance($event)">
</dx-button-group>
import { Component } from "@angular/core";
import ButtonGroup from "devextreme/ui/data_grid";
// ...
export class AppComponent {
buttonGroupInstance: ButtonGroup;
saveInstance (e) {
this.buttonGroupInstance = e.component;
}
}Vue
<template>
<div>
<DxButtonGroup ...
@initialized="saveInstance">
</DxButtonGroup>
</div>
</template>
<script>
import DxButtonGroup from 'devextreme-vue/button-group';
export default {
components: {
DxButtonGroup
},
data: function() {
return {
buttonGroupInstance: null
};
},
methods: {
saveInstance: function(e) {
this.buttonGroupInstance = e.component;
}
}
};
</script>
<template>
<div>
<DxButtonGroup ...
@initialized="saveInstance">
</DxButtonGroup>
</div>
</template>
<script setup>
import DxButtonGroup from 'devextreme-vue/button-group';
let buttonGroupInstance = null;
const saveInstance = (e) => {
buttonGroupInstance = e.component;
}
</script>React
import ButtonGroup from 'devextreme-react/button-group';
class App extends React.Component {
constructor(props) {
super(props);
this.saveInstance = this.saveInstance.bind(this);
}
saveInstance(e) {
this.buttonGroupInstance = e.component;
}
render() {
return (
<div>
<ButtonGroup onInitialized={this.saveInstance} />
</div>
);
}
}See Also
onItemClick
| 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 an EventObject 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. |
onOptionChanged
| Name | Type | Description |
|---|---|---|
| value | any |
The modified property's new value. |
| previousValue | any |
The UI component's previous value. |
| name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
| 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. |
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.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.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
| 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. |
|
| removedItems | Array<any> |
The data objects that correspond to the buttons whose selection has been canceled. |
rtlEnabled
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
});selectedItemKeys
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>
selectionMode
This property can have one of the following values:
| selectionMode | Description |
|---|---|
| "single" | Only one button can be in the selected state. |
| "multiple" | Multiple buttons can be in the selected state simultaneously. |
| "none" | Buttons cannot be selected, but you can use the onItemClick function to handle the button click event. |
See Also
tabIndex
The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.
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","20vw","80%","auto","inherit".Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.