RadioGroup Configuration

An object defining configuration options for the RadioGroup widget.

accessKey

Specifies a shortcut key that sets focus on the widget element.

Type: String
Default Value: null

The accessKey option value is passed to the accesskey attribute of the actual HTML element of the widget.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

Type: Boolean
Default Value: true

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

dataSource

A data source used to fetch data to be displayed by the widget.

Default Value: null

This option accepts one of the following.

  • Array of objects A simple JavaScript array containing a collection of plain objects.

  • URL A URL to JSON data or to a service returning data in JSON format

  • DataSource or its configuration object A DataSource is an object that provides a handy API for data processing. A DataSource is a stateful object, which means that it saves data processing settings and applies them each time data is loaded. All underlying data access logic of a DataSource is isolated in a Store. A Store provides an API for reading and modifying data. Unlike the DataSource, a Store is a stateless object.

NOTE: If the data source is specified using the dataSource option, use the items option only for reading. Updating data items using the items option may cause unexpected results.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API. Alternatively, you can implement a custom item template.

See Also

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

Type: Boolean
Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

Show Example:
AngularJS
Knockout
jQuery
<div ng-controller="demoController" style="height: 100%;">
    <div class="wrapper" ng-style="{ 'border-color': currentColor }">
        <p><b>Choose border color</b></p>
        <div dx-radio-group="{ 
            items: colors,
            onValueChanged: changeColor,
            valueExpr: 'value',
            bindingOptions: {
                disabled: 'disabledValue',
                value: 'currentColor'
            }
        }"></div>
    </div>
    <div class="dx-fieldset">
        <div class="dx-field">
            <div class="dx-field-label">disabled</div>
            <div class="dx-field-value" ng-model="disabledValue" dx-switch="{ }"></div>
        </div>
    </div>
</div>
var myApp = angular.module('myApp', ['dx']);
myApp.controller("demoController", function ($scope) {
    $scope.colors = [
        { text: "red", value: "#FF0000" },
        { text: "green", value: "#00AA00" },
        { text: "blue", value: "#0000FF" }
    ];
    $scope.currentColor = $scope.colors[0].value;
    $scope.disabledValue = false;
    $scope.changeColor = function (e) {
        $scope.currentColor = e.value;
    }
});
angular.element(document).ready(function () {
    angular.bootstrap(document, ['myApp']);
});
body{
    text-align: center;
}
.wrapper {
    margin: 10px;
    height: auto;
    padding: 10px;
    border: 2px solid red;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
    border-radius: 10px;
    text-align: center;
}
<div class="wrapper" data-bind="style: { 'border-color': currentColor }">
    <p><b>Choose border color</b></p>
    <div data-bind="dxRadioGroup:{ 
        items: colors,
        onValueChanged: changeColor,
        disabled: disabledValue,
        valueExpr: 'value',
        value: currentColor
    }"></div>
</div>
<div class="dx-fieldset">
    <div class="dx-field">
        <div class="dx-field-label">disabled</div>
        <div class="dx-field-value" data-bind="dxSwitch: {
            value: disabledValue
        }"></div>
    </div>
</div>
var myViewModel = {
    colors: [
        { text: "red", value: "#FF0000" },
        { text: "green", value: "#00AA00" },
        { text: "blue", value: "#0000FF" }
    ],
    currentColor: ko.observable("#FF0000"),
    disabledValue: ko.observable(false),
    changeColor: function (e) {
        this.currentColor(e.value);
    }
}
ko.applyBindings(myViewModel);
body{
    text-align: center;
}
.wrapper {
    margin: 10px;
    height: auto;
    padding: 10px;
    border: 2px solid red;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
    border-radius: 10px;
    text-align: center;
}
<div class="wrapper" id="radioGroupWrapper">
    <p><b>Choose border color</b></p>
    <div id="myRadioGroup"></div>
</div>
<div class="dx-fieldset">
    <div class="dx-field">
        <div class="dx-field-label">disabled</div>
        <div class="dx-field-value" id="disabledSelector"></div>
    </div>
</div>
$("#myRadioGroup").dxRadioGroup({
    items: [
        { text: "red", value: "#FF0000" },
        { text: "green", value: "#00AA00" },
        { text: "blue", value: "#0000FF" }
    ],
    value: '#FF0000',
    valueExpr: 'value',
    onValueChanged: function (e) {
        $("#radioGroupWrapper").css({ 'border-color': e.value });
    }
});
$("#disabledSelector").dxSwitch({
    value: false,
    onValueChanged: function (e) {
        $("#myRadioGroup").dxRadioGroup("instance").option("disabled", e.value);
    }
});
body{
    text-align: center;
}
.wrapper {
    margin: 10px;
    height: auto;
    padding: 10px;
    border: 2px solid red;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
    border-radius: 10px;
    text-align: center;
}

