JavaScript/jQuery Button API

The Button UI component is a simple button that performs specified commands when a user clicks it.

import Button from "devextreme/ui/button"
Type:

Object

View Demo Start Tutorial

See Also

Configuration

An object defining configuration properties for the Button UI component.

Name Description
accessKey

Specifies the shortcut key that sets focus on the UI component.
activeStateEnabled

A Boolean value specifying whether or not the UI component changes its state when interacting with a user.
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 UI component responds to user interaction.
elementAttr

Specifies the global attributes to be attached to the UI component's container element.
focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.
height

Specifies the UI component's height.
hint

Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.
icon

Specifies the icon to be displayed on the button.
onClick

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

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

A function that is executed before the UI component is disposed of.
onInitialized

A function used in JavaScript frameworks to save the UI component instance.
onOptionChanged

A function that is executed after a UI component property is changed.
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 UI component to a right-to-left representation.
stylingMode

Specifies how the button is styled.
tabIndex

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

Specifies a custom template for the Button UI component.
text

The text displayed on the button.
type

Specifies the button type.
useSubmitBehavior

Specifies whether the button submits an HTML form.
validationGroup

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

Specifies whether the UI component is visible.
width

Specifies the UI component's width.

See Also

Methods

This section describes members used to manipulate the UI component.

Name Description
beginUpdate()

Prevents the UI component from refreshing until the endUpdate() method is called.
defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.
dispose()

Disposes of all the resources allocated to the Button instance.
element()

Gets the root UI component element.
endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.
focus()

Sets focus on the UI component.
getInstance(element)

Gets the instance of a UI component found using its DOM node.
instance()

Gets the UI component's instance. Use it to access other methods of the UI component.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
option()

Gets all UI component properties.
option(optionName)

Gets the value of a single property.
option(optionName, optionValue)

Updates the value of a single property.
option(options)

Updates the values of several properties.
registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.
repaint()

Repaints the UI component without reloading data. Call it to update the UI component's markup.
resetOption(optionName)

Resets a property to its default value.

Events

This section describes events fired by this UI component.

Name Description
click

Raised when the Button is clicked or tapped.
contentReady

Raised when the UI component's content is ready.
disposing

Raised before the UI component is disposed of.
initialized

Raised only once, after the UI component is initialized.
optionChanged

Raised after a UI component property is changed.

See Also