JavaScript/jQuery ActionSheet - items

An array of items displayed by the widget.

Type:

Array<String | dxActionSheetItem | Object>

Raised Events: onOptionChanged

The items array can contain:

  • Strings
  • Objects with fields described in this section
  • Objects with any other fields. In this case, specify the itemTemplate.

If you need to update the widget items, reassign the entire items array as shown in the following example:

JavaScript
actionSheetInstance.option('items', newItems);

As an alternative to items, you can use the dataSource option. It accepts the DataSource object, whose underlying stores provide an API that allows you to update individual items without reassigning the entire item collection.

NOTE
Do not use the items option if you use dataSource, and vice versa.

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 item responds to user interaction.

Type:

Boolean

Default Value: false

icon

Specifies the icon to be displayed on the action sheet button.

Type:

String

This option accepts one of the following:

onClick

A handler for the click event raised for the button representing the given action sheet button.

Type:

Function

|

String

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

ActionSheet

The widget's instance.
element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.
model

Object

Model data. Available only if Knockout is used.
Default Value: null

Assign a function to perform a custom action when a button representing an action sheet item is clicked.

To navigate to a specific URL when the click event fires for action sheet buttons, assign that URL directly to this option.

render

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

template

Specifies a template that should be used to render this item only.

Type:

template

Template Data: undefined

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a jQuery object of the template's container.
  • Assign a DOM Node of the template's container.
  • Assign a function that returns the jQuery object or a DOM Node of the template's container.
See Also

text

Specifies text displayed for the widget item.

Type:

String

type

Specifies the type of the button that represents an action sheet item.

Type:

String

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

Use the ButtonType enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Normal, Default, Back, Danger, and Success.