displayExpr

Specifies the name of the data source item field whose value is displayed by the widget.

Type: String| function
Default Value: undefined

If the data source item is a simple object holding a value (string, numeric, Boolean, etc.), assign 'this' to the displayExpr option. If the item is a plain object item, assign the required field name or path to the option.

Show Example:
AngularJS
Knockout
jQuery
<div ng-controller="demoController" style="height: 100%;">
    <div class="wrapper" ng-style="{ 'border-color': currentColor }">
        <p><b>Choose border color</b></p>
        <div dx-radio-group="{ 
            items: colors,
            onValueChanged: changeColor,
            valueExpr: 'value',
            bindingOptions: {
                displayExpr: 'exprValue',
                value: 'currentColor'
            }
        }"></div>
    </div>
    <div class="dx-fieldset">
        <div class="dx-field">
            <div class="dx-field-label">displayExpr</div>
            <div class="dx-field-value" ng-model="exprValue" dx-select-box="{
                dataSource: [ 'text', 'value' ]
            }"></div>
        </div>
    </div>
</div>
var myApp = angular.module('myApp', ['dx']);
myApp.controller("demoController", function ($scope) {
    $scope.colors = [
        { text: "red", value: "#FF0000" },
        { text: "green", value: "#00AA00" },
        { text: "blue", value: "#0000FF" }
    ];
    $scope.currentColor = $scope.colors[0].value;
    $scope.exprValue = "text";
    $scope.changeColor = function (e) {
        $scope.currentColor = e.value;
    }
});
angular.element(document).ready(function () {
    angular.bootstrap(document, ['myApp']);
});
body{
    text-align: center;
}
.wrapper {
    margin: 10px;
    height: auto;
    padding: 10px;
    border: 2px solid red;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
    border-radius: 10px;
    text-align: center;
}
<div class="wrapper" data-bind="style: { 'border-color': currentColor }">
    <p><b>Choose border color</b></p>
    <div data-bind="dxRadioGroup:{ 
        items: colors,
        onValueChanged: changeColor,
        displayExpr: exprValue,
        valueExpr: 'value',
        value: currentColor
    }"></div>
</div>
<div class="dx-fieldset">
    <div class="dx-field">
        <div class="dx-field-label">displayExpr</div>
        <div class="dx-field-value" data-bind="dxSelectBox: {
            dataSource: [ 'text', 'value' ],
            value: exprValue
        }"></div>
    </div>
</div>
var myViewModel = {
    colors: [
        { text: "red", value: "#FF0000" },
        { text: "green", value: "#00AA00" },
        { text: "blue", value: "#0000FF" }
    ],
    currentColor: ko.observable("#FF0000"),
    exprValue: ko.observable("text"),
    changeColor: function (e) {
        this.currentColor(e.value);
    }
}
ko.applyBindings(myViewModel);
body{
    text-align: center;
}
.wrapper {
    margin: 10px;
    height: auto;
    padding: 10px;
    border: 2px solid red;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
    border-radius: 10px;
    text-align: center;
}
<div class="wrapper" id="radioGroupWrapper">
    <p><b>Choose border color</b></p>
    <div id="myRadioGroup"></div>
</div>
<div class="dx-fieldset">
    <div class="dx-field">
        <div class="dx-field-label">displayExpr</div>
        <div class="dx-field-value" id="exprSelector"></div>
    </div>
</div>
$("#myRadioGroup").dxRadioGroup({
    items: [
        { text: "red", value: "#FF0000" },
        { text: "green", value: "#00AA00" },
        { text: "blue", value: "#0000FF" }
    ],
    value: '#FF0000',
    displayExpr: 'text',
    valueExpr: 'value',
    onValueChanged: function (e) {
        $("#radioGroupWrapper").css({ 'border-color': e.value });
    }
});
$("#exprSelector").dxSelectBox({
    items: ['text', 'value'],
    value: 'text',
    onValueChanged: function (e) {
        $("#myRadioGroup").dxRadioGroup("instance").option("displayExpr", e.value);
    }
});
body{
    text-align: center;
}
.wrapper {
    margin: 10px;
    height: auto;
    padding: 10px;
    border: 2px solid red;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
    border-radius: 10px;
    text-align: center;
}

focusStateEnabled

Specifies whether or not the widget can be focused.

Type: Boolean
Default Value: false
Default for generic: true

height

Specifies the height of the widget.

Type: Number|String| function
Return Value: Number|String
The widget height.
Default Value: undefined

The option can hold a value of the following types.

  • number
    The height of the widget in pixels

  • string
    A CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit")

  • function
    A function returning the widget height, e.g.,

    JavaScript
    height: function () {
        return baseHeight - 10 + "%";
    });

hint

Specifies the text of the hint displayed for the widget.

Type: String
Default Value: undefined

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

Type: Boolean
Default Value: true

