Configuration

An object defining configuration options for the dxActionSheet widget.

cancelText

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

Type: String
Default Value: "Cancel"

Show Example:
jQuery

clickAction

An action performed when the widget is clicked.

Type: Action
Default Value: null

Show Example:
jQuery

dataSource

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

Type: Object
Default Value: null

The default template of a data source item object may contain the following fields.

  • html - specifies html code inserted into the item element
  • text - specifies text inserted into the item element
  • disabled - a Boolean value specifying whether the item is disabled or enabled
  • clickAction - an action performed when the item is clicked

Refer to the Data-Bound Application tutorial for more information.

Show Example:
jQuery

disabled

A Boolean value specifying whether or not a component 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 component at runtime.

Show Example:
jQuery

height

Specifies the height of the widget.

Type: Number|String|function
Default Value: undefined

The option can hold a value of the following types:

  • numeric - 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 + "%"; }).

itemClickAction

An action performed when a collection item is clicked.

Type: Action
Default Value: null

An object passed to the action function assigned to this option can have the following fields besides the basic field set.

  • itemData - contains an object representing the clicked item
  • itemElement - contains an html element representing the clicked item
Show Example:
jQuery

itemRender

A function used to render collection items.

Type: function
Default Value: null

The rendering function should have the following parameters, and return an HTML string, element, or jQuery object representing the rendered item.

  • itemData - an object representing the rendered item
  • itemIndex - an index of the rendered item
  • itemElement - a container element containing the rendered item

The following is an example of a function used to render an item.

itemRenderedAction

An action performed after a collection item is rendered.

Type: Action
Default Value: null

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.

itemTemplate

The name of the template used to render widget items, or the function returning the template name.

Type: String|function
Default Value: "item"

noDataText

The text displayed by the widget when the item collection is empty.

Type: String
Default Value: ""

showTitle

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

Type: Boolean
Default Value: ""

title

The title of the action sheet.

Type: String
Default Value: ""

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.

Type: Number|String|function
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 (e.g., width:function(){ return baseWidth - 10 + "%"; }).