JavaScript/jQuery ActionSheet Options
An object defining configuration properties for the ActionSheet UI component.
See Also
cancelText
The text displayed in the button that closes the action sheet.
dataSource
Binds the UI component to data.
Array<String | dxActionSheetItem | any>
| | | | nullThe ActionSheet works with collections of string
values or objects.
Depending on your data source, bind ActionSheet to data as follows. If the data source provides objects, also specify the itemTemplate. You can skip this part if the objects contain fields described in the items section.
Data Array
Assign the array to the dataSource option.Read-Only Data in JSON Format
Set the dataSource property to the URL of a JSON file or service that returns JSON data.OData
Implement an ODataStore.Web API, PHP, MongoDB
Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.
jQuery
JavaScript$(function() { let serviceUrl = "https://url/to/my/service"; $("#actionSheetContainer").dxActionSheet({ // ... dataSource: DevExpress.data.AspNet.createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }) }) });
Angular
app.component.tsapp.component.htmlapp.module.tsimport { Component } from '@angular/core'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { store: CustomStore; constructor() { let serviceUrl = "https://url/to/my/service"; this.store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }) } }
<dx-action-sheet ... [dataSource]="store"> </dx-action-sheet>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxActionSheetModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxActionSheetModule ], providers: [], bootstrap: [AppComponent] }) export class AppModule { }
Vue
App.vue<template> <DxActionSheet ... :data-source="store" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; import { DxActionSheet } from 'devextreme-vue/action-sheet'; export default { components: { DxActionSheet }, data() { const serviceUrl = "https://url/to/my/service"; const store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }); return { store } } } </script>
React
App.jsimport React from 'react'; import 'devextreme/dist/css/dx.light.css'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; import ActionSheet from 'devextreme-react/action-sheet'; const serviceUrl = "https://url/to/my/service"; const store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }); class App extends React.Component { render() { return ( <ActionSheet ... dataSource={store} /> ); } } export default App;
Any other data source
Implement a CustomStore.
Regardless of the data source on the input, the ActionSheet always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.
Review the following notes about data binding:
Do not specify the items property if you specified the dataSource, and vice versa.
Field names cannot be equal to
this
and should not contain the following characters:.
,:
,[
, and]
.ActionSheet does not execute dataSource.sort functions. To implement custom sorting logic, implement columns[].calculateSortValue.
jQuery
- The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Get and Set Properties.
Angular
- The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.
Vue
- The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.
React
- The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Controlled Mode.
disabled
Specifies whether the UI component responds to user interaction.
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
jQuery
$(function(){ $("#actionSheetContainer").dxActionSheet({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-action-sheet ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-action-sheet>
import { DxActionSheetModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxActionSheetModule ], // ... })
Vue
<template> <DxActionSheet ... :element-attr="actionSheetAttributes"> </DxActionSheet> </template> <script> import DxActionSheet from 'devextreme-vue/action-sheet'; export default { components: { DxActionSheet }, data() { return { actionSheetAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React from 'react'; import ActionSheet from 'devextreme-react/action-sheet'; class App extends React.Component { actionSheetAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <ActionSheet ... elementAttr={this.actionSheetAttributes}> </ActionSheet> ); } } export default App;
height
Specifies the UI component's height.
This property accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"20vh"
,"80%"
,"inherit"
.
hint
Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled
Specifies whether the UI component changes its state when a user pauses on it.
itemHoldTimeout
The time period in milliseconds before the onItemHold event is raised.
items[]
An array of items displayed by the UI component.
Array<String | dxActionSheetItem | any>
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 UI component items, reassign the entire items array as shown in the following example:
actionSheetInstance.option('items', newItems);
As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores provide an API that allows you to update individual items without reassigning the entire item collection.
onCancelClick
A function that is executed when the Cancel button is clicked or tapped.
Information about the event.
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel hiding of the action sheet after the Cancel button is clicked. |
|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
Set the cancel field of the function's parameter to true to cancel the hiding of the action sheet after the Cancel button is clicked.
onContentReady
A function that is executed when the UI component is rendered and each time the component is repainted.
Information about the event.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onDisposing
A function that is executed before the UI component is disposed of.
Information about the event.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onInitialized
A function used in JavaScript frameworks to save the UI component instance.
Information about the event.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
Angular
<dx-action-sheet ... (onInitialized)="saveInstance($event)"> </dx-action-sheet>
import { Component } from "@angular/core"; import ActionSheet from "devextreme/ui/data_grid"; // ... export class AppComponent { actionSheetInstance: ActionSheet; saveInstance (e) { this.actionSheetInstance = e.component; } }
Vue
<template> <div> <DxActionSheet ... @initialized="saveInstance"> </DxActionSheet> </div> </template> <script> import DxActionSheet from 'devextreme-vue/action-sheet'; export default { components: { DxActionSheet }, data: function() { return { actionSheetInstance: null }; }, methods: { saveInstance: function(e) { this.actionSheetInstance = e.component; } } }; </script>
<template> <div> <DxActionSheet ... @initialized="saveInstance"> </DxActionSheet> </div> </template> <script setup> import DxActionSheet from 'devextreme-vue/action-sheet'; let actionSheetInstance = null; const saveInstance = (e) => { actionSheetInstance = e.component; } </script>
React
import ActionSheet from 'devextreme-react/action-sheet'; class App extends React.Component { constructor(props) { super(props); this.saveInstance = this.saveInstance.bind(this); } saveInstance(e) { this.actionSheetInstance = e.component; } render() { return ( <div> <ActionSheet onInitialized={this.saveInstance} /> </div> ); } }
See Also
onItemClick
A function that is executed when a collection item is clicked or tapped.
Information about the event.
Name | Type | Description |
---|---|---|
itemIndex |
The clicked item's index. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The clicked item's data. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. |
|
component |
The UI component's instance. |
onItemContextMenu
A function that is executed when a collection item is right-clicked or pressed.
Information about the event.
Name | Type | Description |
---|---|---|
itemIndex |
The item's index. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The item's data. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onItemHold
A function that is executed when a collection item has been held for a specified period.
Information about the event.
Name | Type | Description |
---|---|---|
itemIndex |
The item's index. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The data of the item being held. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onItemRendered
A function that is executed after a collection item is rendered.
Information about the event.
Name | Type | Description |
---|---|---|
itemIndex |
The current item's index. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The current item's data. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onOptionChanged
A function that is executed after a UI component property is changed.
Information about the event.
Name | Type | Description |
---|---|---|
value | any |
The modified property's new value. |
previousValue | any |
The UI component's previous value. |
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#actionSheetContainer").dxActionSheet({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<dx-action-sheet ... (onOptionChanged)="handlePropertyChange($event)"> </dx-action-sheet>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... handlePropertyChange(e) { if(e.name === "changedProperty") { // handle the property change here } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxActionSheetModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxActionSheetModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxActionSheet ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxActionSheet from 'devextreme-vue/action-sheet'; export default { components: { DxActionSheet }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import ActionSheet from 'devextreme-react/action-sheet'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <ActionSheet ... onOptionChanged={handlePropertyChange} /> ); }
rtlEnabled
Switches the UI component to a right-to-left representation.
When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
DevExpress.config({ rtlEnabled: true });
showCancelButton
Specifies whether or not to display the Cancel button in action sheet.
The Cancel button closes the 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. Applies only if usePopover is true.
This property accepts one of the following values:
jQuery
-
index.js
$(function(){ $("#actionSheetContainer").dxActionSheet({ // ... target: '#targetElement' }); });
A jQuery wrapper
index.js$(function(){ $("#actionSheetContainer").dxActionSheet({ // ... target: $('#targetElement') }); });
A DOM element
index.js$(function(){ $("#actionSheetContainer").dxActionSheet({ // ... target: document.getElementById('#targetElement') }); });
Angular
-
app.component.html
<dx-action-sheet ... target="#targetElement" > </dx-action-sheet>
NOTEThe component supports only valid CSS identifiers. To target elements with invalid identifiers, specify an attribute selector instead.
app.component.html<dx-action-sheet ... target="#111" // An invalid CSS identifier > </dx-action-sheet> <dx-action-sheet ... target="[id='#111']" // An attribute selector > </dx-action-sheet>
A DOM element
app.component.htmlapp.component.ts<dx-action-sheet ... [target]="targetElement" > </dx-action-sheet>
// ... export class AppComponent { targetElement: Element; constructor() { this.targetElement = document.getElementById('#targetElement') as Element; } }
Vue
-
App.vue
<template> <DxActionSheet ... target="#targetElement" > </DxActionSheet> </template> <script setup lang="ts"> import { DxActionSheet } from 'devextreme-vue/action-sheet'; </script>
NOTEThe component supports only valid CSS identifiers. To target elements with invalid identifiers, specify an attribute selector instead.
App.vue<template> <DxActionSheet ... target="#111" // An invalid CSS identifier > </DxActionSheet> <DxActionSheet ... target="[id='#111']" // An attribute selector > </DxActionSheet> </template>
A DOM element
App.vue<template> <DxActionSheet ... :target="targetElement" > </DxActionSheet> </template> <script> import { DxActionSheet } from 'devextreme-vue/action-sheet'; export default { components: { DxActionSheet }, data() { return { targetElement: null } }, mounted() { this.targetElement = document.getElementById('targetElement'); } }; </script>
React
-
App.js
import ActionSheet from 'devextreme-react/action-sheet'; // ... function App() { return ( <ActionSheet ... target="#targetElement" > </ActionSheet> ); }
NOTEThe component supports only valid CSS identifiers. To target elements with invalid identifiers, specify an attribute selector instead.
App.jsimport ActionSheet from 'devextreme-react/action-sheet'; // ... function App() { return ( <ActionSheet ... target="#111" // An invalid CSS identifier > </ActionSheet> <ActionSheet ... target="[id='#111']" // An attribute selector > </ActionSheet> ); }
A DOM element
App.jsimport React, { useEffect, useState } from 'react'; import ActionSheet from 'devextreme-react/action-sheet'; // ... function App() { const [targetElement, setTargetElement] = useState(null); useEffect(() => { setTargetElement(document.getElementById('targetElement')); }, []); return ( <ActionSheet ... target={targetElement} > </ActionSheet> ); }
jQuery
Target type affects the initialization of the component's events:
undefined
Events are initialized on the document.- Selector
Events are initialized on the document with the passed selector. - jQuery wrapper or DOM element
Events are initialized on the passed element.
This changes event propagation and the behavior of methods like stopPropagation().
Angular
Target type affects the initialization of the component's events:
undefined
Events are initialized on the document.- Selector
Events are initialized on the document with the passed selector. - DOM element
Events are initialized on the passed element.
This changes event propagation and the behavior of methods like stopPropagation().
Vue
Target type affects the initialization of the component's events:
undefined
Events are initialized on the document.- Selector
Events are initialized on the document with the passed selector. - DOM element
Events are initialized on the passed element.
This changes event propagation and the behavior of methods like stopPropagation().
React
Target type affects the initialization of the component's events:
undefined
Events are initialized on the document.- Selector
Events are initialized on the document with the passed selector. - DOM element
Events are initialized on the passed element.
This changes event propagation and the behavior of methods like stopPropagation().
usePopover
Specifies whether or not to show the action sheet within a Popover UI component.
width
Specifies the UI component's width.
This property accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"20vw"
,"80%"
,"auto"
,"inherit"
.