isValid

Specifies whether the editor's value is valid.

Type: Boolean
Default Value: true

In Knockout approach, you may need to use an editor to inform end users that an error occurred during the validation of a ViewModel field. In this instance, set the editor's isValid option to the isValid property value of the dxValidator that validated the ViewModel's field. In addition, set the editor's validationError option to the validationError property value of the dxValidator object.

In the code below, the login specified by an end user is validated on the level of the ViewModel. If validation of the login value fails, a validation message is displayed on the Login editor.

HTML
<div data-bind="dxTextBox: {
    value: login,
    isValid: login.dxValidator.isValid,
    validationError: login.dxValidator.validationError,
    placeholder: 'Login'
}"></div>
JavaScript
var viewModel = {
    login: ko.observable("").extend({
        dxValidator: {
            validationRules: [{
                type: 'required',
                message: 'Login is required'
            }]
        }
    }),
    //...
}

NOTE: The editor's isValid option, as well as the validationError option, should also be specified when using a custom validation engine. In this instance, the validation result will be displayed for the editor by the means of the DevExtreme Validation UI.

See Also

items

An array of items displayed by the widget.

Type: Array

You can use the dataSource option instead. Unlike the items option, the dataSource option can take on the DataSource configuration object as well as a simple array.

NOTE: If you need to modify the data source specified using the items option at runtime, do it only with the help of the items option. Updating data items using the dataSource option may cause unexpected results.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API. Alternatively, you can implement a custom item template.

See Also

itemTemplate

The template to be used for rendering items.

Type: template
Function parameters:
itemData: Object
The item object to be rendered.
itemIndex: Number
The index of the item to be rendered.
itemElement: jQuery
An HTML element of the item to be rendered.
Return Value: String|DOM Node|jQuery
A template name or a template container.
Default Value: 'item'

A binding context of an item template is the data source object that corresponds to the currently rendered item.

In Knockout approach, you can bind template elements to the item object's fields directly. To access another binding context within an item template, use Knockout binding variables.

In AngularJS approach, if you need to access item object fields within a template, use a variable whose name is assigned to the dx-item-alias directive. Add the directive to the widget element to specify an alias to the root object of an item. Without this directive, item object fields are beyond reach. To access another binding context within an item template, use Angular binding variables.

See Also

layout

Specifies the radio group layout.

Type: String
Default Value: 'vertical'
Default for tablets: 'horizontal'
Accepted Values: 'vertical' | 'horizontal'

The following values are available.

  • 'vertical'
    Radio buttons are arranged vertically - as a column.

  • 'horizontal'
    Radio buttons are arranged horizontally - as a row.

Show Example:
AngularJS
Knockout
jQuery
<div ng-controller="demoController" style="height: 100%;">
    <div class="wrapper" ng-style="{ 'border-color': currentColor }">
        <p><b>Choose border color</b></p>
        <div dx-radio-group="{ 
            items: colors,
            onValueChanged: changeColor,
            valueExpr: 'value',
            bindingOptions: {
                layout: 'layoutValue',
                value: 'currentColor'
            }
        }"></div>
    </div>
    <div class="dx-fieldset">
        <div class="dx-field">
            <div class="dx-field-label">layout</div>
            <div class="dx-field-value" ng-model="layoutValue" dx-select-box="{
                dataSource: [ 'vertical', 'horizontal' ]
            }"></div>
        </div>
    </div>
</div>
var myApp = angular.module('myApp', ['dx']);
myApp.controller("demoController", function ($scope) {
    $scope.colors = [
        { text: "red", value: "#FF0000" },
        { text: "green", value: "#00AA00" },
        { text: "blue", value: "#0000FF" }
    ];
    $scope.currentColor = $scope.colors[0].value;
    $scope.layoutValue = "vertical";
    $scope.changeColor = function (e) {
        $scope.currentColor = e.value;
    }
});
angular.element(document).ready(function () {
    angular.bootstrap(document, ['myApp']);
});
body{
    text-align: center;
}
.wrapper {
    margin: 10px;
    height: auto;
    padding: 10px;
    border: 2px solid red;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
    border-radius: 10px;
    text-align: center;
}
<div class="wrapper" data-bind="style: { 'border-color': currentColor }">
    <p><b>Choose border color</b></p>
    <div data-bind="dxRadioGroup:{ 
        items: colors,
        onValueChanged: changeColor,
        layout: layoutValue,
        valueExpr: 'value',
        value: currentColor
    }"></div>
</div>
<div class="dx-fieldset">
    <div class="dx-field">
        <div class="dx-field-label">layout</div>
        <div class="dx-field-value" data-bind="dxSelectBox: { dataSource: [ 'vertical', 'horizontal' ], value: layoutValue }"></div>
    </div>
