React Button Props

Default Value: null

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

activeStateEnabled

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

Type:

Default Value: true

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

component

An alias for the template property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

disabled

Specifies whether the widget responds to user interaction.

Type:

Default Value: false

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Default Value: {}

jQuery

$(function(){
    $("#buttonContainer").dxButton({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

HTML

TypeScript

<dx-button ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-button>

import { DxButtonModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxButtonModule
    ],
    // ...
})

Vue

App.vue

<template>
    <DxButton ...
        :element-attr="buttonAttributes">
    </DxButton>
</template>

<script>
import DxButton from 'devextreme-vue/button';

export default {
    components: {
        DxButton
    },
    data() {
        return {
            buttonAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>

React

App.js

import React from 'react';

import Button from 'devextreme-react/button';

class App extends React.Component {
    buttonAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <Button ...
                elementAttr={this.buttonAttributes}>
            </Button>
        );
    }
}
export default App;

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Default Value: true (desktop)

height

Specifies the widget's height.

Type:

|

|

Return Value:

|

The widget's height.

Default Value: undefined

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:
JavaScript
```
height: function() {
    return window.innerHeight / 1.5;
}
```

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type:

Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type:

Default Value: true

icon

Specifies the icon to be displayed on the button.

Type:

Default Value: ''

This option accepts one of the following:

The icon's URL
The icon's name if the icon is from the DevExtreme icon library
The icon's CSS class if the icon is from an external icon library (see External Icon Libraries)
The icon in the Base64 format
The icon in the SVG format. Ensure that the source is reliable.

onClick

A function that is executed when the Button is clicked or tapped.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Button	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
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.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
model	Object	Model data. Available only if you use Knockout.
validationGroup	Object	The validation group to which the button is related.

Default Value: null

To validate the editors that are related to the validation group specified for this button, use the validationGroup field of the object passed as the event handler's parameter. The validationGroup object has the following structure.

group
The name or object of the validation group that is assigned to the button's validationGroup option.
validators
An array of Validator widgets that are included to the validation group.
validate()
The method that allows you to validate the widgets included in the validation group.
validated
The event that occurs after the group is validated. You can attach/detach a handler using the on(eventName, eventHandler)/off(eventName) methods of the group.

onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

Button

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Model data. Available only when using Knockout.

Default Value: null

onDisposing

A function that is executed before the widget is disposed of.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

Button

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Model data. Available only if you use Knockout.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the widget instance.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

Button

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
model	Object	Model data. Available only if you use Knockout.
fullName	String	The path to the modified option that includes all parent options.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	Button	The widget's instance.
name	String	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.

Default Value: null

render

An alias for the template property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Default Value: false

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.

JavaScript

DevExpress.config({
    rtlEnabled: true
});

stylingMode

Specifies how the button is styled.

Type:

Default Value: 'contained'

Accepted Values: 'text' | 'outlined' | 'contained'

The following styles are available:

Button Styling Modes

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

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

template

Specifies a custom template for the Button widget.

Type:

template

Template Data:

Name	Type	Description
icon	String	The button's icon.
text	String	The button's text.

Name

Type

Description

icon

The button's icon.

text

The button's text.

Default Name: 'content'

text

The text displayed on the button.

Type:

Default Value: ''

type

Specifies the button type.

Type:

Default Value: 'normal'

Accepted Values: 'back' | 'danger' | 'default' | 'normal' | 'success'

DevExtreme provides the following button types.

Button Types

Use the ButtonType 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: Normal, Default, Back, Danger, and Success.

useSubmitBehavior

Specifies whether the button submits an HTML form.

Type:

Default Value: false

If this option is set to true, users can click the button to validate the validation group and submit the HTML form. If the group contains async rules, the form is not submitted until they are checked.

If the onClick event handler is specified, it is executed before validation and form submission.

validationGroup

Specifies the name of the validation group to be accessed in the click event handler.

Type:

Default Value: undefined

When using a button to validate several editors on a page, the button must "know" in which validation group these editors are located. If the Knockout or AngularJS approach is used, add the button to the div element that represents the target validation group. When using the jQuery approach, specify the validationGroup configuration option for the button. Assign the validation group name specified for the validationGroup option of the validators that extend the editors to be validated.

visible

Specifies whether the widget is visible.

Type: