Configuration

An object defining configuration options for the dxActionSheet widget.

cancelClickAction

Deprecated

Use the onCancelClick option instead.

cancelText

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

Type: String
Default Value: "Cancel"

Show Example:
AngularJS
Knockout
jQuery

contentReadyAction

Deprecated

Use the onContentReady option instead.

dataSource

A data source used to fetch data to be displayed by the widget.

Default Value: null

You can assign an array directly to this option as well as use the Data Source provided by the DevExtreme library.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API. Alternatively, you can implement a custom item template.

See Also
Show Example:
AngularJS
Knockout
jQuery

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

Type: Boolean
Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

Show Example:
AngularJS
Knockout
jQuery

focusStateEnabled

Specifies whether or not the widget can be focused.

Type: Boolean
Default Value: false

height

Specifies the height of the widget.

Return Value: Number|String

The widget height.

Default Value: undefined

The option can hold a value of the following types.

  • number
    The height of the widget in pixels

  • string
    A CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit")

  • function
    A function returning the widget height (e.g., height:function(){ return baseHeight - 10 + "%"; })

hint

Specifies the text of the hint displayed for the widget.

Type: String
Default Value: undefined

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

Type: Boolean
Default Value: false

itemClickAction

Deprecated

Use the onItemClick option instead.

itemHoldAction

Deprecated

Use the onItemHold option instead.

itemHoldTimeout

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

Type: Number
Default Value: 750

itemRender

Deprecated

Use the itemTemplate option instead.

itemRenderedAction

Deprecated

Use the onItemRendered option instead.

items

An array of items displayed by the widget.

Type: Array

You can use the dataSource option instead. Unlike the items option, the dataSource option can take on the DataSource configuration object as well as a simple array.

itemSelectAction

Deprecated

Use the onSelectionChanged option instead.

A function performed when a widget item is selected.

Type: function
Function parameters:

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.

itemData: Object

The data that is bound to the selected item.

itemElement: jQuery

An HTML element representing the item.

itemIndex: Number

Specifies the index of the just selected item.

Default Value: null

Assign a function to perform a custom action when a widget item is selected.

Alternatively, you can assign a URL to which the browser will navigate when a widget item is selected.

itemTemplate

The template to be used for rendering items.

Function parameters:
itemData: Object

The item object to be rendered.

itemIndex: Number

The index of the item to be rendered.

itemElement: jQuery

An HTML element of the item to be rendered.

Return Value: String|DOM Node|jQuery

A template name or a template container.

Default Value: "item"
See Also

NOTE: A binding context of an item template is the data source object that corresponds to the currently rendered item. So, you can bind template elements to the item object's fields directly (see the code above). To access another binding context within an item template, use Knockout/Angular binding variables.

Show Example:
AngularJS
Knockout
jQuery

onCancelClick

A handler for the cancelClick event.

Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

Indicates whether or not to cancel hiding the action sheet menu when clicking the Cancel button.

model: Object

Provides access to the data that is available for binding against the element.

cancel: Boolean

Specifies whether or not to cancel hiding the action sheet.

Default Value: null

Assign a function to perform a custom action when clicking the Cancel button. Use the cancel field of the object passed as a function parameter. Set this field to true to prohibit the hiding of the action sheet menu when an end user clicks the Cancel button on it.

To navigate to a specific URL when the cancelClick event fires, assign that URL or the anchor part (#) of that URL directly to this option as a string.

Show Example:
AngularJS
Knockout
jQuery

onContentReady

A handler for the contentReady event.

Type: function
Function parameters:

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.

Default Value: null

Assign a function to perform a custom action when widget content is ready.

onDisposing

A handler for the disposing event.

Type: function
Function parameters:

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.

Default Value: null

Assign a function to perform a custom action when you dispose of this component.

onItemClick

A handler for the itemClick event.

Function parameters:

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.

itemData: Object

The data that is bound to the clicked item.

itemElement: jQuery

An HTML element of the item.

itemIndex: Number

Specifies the index of the clicked item.

Default Value: null

Assign a function to perform a custom action when a widget item is clicked.

To navigate to a specific URL when the itemClick event fires, assign that URL or the anchor part (#) of that URL directly to this option as a string.

Show Example:
AngularJS
Knockout
jQuery

onItemContextMenu

A handler for the itemContextMenu event.

Type: function
Function parameters:

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.

itemData: Object

The data that is bound to the item.

itemElement: jQuery

An HTML element of the item.

itemIndex: Number

Specifies the index of the item.

Default Value: null

Assign a function to perform a custom action when the right mouse button is clicked when the pointer is over a widget item, or when the "sustained" (also known as a long press) touch action is performed.

onItemHold

A handler for the itemHold event.

Type: function
Function parameters:

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.

itemData: Object

The data that is bound to the item being held.

itemElement: jQuery

An HTML element of the item.

itemIndex: Number

Specifies the index of the item being held.

Default Value: null

Assign a function to perform a custom action when the widget's collection item is being held for a specified time period (see the itemHoldTimeout option).

onItemRendered

A handler for the itemRendered event.

Type: function
Function parameters:

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.

itemData: Object

The data that is bound to the item to be rendered.

itemElement: jQuery

An HTML element of the item.

itemIndex: Number

Specifies the index of the rendered item.

Default Value: null

Assign a function to perform a custom action after a collection item is rendered.

onOptionChanged

A handler for the optionChanged event.

Type: function
Function parameters:

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.

value: any

Specifies a new value for the option.

Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

Type: Boolean
Default Value: false

If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.

showCancelButton

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

Type: Boolean
Default Value: true

The Cancel button closes the action sheet.

NOTE
The showCancelButton option makes sense only if the usePopover option is disabled. Otherwise, the Cancel button is hidden. In this case, the popover is closed by an outside click.
Show Example:
AngularJS
Knockout
jQuery

showTitle

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

Type: Boolean
Default Value: true

Show Example:
AngularJS
Knockout
jQuery

tabIndex

Specifies the widget tab index.

Type: Number
Default Value: 0

target

Specifies the element the action sheet popover points at.

This options should be utilizes only if the usePopover option is set to true.

Show Example:
AngularJS
Knockout
jQuery

title

The title of the action sheet.

Type: String
Default Value: ""

usePopover

Specifies whether or not to show the action sheet within a dxPopover widget.

Type: Boolean
Default Value: false

To display the action sheet as a popover specify an element the popover points at via the target option.

Show Example:
AngularJS
Knockout
jQuery

visible

A Boolean value specifying whether or not the dxActionSheet widget is visible.

Type: Boolean
Default Value: false

width

Specifies the width of the widget.

Return Value: Number|String

The widget width.

Default Value: undefined

The option can hold a value of the following types.

  • numeric
    The widget width in pixels.
  • string
    A CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit").
  • function
    The function returning the widget width. For example, see the following code.

    JavaScript
    width: function () { 
        return baseWidth - 10 + "%";
    }