Vue Button API

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

import DxButton from "devextreme-vue/button"

Type: DxButtonTypes.default

Props

An object defining configuration options for the Button widget.

Name	Description
accessKey	Specifies the shortcut key that sets focus on the widget.
activeStateEnabled	A Boolean value specifying whether or not the widget 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 widget responds to user interaction.
elementAttr	Specifies the attributes to be attached to the widget's root element.
focusStateEnabled	Specifies whether the widget can be focused using keyboard navigation.
height	Specifies the widget's height.
hint	Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled	Specifies whether the widget 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 widget's content is ready and each time the content is changed.
onDisposing	A function that is executed before the widget is disposed of.
onInitialized	A function used in JavaScript frameworks to save the widget instance.
onOptionChanged	A function that is executed after a widget option 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 widget 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 widget.
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 widget is visible.
width	Specifies the widget's width.

Methods

This section describes members used to manipulate the widget.

Name	Description
beginUpdate()	Prevents the widget from refreshing until the endUpdate() method is called.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
dispose()	Disposes of all the resources allocated to the Button instance.
element()	Gets the root widget element.
endUpdate()	Refreshes the widget after a call of the beginUpdate() method.
focus()	Sets focus on the widget.
getInstance(element)	Gets the instance of a widget found using its DOM node.
instance()	Gets the widget's instance. Use it to access other methods of the widget.
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 widget options.
option(optionName)	Gets the value of a single option.
option(optionName, optionValue)	Updates the value of a single option.
option(options)	Updates the values of several options.
registerKeyHandler(key, handler)	Registers a handler to be executed when a user presses a specific key.
repaint()	Repaints the widget without reloading data. Call it to update the widget's markup.
resetOption(optionName)	Resets an option to its default value.

Events

This section describes events fired by this widget.

Name	Description
click	Raised when the Button is clicked or tapped.
contentReady	Raised when the widget's content is ready.
disposing	Raised before the widget is disposed of.
initialized	Raised only once, after the widget is initialized.
optionChanged	Raised after a widget option is changed.

Vue Button API

See Also

Props

See Also

Methods

Events

See Also