ActionSheet

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

Included in: dx.mobile.js, dx.all.js
Module: ui/action_sheet
ActionSheet interactive configuration
Copy Code
Copy to Codepen
$("#actionsheet").dxActionSheet({
});

                    

You can create a widget using one of the following approaches.

  • jQuery
    Use the dxActionSheet jQuery plug-in.

    HTML
    <div id="actionSheet"></div>
    JavaScript
    $("#actionSheet").dxActionSheet({
        dataSource: actionSheetData,
        visible: true
    });
  • Knockout
    Add a div element and apply the dxActionSheet binding to this element.

    HTML
    <div data-bind="dxActionSheet: {
        dataSource: actionSheetData,
        visible: true
    }"></div>
  • AngularJS
    Add a div element and apply the dx-action-sheet directive to this element.

    HTML
    <div dx-action-sheet="{
        dataSource: actionSheetData,
        visible: true
    }"></div>

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the Installation article.

Since the ActionSheet widget is used to display multiple items, it supports common Collection Container widget functionality. You can find the detailed information on principles of working with the widget in the dxActionSheet section of the Collection Container Widgets article.

View Demo

Configuration

An object defining configuration options for the ActionSheet widget.

Name Description
cancelText

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

dataSource

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

disabled

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

height

Specifies the height of the widget.

hint

Specifies the text of the hint displayed for the widget.

hoverStateEnabled

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

itemHoldTimeout

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

items

An array of items displayed by the widget.

itemTemplate

The template to be used for rendering items.

onCancelClick

A handler for the cancelClick event.

onContentReady

A handler for the contentReady event.

onDisposing

A handler for the disposing event.

onInitialized

A handler for the initialized event.

onItemClick

A handler for the itemClick event.

onItemContextMenu

A handler for the itemContextMenu event.

onItemHold

A handler for the itemHold event.

onItemRendered

A handler for the itemRendered event.

onOptionChanged

A handler for the optionChanged event.

rtlEnabled

Specifies whether or not the current component supports 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.

title

The title of the action sheet.

usePopover

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

visible

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

width

Specifies the width of the widget.

Methods

This section describes the members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the component from refreshing until the endUpdate() method is called.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate() method call.

hide()

Hides the widget.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

repaint()

Redraws the widget.

show()

Shows the widget.

toggle(showing)

Shows or hides the widget depending on the Boolean value passed as the parameter.

Events

This section describes events fired by this widget.

Name Description
cancelClick

Fires when the Cancel button is clicked.

contentReady

Fires when widget content is ready.

disposing

Fires when the widget is being removed.

initialized

Fires when the widget is initialized.

itemClick

Fires when a widget item is clicked.

itemContextMenu

Fires 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.

itemHold

Fires when the widget's collection item is being held for the time period specified by the itemHoldTimeout option.

itemRendered

Fires after a collection item is rendered.

optionChanged

Fires after an option of the component is changed.

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 the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is a list of these fields. 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.

See Also