Vue Action Sheet - 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

<template> <div> <DxActionSheet :data-source="dataSource" v-model:visible="isActionSheetVisible" :show-title="showTitle" :show-cancel-button="showCancelButton" title="Choose action" @cancelClick="showClickNotification('Cancel')" @itemClick="showClickNotification($event.itemData.text)" /> <div class="button"> <DxButton width="100%" text="Click to show Action Sheet" @click="showActionSheet" /> </div> <div class="options"> <div class="caption">Options</div> <div class="option"> <span>Show title</span> <DxSwitch v-model:value="showTitle"/> </div> <div class="option"> <span>Show cancel button</span> <DxSwitch v-model:value="showCancelButton"/> </div> </div> </div> </template> <script setup lang="ts"> import { ref } from 'vue'; import DxActionSheet from 'devextreme-vue/action-sheet'; import DxSwitch from 'devextreme-vue/switch'; import DxButton from 'devextreme-vue/button'; import notify from 'devextreme/ui/notify'; import { actionSheetItems } from './data.ts'; const dataSource = actionSheetItems; const isActionSheetVisible = ref(false); const showTitle = ref(true); const showCancelButton = ref(true); function showActionSheet() { isActionSheetVisible.value = true; } function showClickNotification(buttonName: string) { notify(`The "${buttonName}" button is clicked.`); } </script>

export const actionSheetItems = [ { text: 'Call' }, { text: 'Send message' }, { text: 'Edit' }, { text: 'Delete' }, ];

import { createApp } from 'vue'; import App from './App.vue'; createApp(App).mount('#app');

.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; }

<!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/26.1.5/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="./bundle.css" /> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"> </div> </div> <script src="bundles/vendor/vue.vendor.js"></script> <script src="./bundle.js"></script> </body> </html>

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.