React RadioGroup Props

See Also

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

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.

The RadioGroup works with collections of objects or string, number, or boolean values.

Depending on your data source, bind RadioGroup to data as follows. In each case, also specify the valueExpr, displayExpr, or both if the data source provides objects.

• Data Array
  Assign the array to the dataSource option.

• Read-Only Data in JSON Format
  Set the dataSource property to the URL of a JSON file or service that returns JSON data.

• OData
  Implement an ODataStore.

• Web API, PHP, MongoDB
  Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:

  • DevExtreme.AspNet.Data
  • DevExtreme-PHP-Data
  • devextreme-query-mongodb

  Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.

  jQuery

  JavaScript

  $(function() {
      let serviceUrl = "https://url/to/my/service";
      $("#radioGroupContainer").dxRadioGroup({
          // ...
          dataSource: DevExpress.data.AspNet.createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      })
  });

  Angular

  app.component.ts

  app.component.html

  app.module.ts

  import { Component } from '@angular/core';
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      store: CustomStore;
      constructor() {
          let serviceUrl = "https://url/to/my/service";
          this.store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      }
  }

  <dx-radio-group ...
      [dataSource]="store">
  </dx-radio-group>

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxRadioGroupModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxRadioGroupModule
      ],
      providers: [],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  App.vue

  <template> 
      <DxRadioGroup ...
          :data-source="store" />
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import { DxRadioGroup } from 'devextreme-vue/radio-group';
  
  export default {
      components: {
          DxRadioGroup
      },
      data() {
          const serviceUrl = "https://url/to/my/service";
          const store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          });
          return {
              store
          }
      }
  }
  </script>

  React

  App.js

  import React from 'react';
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import RadioGroup from 'devextreme-react/radio-group';
  
  const serviceUrl = "https://url/to/my/service";
  const store = createStore({
      key: "ID",
      loadUrl: serviceUrl + "/GetAction",
      insertUrl: serviceUrl + "/InsertAction",
      updateUrl: serviceUrl + "/UpdateAction",
      deleteUrl: serviceUrl + "/DeleteAction"
  });
  
  class App extends React.Component {
      render() {
          return (
              <RadioGroup ...
                  dataSource={store} />
          );
      }
  }
  export default App;

• Any other data source
  Implement a CustomStore.

Regardless of the data source on the input, the RadioGroup always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.

Set this property to the name of a data field that provides displayed values...

displayExpr: "name"

... or to a function that returns the displayed value:

displayExpr: function(item) {
    // "item" can be null
    return item && 'ID: ' + item.id + ', Name: ' + item.name;
}

Leave this property unspecified or set it to this if the data source contains primitives.

See Also

• valueExpr

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.

This property is a read-only flag. You can use it to check if the editor value changed.

$(() => {
    const radioGroup = $('#radioGroup').dxRadioGroup({
        // ...
    }).dxRadioGroup('instance');

    $('#button').dxButton({
        // ...
        onClick () {
            if (radioGroup.option('isDirty')) {
                DevExpress.ui.notify("Do not forget to save changes", "warning", 500);
            }
        }
    });
});

import { Component, ViewChild } from '@angular/core';
import { DxRadioGroupComponent, DxButtonModule } from 'devextreme-angular';
import notify from 'devextreme/ui/notify';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    @ViewChild('radioGroupRef', { static: false }) radioGroup: DxRadioGroupComponent;

    onClick () {
        if (this.radioGroup.instance.option('isDirty')) {
            notify("Do not forget to save changes", "warning", 500);
        }
    }
}

<dx-radio-group ... 
    #radioGroupRef
>
</dx-radio-group>
<dx-button ...
    (onClick)="onClick($event)"
>
</dx-button>

<template>
    <DxRadioGroup ...
        :ref="radioGroupRef"
    >
    </DxRadioGroup>
    <DxButton ...
        @click="onClick"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';
import DxRadioGroup from 'devextreme-vue/radio-group';
import DxButton from 'devextreme-vue/button';
import notify from 'devextreme/ui/notify';

export default {
    components: {
        DxRadioGroup,
        DxButton
    },

    data() {
        return {
            radioGroupRef
        }
    },

    methods: {
        onClick () {
            if (this.radioGroup.option('isDirty')) {
                notify("Do not forget to save changes", "warning", 500);
            }
        }
    },

    computed: {
        radioGroup: function() {
            return this.$refs[radioGroupRef].instance;
        }
    }
}
</script>

import React, { useRef } from 'react';
import RadioGroup from 'devextreme-react/radio-group';
import Button from 'devextreme-react/button';
import 'devextreme/dist/css/dx.light.css';

const App = () => {
    const radioGroupRef = useRef(null);

    const onClick = () => {
        if (this.radioGroupRef.current.instance().option('isDirty')) {
            notify("Do not forget to save changes", "warning", 500);
        }
    };

    return (
        <RadioGroup ...
            ref={radioGroupRef}
        >
        </RadioGroup>
        <Button ...
            onClick={onClick}
        />
    );
};

export default App;

See Also

• reset

See Also

• validationErrors

The items array can contain:

• Objects with fields described in this section
• Objects with any other fields. In this case, specify the itemTemplate.

If you need to update the UI component items, reassign the entire items array as shown in the following example:

radioGroupInstance.option('items', newItems);

