JavaScript/jQuery ButtonGroup Options
This section describes options that configure the ButtonGroup widget's contents, behavior and appearance.
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
accessKey
The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.
elementAttr
Specifies the attributes to be attached to the widget's root 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
],
// ...
})ASP.NET MVC Controls
@(Html.DevExtreme().ButtonGroup()
.ElementAttr("class", "class-name")
// ===== or =====
.ElementAttr(new {
@id = "elementId",
@class = "class-name"
})
// ===== or =====
.ElementAttr(new Dictionary<string, object>() {
{ "id", "elementId" },
{ "class", "class-name" }
})
)@(Html.DevExtreme().ButtonGroup() _
.ElementAttr("class", "class-name")
' ===== or =====
.ElementAttr(New With {
.id = "elementId",
.class = "class-name"
})
' ===== or =====
.ElementAttr(New Dictionary(Of String, Object) From {
{ "id", "elementId" },
{ "class", "class-name" }
})
)height
This option 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; }
itemComponent
An alias for the itemTemplate option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
itemRender
An alias for the itemTemplate option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
items
If you need to update the widget items, reassign the entire items[] array as shown in the following example:
buttonGroupInstance.option('items', newItems);Particular fields in objects can control the widget's appearance. See Default Templates for more information.
See Also
onContentReady
A function that is executed when the widget's content is ready and each time the content is changed.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only when using Knockout. |
onDisposing
A function that is executed before the widget is disposed of.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if you use Knockout. |
onInitialized
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onItemClick
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget'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 |
The model data. Available only if you use Knockout. |
onOptionChanged
| Name | Type | Description |
|---|---|---|
| model |
The model data. Available only if you use Knockout. |
|
| fullName |
The path to the modified option that includes all parent options. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| component |
The widget's instance. |
|
| name |
The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into. |
|
| value | any |
The modified option's new value. |
onSelectionChanged
| Name | Type | Description |
|---|---|---|
| addedItems | Array<any> |
The data objects that correspond to the selected buttons. |
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if you use Knockout. |
|
| removedItems | Array<any> |
The data objects that correspond to the buttons whose selection has been canceled. |
rtlEnabled
When this option is set to true, the widget 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
Array<any>
The data field that provides the keys can be specified using the keyExpr option.
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
Use the ButtonGroupSelectionMode enum to specify this option when the widget 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
The following styles are available:
Use the ButtonStylingMode enum to specify this option when the widget 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
The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.
width
This option 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; }