</div>
var myViewModel = {
    colors: [
        { text: "red", value: "#FF0000" },
        { text: "green", value: "#00AA00" },
        { text: "blue", value: "#0000FF" }
    ],
    currentColor: ko.observable("#FF0000"),
    layoutValue: ko.observable("vertical"),
    changeColor: function (e) {
        this.currentColor(e.value);
    }
}
ko.applyBindings(myViewModel);
body{
    text-align: center;
}
.wrapper {
    margin: 10px;
    height: auto;
    padding: 10px;
    border: 2px solid red;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
    border-radius: 10px;
    text-align: center;
}
<div class="wrapper" id="radioGroupWrapper">
    <p><b>Choose border color</b></p>
    <div id="myRadioGroup"></div>
</div>
<div class="dx-fieldset">
    <div class="dx-field">
        <div class="dx-field-label">layout</div>
        <div class="dx-field-value" id="layoutSelector"></div>
    </div>
</div>
$("#myRadioGroup").dxRadioGroup({
    items: [
        { text: "red", value: "#FF0000" },
        { text: "green", value: "#00AA00" },
        { text: "blue", value: "#0000FF" }
    ],
    value: '#FF0000',
    layout: 'vertical',
    valueExpr: 'value',
    onValueChanged: function (e) {
        $("#radioGroupWrapper").css({ 'border-color': e.value });
    }
});
$("#layoutSelector").dxSelectBox({
    items: ['vertical', 'horizontal'],
    value: 'vertical',
    onValueChanged: function (e) {
        $("#myRadioGroup").dxRadioGroup("instance").option("layout", e.value);
    }
});
body{
    text-align: center;
}
.wrapper {
    margin: 10px;
    height: auto;
    padding: 10px;
    border: 2px solid red;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
    border-radius: 10px;
    text-align: center;
}

onDisposing

A handler for the disposing event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

Assign a function to perform a custom action when the widget is being removed.

NOTE: The function assigned to this option is executed only if the widget is removed using the remove(), empty(), or html() jQuery methods.

onInitialized

A handler for the initialized event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
Default Value: null

Assign a function to perform a custom action when the widget is initialized.

onOptionChanged

A handler for the optionChanged event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
name: String
Specifies the name of the option whose value is changed.
fullName: String
Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.
value: any
Specifies a new value for the option.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

onValueChanged

A handler for the valueChanged event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
value: Object
The widget's new value.
previousValue: Object
The widget's previous value.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
Default Value: null

Assign a function to perform a custom action when the editor value changes.

readOnly

A Boolean value specifying whether or not the widget is read-only.

Type: Boolean
Default Value: false

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

Type: Boolean
Default Value: false

If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.

tabIndex

Specifies the widget tab index.

Type: Number
Default Value: 0

validationError

Holds the object that defines the error that occurred during validation.

Type: Object
Default Value: undefined

In Knockout approach, you may need to use an editor to inform end users that an error occurred during the validation of a ViewModel field. In this instance, set the editor's isValid option to the isValid property value of the dxValidator that validated the ViewModel's field. In addition, set the editor's validationError option to the validationError property value of the dxValidator object.

In the code, the login specified by an end user is validated on the level of the ViewModel. If validation of the login value fails, a validation message is displayed on the Login editor.

HTML
<div data-bind="dxTextBox: {
    value: login,
    isValid: login.dxValidator.isValid,
    validationError: login.dxValidator.validationError,
    placeholder: 'Login'
}"></div>
JavaScript
var viewModel = {
    login: ko.observable("").extend({
        dxValidator: {
            validationRules: [{ type: 'required', message: 'Login is required' }]
        }
    }),
    //...
}

The editor's validationError option, as well as the isValid option, should also be specified when using a custom validation engine. In this instance, the validation result will be displayed for the editor by the means of the DevExtreme Validation UI.

See Also

validationMessageMode

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.

Type: String
Default Value: 'auto'
Accepted Values: 'auto' | 'always'

The following option values are possible:

  • auto
    The tooltip with the message is displayed when the editor is in focus.
  • always
    The tooltip with the message is not hidden when the editor loses focus.

value

The currently specified value.

Type: Object
Default Value: null

valueExpr

Specifies the name of a data source item field whose value is held in the value configuration option.

Type: String| function
Default Value: 'this'

If the options value is "this", the widget returns the entire selected object from the value option. Note that the "this" value is not supported by a widget bound to an ODataStore.

visible

A Boolean value specifying whether or not the widget is visible.

Type: Boolean
Default Value: true

width

Specifies the width of the widget.

Type: Number|String| function
Return Value: Number|String
The widget width.
Default Value: undefined

The option can hold a value of the following types.

  • numeric
    The widget width in pixels.
  • string
    A CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit").
  • function
    The function returning the widget width. For example, see the following code.

    JavaScript
    width: function () { 
        return baseWidth - 10 + "%";
    }