ActionSheet Default Item Template

This section lists the data source fields that are used in a default template for action sheet items.

By default, a predefined item template is applied to display items of DevExtreme collection widgets. This template is based on certain fields of the data source provided for a widget. Below is the list of the fields that take part in a default item template for the dxActionSheet widget. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source. For details refer to the Customize Widget Item Appearance topic.

clickAction

An action performed when the button representing an action sheet item is clicked.

Type: String|function(e)
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.
jQueryEvent: jQuery.Event
Returns a jQuery event that caused the action's execution.

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that the required actions are performed when clicking the widget items.

disabled

Specifies whether a widget item must be displayed disabled.

Type: Boolean
Default Value: false

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that items are displayed disabled or enabled according to the specified value.

template

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

Type: String|function|DOM Node|jQuery
Return Value: String|jQuery
A template name or a template container.

Whether you use a default or a custom template for widget items, you can specify a specific template for a particular item. To do so, set the template field for the data source object of this item. The following types of the specified value are available.

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

To learn more about item templates, refer to the Customize Widget Item Appearance topic.

text

Specifies text displayed for the widget item.

Type: String

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that the required text is displayed for the widget items.

type

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

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

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that the buttons representing widget items have a required appearance.