JavaScript/jQuery Button Options

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.

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 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.

View Demo

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 property.
• validators
  An array of Validator UI components that are included to the validation group.
• validate()
  The method that allows you to validate the UI components 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.

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

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

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

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

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

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

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

let buttonInstance = null;

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

import Button from 'devextreme-react/button';

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

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

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

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

See Also

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

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

<dx-button ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-button>

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 { DxButtonModule } from 'devextreme-angular'; 

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

export class AppModule { }  

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

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxButton from 'devextreme-vue/button'; 

export default { 
    components: { 
        DxButton
    }, 
    // ...
    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 Button from 'devextreme-react/button'; 

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

export default function App() { 
    return ( 
        <Button ...
            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 following styles are available:

View Demo

See Also

• type

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

See Also

• Custom Templates

DevExtreme provides the following button types.

$(function() {
    $("#button").dxButton({
        type: "normal",
        icon: "back"
    });
});

<dx-button
    type="normal"
    icon="back"
/>

<template>
    <DxButton ...
        type="normal"
        icon="back"
    />
</template>

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

function App() {
    return (
        <Button ...
            type="normal"
            icon="back" 
        />
    );
};

export default App;

You can also specify your own button type and define its CSS rules as shown in the example:

$(function() {
    $("#button").dxButton({
        // ...
        type: "warning"
    });
});

.dx-button.dx-button-warning {
    background-color: #ffc107;
}

<dx-button ...
    type="warning"
/>

::ng-deep .dx-button.dx-button-warning {
    background-color: #ffc107;
}

<template>
    <DxButton ...
        type="warning"
    />
</template>

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

<style>
    .dx-button.dx-button-warning {
        background-color: #ffc107;
    }
</style>

function App() {
    return (
        <Button ...
            type="warning" 
        />
    );
};

export default App;

.dx-button.dx-button-warning {
    background-color: #ffc107;
}

Note that buttons have a white background when you move them to the Toolbar. We recommend that you use the 'normal' type for such buttons, otherwise the button text is not visible. You can also define custom CSS rules to override the initial styles.

View Demo

See Also

• stylingMode

If this property 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.

If you need to cancel form submission, handle a form's submit event.

View Demo

When using a button to validate several editors on a page, the button must "know" in which validation group these editors are located.

Specify the validationGroup configuration property for the button. Assign the validation group name specified for the validationGroup property of the validators that extend the editors to be validated.

See Also

• Validate Several Editor Values

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.