React ActionSheet API

The ActionSheet UI component is a sheet containing a set of buttons located one under the other. These buttons usually represent several choices relating to a single task.

import ActionSheet from "devextreme-react/action-sheet"
Selector: ActionSheet

Configuration

An object defining configuration properties for the ActionSheet UI component.

Name Description
cancelText

The text displayed in the button that closes the action sheet.

dataSource

Binds the UI component to data.

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.

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.

itemComponent

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

itemHoldTimeout

The time period in milliseconds before the onItemHold event is raised.

itemRender

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

items

An array of items displayed by the UI component.

itemTemplate

Specifies a custom template for items.

onCancelClick

A function that is executed when the Cancel button is clicked or tapped.

onContentReady

A function that is executed when the UI component is rendered and each time the component is repainted.

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.

onItemClick

A function that is executed when a collection item is clicked or tapped.

onItemContextMenu

A function that is executed when a collection item is right-clicked or pressed.

onItemHold

A function that is executed when a collection item has been held for a specified period.

onItemRendered

A function that is executed after a collection item is rendered.

onOptionChanged

A function that is executed after a UI component property is changed.

rtlEnabled

Switches the UI component to a right-to-left representation.

showCancelButton

Specifies whether or not to display the Cancel button in action sheet.

showTitle

A Boolean value specifying whether or not the title of the action sheet is visible.

target

Specifies the element the action sheet popover points at. Applies only if usePopover is true.

title

The title of the action sheet.

usePopover

Specifies whether or not to show the action sheet within a Popover UI component.

visible

A Boolean value specifying whether or not the ActionSheet UI component is visible.

width

Specifies the UI component's width.

Methods

This section describes the members used to manipulate the UI component.

Name Description
beginUpdate()

Postpones rendering that can negatively affect performance 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 ActionSheet instance.

element()

Gets the root UI component element.

endUpdate()

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

getDataSource()

Gets the DataSource instance.

getInstance(element)

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

hide()

Hides the UI component.

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.

repaint()

Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.

resetOption(optionName)

Resets a property to its default value.

show()

Shows the UI component.

toggle(showing)

Shows or hides the UI component depending on the argument.

See Also

Events

This section describes events fired by this UI component.

Name Description
cancelClick

Raised when the Cancel button is clicked or tapped.

contentReady

Raised when the UI component is rendered and each time the component is repainted.

disposing

Raised before the UI component is disposed of.

initialized

Raised only once, after the UI component is initialized.

itemClick

Raised when a collection item is clicked or tapped.

itemContextMenu

Raised when a collection item is right-clicked or pressed.

itemHold

Raised when a collection item has been held for a specified period.

itemRendered

Raised after a collection item is rendered.

optionChanged

Raised after a UI component property is changed.

See Also

Types

Name Description
CancelClickEvent

The type of the cancelClick event handler's argument.

ContentReadyEvent

The type of the contentReady event handler's argument.

DisposingEvent

The type of the disposing event handler's argument.

InitializedEvent

The type of the initialized event handler's argument.

ItemClickEvent

The type of the itemClick event handler's argument.

ItemContextMenuEvent

The type of the itemContextMenu event handler's argument.

ItemHoldEvent

The type of the itemHold event handler's argument.

ItemRenderedEvent

The type of the itemRendered event handler's argument.

OptionChangedEvent

The type of the optionChanged event handler's argument.

SelectionChangingEvent