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
import React, { useCallback, useState } from 'react'; import ActionSheet, { ActionSheetTypes } from 'devextreme-react/action-sheet'; import Button from 'devextreme-react/button'; import Switch, { SwitchTypes } from 'devextreme-react/switch'; import notify from 'devextreme/ui/notify'; import { actionSheetItems } from './data.ts'; const App = () => { const [isActionSheetVisible, setIsActionSheetVisible] = useState(false); const [showTitle, setShowTitle] = useState(true); const [showCancelButton, setShowCancelButton] = useState(true); const showActionSheet = useCallback(() => { setIsActionSheetVisible(true); }, [setIsActionSheetVisible]); const onActionSheetButtonClick = useCallback((buttonName: string) => { setIsActionSheetVisible(false); notify(`The "${buttonName}" button is clicked.`); }, [setIsActionSheetVisible]); const onActionSheetItemClick = useCallback((e: ActionSheetTypes.ItemClickEvent) => { onActionSheetButtonClick(e.itemData.text); }, [onActionSheetButtonClick]); const onActionSheetCancelClick = useCallback(() => { onActionSheetButtonClick('Cancel'); }, [onActionSheetButtonClick]); const changeTitle = useCallback((e: SwitchTypes.ValueChangedEvent) => { setShowTitle(e.value); }, [setShowTitle]); const changeCancelButton = useCallback((e: SwitchTypes.ValueChangedEvent) => { setShowCancelButton(e.value); }, [setShowCancelButton]); return ( <div> <ActionSheet dataSource={actionSheetItems} title="Choose action" showTitle={showTitle} showCancelButton={showCancelButton} visible={isActionSheetVisible} onItemClick={onActionSheetItemClick} onCancelClick={onActionSheetCancelClick} /> <div className="button"> <Button width="100%" text="Click to show Action Sheet" onClick={showActionSheet} /> </div> <div className="options"> <div className="caption">Options</div> <div className="option"> <span>Show title</span> <Switch value={showTitle} onValueChanged={changeTitle} /> </div> <div className="option"> <span>Show cancel button</span> <Switch value={showCancelButton} onValueChanged={changeCancelButton} /> </div> </div> </div> ); }; export default App;
import React, { useCallback, useState } from 'react'; import ActionSheet from 'devextreme-react/action-sheet'; import Button from 'devextreme-react/button'; import Switch from 'devextreme-react/switch'; import notify from 'devextreme/ui/notify'; import { actionSheetItems } from './data.js'; const App = () => { const [isActionSheetVisible, setIsActionSheetVisible] = useState(false); const [showTitle, setShowTitle] = useState(true); const [showCancelButton, setShowCancelButton] = useState(true); const showActionSheet = useCallback(() => { setIsActionSheetVisible(true); }, [setIsActionSheetVisible]); const onActionSheetButtonClick = useCallback( (buttonName) => { setIsActionSheetVisible(false); notify(`The "${buttonName}" button is clicked.`); }, [setIsActionSheetVisible], ); const onActionSheetItemClick = useCallback( (e) => { onActionSheetButtonClick(e.itemData.text); }, [onActionSheetButtonClick], ); const onActionSheetCancelClick = useCallback(() => { onActionSheetButtonClick('Cancel'); }, [onActionSheetButtonClick]); const changeTitle = useCallback( (e) => { setShowTitle(e.value); }, [setShowTitle], ); const changeCancelButton = useCallback( (e) => { setShowCancelButton(e.value); }, [setShowCancelButton], ); return ( <div> <ActionSheet dataSource={actionSheetItems} title="Choose action" showTitle={showTitle} showCancelButton={showCancelButton} visible={isActionSheetVisible} onItemClick={onActionSheetItemClick} onCancelClick={onActionSheetCancelClick} /> <div className="button"> <Button width="100%" text="Click to show Action Sheet" onClick={showActionSheet} /> </div> <div className="options"> <div className="caption">Options</div> <div className="option"> <span>Show title</span> <Switch value={showTitle} onValueChanged={changeTitle} /> </div> <div className="option"> <span>Show cancel button</span> <Switch value={showCancelButton} onValueChanged={changeCancelButton} /> </div> </div> </div> ); }; export default App;
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );
export const actionSheetItems = [ { text: 'Call' }, { text: 'Send message' }, { text: 'Edit' }, { text: 'Delete' }, ];
window.exports = window.exports || {}; window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, jsx: 'react', }, meta: { 'react': { 'esModule': true, }, 'typescript': { 'exports': 'ts', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'npm:': 'https://unpkg.com/', }, defaultExtension: 'js', map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', 'react': 'npm:react@17.0.2/umd/react.development.js', 'react-dom': 'npm:react-dom@17.0.2/umd/react-dom.development.js', 'prop-types': 'npm:prop-types@15.8.1/prop-types.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@24.1.3/cjs', 'devextreme-react': 'npm:devextreme-react@24.1.3/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.7.1/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.8/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.56/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.13', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', 'devextreme-cldr-data': 'npm:devextreme-cldr-data@1.0.3', // SystemJS plugins 'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.8/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.8/parser-html.js', }, packages: { 'devextreme': { defaultExtension: 'js', }, 'devextreme-react': { main: 'index.js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/localization/messages': { format: 'json', defaultExtension: 'json', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.13/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, react: true, }, }; System.config(window.config);
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));
export const actionSheetItems = [ { text: 'Call' }, { text: 'Send message' }, { text: 'Edit' }, { text: 'Delete' }, ];
<!DOCTYPE html> <html 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" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.3/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></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; }

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.