ButtonGroup

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

Module: ui/button_group
Export: default
ButtonGroup interactive configuration
Copy Code
Copy to Codepen
$("#buttongroup").dxButtonGroup({
});

                    

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the ButtonGroup widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery
JavaScript
HTML
$(function () {
    $("#buttonGroup").dxButtonGroup({
        items: [{
            style: "bold",
            icon: "bold"
        }, {
            style: "italic",
            icon: "italic"
        }, {
            style: "underline",
            icon: "underline"
        }, {
            style: "strike",
            icon: "strike"
        }],
        keyExpr: "style",
        stylingMode: "outlined",
        selectionMode: "multiple"
    });
});
<div id="buttonGroup"></div>
Angular
HTML
TypeScript
<dx-button-group
    [items]="fontStyles"
    keyExpr="style"
    stylingMode="outlined"
    selectionMode="multiple">
</dx-button-group>
import { DxButtonGroupModule } from "devextreme-angular";
// ...
export class AppComponent {
    fontStyles = [{
        style: "bold",
        icon: "bold"
    }, {
        style: "italic",
        icon: "italic"
    }, {
        style: "underline",
        icon: "underline"
    }, {
        style: "strike",
        icon: "strike"
    }]
}
@NgModule({
    imports: [
        // ...
        DxButtonGroupModule
    ],
    // ...
})
AngularJS
HTML
JavaScript
<div ng-controller="DemoController">
    <div dx-button-group="{
        items: fontStyles,
        keyExpr: 'style',
        stylingMode: 'outlined',
        selectionMode: 'multiple'
    }"></div>
</div>
angular.module("DemoApp", ["dx"])
    .controller("DemoController", function ($scope) {
        $scope.fontStyles = [{
            style: "bold",
            icon: "bold"
        }, {
            style: "italic",
            icon: "italic"
        }, {
            style: "underline",
            icon: "underline"
        }, {
            style: "strike",
            icon: "strike"
        }];
    });
Knockout
HTML
JavaScript
<div data-bind="dxButtonGroup: {
    items: fontStyles,
    keyExpr: 'style',
    stylingMode: 'outlined',
    selectionMode: 'multiple'
}"></div>
var viewModel = {
    fontStyles: [{
        style: "bold",
        icon: "bold"
    }, {
        style: "italic",
        icon: "italic"
    }, {
        style: "underline",
        icon: "underline"
    }, {
        style: "strike",
        icon: "strike"
    }]
};
ko.applyBindings(viewModel);
ASP.NET MVC Controls
Razor C#
Razor VB
@(Html.DevExtreme().ButtonGroup()
    .ID("buttonGroup")
    .Items(buttons => {
        buttons.Add().Icon("bold").Option("style", "bold");
        buttons.Add().Icon("italic").Option("style", "italic");
        buttons.Add().Icon("underline").Option("style", "underline");
        buttons.Add().Icon("strike").Option("style", "strike");
    })
    .KeyExpr("style")
    .StylingMode(ButtonStylingMode.Outlined)
    .SelectionMode(ButtonGroupSelectionMode.Multiple)
)
@(Html.DevExtreme().ButtonGroup() _
    .ID("buttonGroup") _
    .Items(Sub(buttons)
        buttons.Add().Icon("bold").Option("style", "bold")
        buttons.Add().Icon("italic").Option("style", "italic")
        buttons.Add().Icon("underline").Option("style", "underline")
        buttons.Add().Icon("strike").Option("style", "strike")
    End Sub) _
    .KeyExpr("style") _
    .StylingMode(ButtonStylingMode.Outlined) _
    .SelectionMode(ButtonGroupSelectionMode.Multiple)
)
Vue
HTML
TypeScript
<dx-button-group
    :items="fontStyles"
    key-expr="style"
    styling-mode="outlined"
    selection-mode="multiple" />
import { DxButtonGroup } from "devextreme-vue/button-group";

export default {
    components: {
        DxButtonGroup
    },
    data () {
        return {
            fontStyles: [{
                style: "bold",
                icon: "bold"
            }, {
                style: "italic",
                icon: "italic"
            }, {
                style: "underline",
                icon: "underline"
            }, {
                style: "strike",
                icon: "strike"
            }]
        };
    }
}
React
TypeScript
import React from "react";
import { ButtonGroup } from "devextreme-react/button-group";

const fontStyles = [{
    style: "bold",
    icon: "bold"
}, {
    style: "italic",
    icon: "italic"
}, {
    style: "underline",
    icon: "underline"
}, {
    style: "strike",
    icon: "strike"
}];

class App extends React.Component {
    render () {
        return (
            <ButtonGroup
                items={fontStyles}
                keyExpr={"style"}
                stylingMode={"outlined"}
                selectionMode={"multiple"} />
        )
    }
}

export default App;

View Demo

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.

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.

See Also

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. Call it if you made modifications that changed the widget's state to invalid.

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.

optionChanged

Raised after a widget option is changed.

selectionChanged

Raised when a button is selected or selection is canceled.

See Also

Default Item Template

This section describes object fields that can be used in the default item template.

Type:

Object