React ButtonGroup Props

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

See Also
jQuery
Angular
Vue
React

accessKey

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

Type:

String

Default Value: undefined

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

activeStateEnabled

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

Type:

Boolean

Default Value: false

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.

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.

Type:

template

Template Data:

Object

An object from the items array, extended with the icon and text fields.

Default Name: 'content'

jQuery
index.js
$(function() {
    $("#buttonGroupContainer").dxButtonGroup({
        // ...
        buttonTemplate: function(itemData, $buttonContent) {
            $buttonContent.append(
                // Custom jQuery elements go here
            )
            // ===== or =====
            return /* your markup goes here */
        }
    });
});
Angular
app.component.html
app.module.ts
<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
App.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
App.js
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;

disabled

Specifies whether the UI component responds to user interaction.

Type:

Boolean

Default Value: false

elementAttr

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

Selector: ElementAttr
Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#buttonGroupContainer").dxButtonGroup({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-button-group ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-button-group>
import { DxButtonGroupModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxButtonGroupModule
    ],
    // ...
})
Vue
App.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
App.js
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.

Type:

Boolean

Default Value: true

height

Specifies the UI component's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's height.

Default Value: undefined

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.

hint

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

Type:

String

Default Value: undefined

hoverStateEnabled

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

Type:

Boolean

Default Value: true

items[]

Configures buttons in the group.

Selector: Item
Type:

Array<dxButtonGroupItem>

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:

JavaScript
buttonGroupInstance.option('items', newItems);
See Also

keyExpr

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

Type:

String

|

Function

Default Value: 'text'

See Also

onContentReady

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

Type:

Function

Function parameters:
e:

ContentReadyEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

ButtonGroup

The UI component's instance.
Default Value: null

onDisposing

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

Type:

Function

Function parameters:
e:

DisposingEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

ButtonGroup

The UI component's instance.
Default Value: null

onInitialized

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

Type:

Function

Function parameters:
e:

InitializedEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

ButtonGroup

The UI component's instance.
Default Value: null

Angular
app.component.html
app.component.ts
<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
App.vue (Options API)
App.vue (Composition API)
<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
App.js
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
jQuery
  • Get a UI component Instance in jQuery
Angular
  • Get a UI component Instance in Angular
Vue
  • Get a UI component Instance in Vue
React
  • Get a UI component Instance in React

onItemClick

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

Type:

Function

Function parameters:
e:

ItemClickEvent

Information about the event.

Object structure:
Name Type Description
component

ButtonGroup

The UI component's instance.
element

HTMLElement | jQuery

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

Object

The clicked button's data.
itemElement

HTMLElement | jQuery

The button's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex

Number

The clicked button's index.
Default Value: null

onOptionChanged

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

Type:

Function

Function parameters:
e:

OptionChangedEvent

Information about the event.

Object structure:
Name Type Description
value any

The modified property's new value.
previousValue any

The UI component's previous value.
name

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
fullName

String

The path to the modified property that includes all parent properties.
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

ButtonGroup

The UI component's instance.
Default Value: null

The following example shows how to subscribe to component property changes:

jQuery
index.js
$(function() {
    $("#buttonGroupContainer").dxButtonGroup({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<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
App.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
App.js
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

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

Type:

Function

Function parameters:
e:

SelectionChangedEvent

Information about the event that caused the function's execution.

Object structure:
Name Type Description
addedItems

Array<any>

The data objects that correspond to the selected buttons.
component

ButtonGroup

The UI component's instance.
element

HTMLElement | jQuery

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.
The objects are taken from the items array.
Default Value: null

See Also

rtlEnabled

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

Type:

Boolean

Default Value: false

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.

JavaScript
DevExpress.config({
    rtlEnabled: true
});

DataGrid Demo Navigation UI Demo Editors Demo

selectedItemKeys

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

Type:

Array<any>

Raised Events: onSelectionChanged

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.

Type:

Array<any>

Raised Events: onSelectionChanged

See Also

selectionMode

Specifies the button selection mode.

Type:

SingleMultipleOrNone

Default Value: 'single'

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

stylingMode

Specifies how buttons in the group are styled.

Type:

ButtonStyle

Default Value: 'contained'

The following styles are available:

Button types

View Demo

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

visible

Specifies whether the UI component is visible.

Type:

Boolean

Default Value: true

width

Specifies the UI component's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's width.

Default Value: undefined

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.