DevExtreme v24.1 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

Basics

The ActionSheet component is a pop-up sheet that contains a set of buttons. These buttons allow users to perform custom actions related to a single task (call, send a message, delete, or edit a selected contact). This demo shows how to create a simple ActionSheet and handle button clicks.

DevExtreme Accessibility Compliance
DevExtreme component libraries meet a variety of WCAG and Section 508 compliance standards. To assess this demo’s accessibility level, click the Run AXE® Validation button to launch the AXE® web accessibility evaluation tool.
All trademarks or registered trademarks are property of their respective owners. AXE® Terms of Use
The overall accessibility level of your application depends on the ActionSheet features used.
Backend API
$(() => { const actionSheet = $('#action-sheet').dxActionSheet({ dataSource: actionSheetItems, title: 'Choose action', onCancelClick() { showNotify('Cancel'); }, onItemClick(value) { showNotify(value.itemData.text); }, }).dxActionSheet('instance'); function showNotify(value) { DevExpress.ui.notify(`The "${value}" button is clicked.`); } $('#button').dxButton({ text: 'Click to show Action Sheet', onClick() { actionSheet.option('visible', true); }, }); $('#show-title').dxSwitch({ value: actionSheet.option('showTitle'), onValueChanged(e) { actionSheet.option('showTitle', e.value); }, }); $('#show-cancelbutton').dxSwitch({ value: actionSheet.option('showCancelButton'), onValueChanged(e) { actionSheet.option('showCancelButton', e.value); }, }); });
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script> <script>window.jQuery || document.write(decodeURIComponent('%3Cscript src="js/jquery.min.js"%3E%3C/script%3E'))</script> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.3/css/dx.light.css" /> <script src="js/dx.all.js"></script> <script src="data.js"></script> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="index.js"></script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="action-sheet"></div> <div id="button" class="button"></div> <div class="options"> <div class="caption">Options</div> <div class="option"> <span>Show title</span> <div id="show-title"></div> </div> <div class="option"> <span>Show cancel button</span> <div id="show-cancelbutton"></div> </div> </div> </div> </body> </html>
.button { width: 280px; display: flex; margin: 20px auto; } .options { padding: 20px; background-color: rgba(191, 191, 191, 0.15); left: 0; position: absolute; bottom: 0; right: 0; } .caption { font-size: 18px; font-weight: 500; } .option { margin-top: 10px; line-height: 28px; text-align: right; display: inline-block; width: 100%; } .option > span { float: left; }
const actionSheetItems = [ { text: 'Call' }, { text: 'Send message' }, { text: 'Edit' }, { text: 'Delete' }, ];

Specify Buttons and Title

ActionSheet can contain multiple buttons. To specify and configure them, use one of these properties:

  • items[]
    Accepts a local data array.

  • dataSource
    Accepts a local data array or a DataSource object. This object works with local and remote arrays and allows you to shape data.

For each button, you can specify a text, type, icon, template, and other properties. In this demo, the ActionSheet buttons are configured in a local array assigned to the dataSource property. Each button includes the text property only.

If you want to display a title, assign the text to the title property.

Handle Button Clicks

You can assign a function to the onItemClick property to handle button clicks. Use the e.itemData field within the function to determine which button was clicked. You can also use the onCancelClick property handle a click on the built-in Cancel button. In this demo, the ActionSheet component displays a notification with the button's name when you click a button.