Configuration

An object defining configuration options for the dxButton 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.

Show Example:
AngularJS
Knockout
jQuery

clickAction

Deprecated

Use the onClick option instead.

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

focusStateEnabled

Specifies whether or not the widget can be focused.

Type: Boolean
Default Value: false

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., 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: false

icon

Specifies the icon to be displayed on the button.

Type: String
Default Value: ""

This option accepts the name of an icon from the built-in icon library, a path to the icon image, or a CSS class of an icon stored in an external icon library. For information on using external icon libraries, refer to the Icon Library article.

Show Example:
AngularJS
Knockout
jQuery

iconSrc

Deprecated

Use the icon option instead.

onClick

A handler for the click event.

Type: function|String
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 and AngularJS approaches.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
validationGroup: Object
Specifies the object representing the validation group to which the button is related.
Default Value: null

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

To navigate to a specific URL when the click event fires, assign that URL or the anchor part (#) of that URL directly to this option as a string.

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 dxValidator 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.
Show Example:
AngularJS
Knockout
jQuery

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 and AngularJS approaches.
Default Value: null

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 and AngularJS approaches.
Default Value: null

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

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

template

A template to be used for rendering the dxButton widget.

Type: String|function|DOM Node|jQuery
Function parameters:
buttonData: Object
An object holding the button text and icon.
contentElement: jQuery
The jQuery object of the button content element.
Return Value: String|jQuery
A template name or a template container.
Default Value: "content"

This option enables you to render a widget depending on the values of the field of the template context object or view model fields.

HTML
<div data-bind="dxButton: { template: 'myButton'}">
    <div data-options="dxTemplate: { name:'myButton' }">
        <span data-bind="dxLoadIndicator: { visible: $parent.isLoading }"></span>
        <span>Load</span>
    </div>
</div>
NOTE
A binding context of a template contains only fields listed in the Default Template topic. So, you can bind template elements to these fields directly. To access another binding context within a template, use the Knockout/Angular binding variables.

text

The text displayed on the button.

Type: String
Default Value: ""

Show Example:
AngularJS
Knockout
jQuery

type

Specifies the button type.

Type: String
Default Value: 'normal'
Accepted Values: 'normal'|'default'|'back'|'danger'|'success'

Show Example:
AngularJS
Knockout
jQuery

validationGroup

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

Type: String
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 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

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 + "%";
    }