RadioGroup

The dxRadioGroup is a widget that contains a set of radio buttons and allows an end user to make a single selection from the set.

Included in: dx.phonejs.js, dx.webappjs.js, dx.all.js
RadioGroup interactive configuration
Copy Code
Copy to Codepen
$("#radiogroup").dxRadioGroup({
});

                    

You can create the widget using one of the following approaches.

  • jQuery
    Use the dxRadioGroup jQuery plug-in.

    HTML
    <div id="radioGroup"></div>
    JavaScript
    $("#radioGroup").dxRadioGroup({
        dataSource: radioGroupData,
        layout: 'vertical'
    });
  • Knockout
    Add a div element and apply the dxRadioGroup binding to this element.

    HTML
    <div data-bind="dxRadioGroup: {
        dataSource: radioGroupData,
        layout: 'vertical'
    }"></div>
  • AngularJS
    Add a div element and apply the dx-radio-group directive to this element.

    HTML
    <div dx-radio-group="{
        dataSource: radioGroupData,
        layout: 'vertical'
    }"></div>

Note that DevExtreme widgets require you to link the jQuery and Globalize libraries to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the Installation article.

Since the dxRadioGroup widget is used to display multiple items, it supports common Collection Container widget functionality. You can find the detailed information on principles of working with the widget in the dxRadioGroup section of the Collection Container Widgets article.

View Demo

Watch Video

Configuration

An object defining configuration options for the dxRadioGroup widget.

Name Description
accessKey

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

activeStateEnabled

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

dataSource

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

disabled

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

displayExpr

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

focusStateEnabled

Specifies whether or not the widget can be focused.

height

Specifies the height of the widget.

hint

Specifies the text of the hint displayed for the widget.

hoverStateEnabled

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

isValid

Specifies whether the editor's value is valid.

items

An array of items displayed by the widget.

itemTemplate

The template to be used for rendering items.

layout

Specifies the radio group layout.

onDisposing

A handler for the disposing event.

onInitialized

A handler for the initialized event.

onOptionChanged

A handler for the optionChanged event.

onValueChanged

A handler for the valueChanged event.

readOnly

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

rtlEnabled

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

tabIndex

Specifies the widget tab index.

validationError

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

validationMessageMode

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

value

The currently specified value.

valueExpr

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

visible

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

width

Specifies the width of the widget.

Methods

This section describes the members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the component from refreshing until the endUpdate method is called.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate method call.

focus()

Sets focus on the widget.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

registerKeyHandler(key, handler)

Registers a handler when a specified key is pressed.

repaint()

Redraws the widget.

reset()

Resets the editor's value to undefined.

Events

This section describes events fired by this widget.

Name Description
disposing

Fires when the widget is being removed.

initialized

Fires when the widget is initialized.

optionChanged

Fires after an option of the component is changed.

valueChanged

Fires when the editor value changes.

Default Item Template

This section lists the data source fields that are used in a default item template.

By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is the list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.

See Also