As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores provide an API that allows you to update individual items without reassigning the entire item collection.

See Also

• Customize Item Appearance
• Custom Templates

The following values are available.

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

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

Specify this property if the UI component lies within an HTML form that will be submitted.

<dx-radio-group ...
    (onInitialized)="saveInstance($event)">
</dx-radio-group>

import { Component } from "@angular/core";
import RadioGroup from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    radioGroupInstance: RadioGroup;
    saveInstance (e) {
        this.radioGroupInstance = e.component;
    }
}

<template>
    <div>
        <DxRadioGroup ...
            @initialized="saveInstance">
        </DxRadioGroup>
    </div>
</template>

<script>
import DxRadioGroup from 'devextreme-vue/radio-group';

export default {
    components: {
        DxRadioGroup
    },
    data: function() {
        return {
            radioGroupInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.radioGroupInstance = e.component;
        }
    }
};
</script>

<template>
    <div>
        <DxRadioGroup ...
            @initialized="saveInstance">
        </DxRadioGroup>
    </div>
</template>

<script setup>
import DxRadioGroup from 'devextreme-vue/radio-group';

let radioGroupInstance = null;

const saveInstance = (e) => {
    radioGroupInstance = e.component;
}
</script>

import RadioGroup from 'devextreme-react/radio-group';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.radioGroupInstance = e.component;
    }

    render() {
        return (
            <div>
                <RadioGroup onInitialized={this.saveInstance} />
            </div>
        );
    }
}

See Also

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

$(function() {
    $("#radioGroupContainer").dxRadioGroup({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<dx-radio-group ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-radio-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 { DxRadioGroupModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxRadioGroupModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  

<template> 
    <DxRadioGroup ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxRadioGroup from 'devextreme-vue/radio-group'; 

export default { 
    components: { 
        DxRadioGroup
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 

import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import RadioGroup from 'devextreme-react/radio-group'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <RadioGroup ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

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.

DevExpress.config({
    rtlEnabled: true
});

DataGrid Demo Navigation UI Demo Editors Demo

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

See Also

• isValid

The following property 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.

The following example positions a validation message at the component's right:

$(function() {
    $("#radioGroupContainer").dxRadioGroup({
        // ...
        validationMessagePosition: 'right'
    }).dxValidator({
        validationRules: [{
            type: 'required',
            message: 'Required',
        }],
    });
});

<dx-radio-group ...
    validationMessagePosition="right">
    <dx-validator>
        <dxi-validation-rule
            type="required"
            message="Required"
        >
        </dxi-validation-rule>
    </dx-validator>
</dx-radio-group>

<template>
    <DxRadioGroup ...
        validation-message-position="right"
    >
        <DxValidator>
            <DxRequiredRule message="Required" />
        </DxValidator>
    </DxRadioGroup>
</template>

<script>
    // ...
</script>

import React from 'react';
// ...

function App() {
    return (
        <RadioGroup ...
            validationMessagePosition="right"
        >
            <Validator>
                <RequiredRule message="Required" />
            </Validator>
        </RadioGroup>
    ); 

};
export default App;

The following table illustrates the validation status indicators:

validationStatus	Indicator
"pending"
"valid"
"invalid"

When you assign "invalid" to validationStatus, you can also use the validationErrors array to set an error message as shown below:

$(function() {
    const radioGroup = $("#radioGroupContainer").dxRadioGroup({
        // ...
    }).dxRadioGroup("instance");

    function setInvalidStatus(message) {
        radioGroup.option({
            validationStatus: "invalid",
            validationErrors: [{ message: message }]
        });
    }
});

<dx-radio-group
    [validationStatus]="validationStatus"
    [validationErrors]="validationErrors">
</dx-radio-group>

// ...
export class AppComponent {
    validationStatus: string = "valid";
    validationErrors: any;
    // ...
    setInvalidStatus(message) {
        this.validationStatus = "invalid";
        this.validationErrors = [{ message: message }];
    }
}

<template>
    <DxRadioGroup ...
        :validation-status="validationStatus"
        :validation-errors="validationErrors"
    />
</template>

<script>
    // ...
    export default {
        // ...
        data() {
            return {
                validationStatus: "valid",
                validationErrors: []
            }
        },
        methods: {
            setInvalidStatus(message) {
                this.validationStatus = "invalid";
                this.validationErrors = [{ message: message }];
            }
        }
    }
</script>

import React, { useState } from 'react';
// ...

function App() {
    const [validationStatus, setValidationStatus] = useState("valid");
    const [validationErrors, setValidationErrors] = useState([]);

    const setInvalidStatus = message => {
        setValidationStatus("invalid");
        setValidationErrors([{ message: message }]);
    }

    return (
        <RadioGroup
            validationStatus={validationStatus}
            validationErrors={validationErrors}
        />
    ); 

};
export default App;

View Demo

When dataSource contains objects, you should define valueExpr to correctly identify data items. Otherwise, the component uses referential equality to compare objects, which may result in unexpected behavior.

If you use a store, the valueExpr property should have the same value as the key in the store. Alternatively, you can use this as a valueExpr but the key should be specified. Refer to the following article for more information: Troubleshooting - A Drop-Down Editor Does Not Show Data.

Do not use template as a valueExpr value.

See Also

• displayExpr

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.