jQuery ActionSheet Options

See Also

The ActionSheet works with collections of string values or objects.

Depending on your data source, bind the 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:

  • DevExtreme.AspNet.Data
  • DevExtreme-PHP-Data
  • devextreme-query-mongodb

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

  app.component.html

  app.module.ts

  import { 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.js

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

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

• Function (deprecated since v21.2)
  Refer to the W0017 warning description for information on how you can migrate to viewport units.

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.

See Also

• Customize Item Appearance
• Custom Templates

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.

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

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

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

The following example shows how to subscribe to component property changes:

$(function() {
    $("#actionSheetContainer").dxActionSheet({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<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 { }  

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

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}
        />        
    ); 
} 

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

DataGrid Demo Navigation UI Demo Editors Demo

The Cancel button closes the action sheet.

This property accepts one of the following values:

• A CSS selector, or a jQuery selector if you use jQuery

  jQuery

  index.js

  $(function(){
      $("#actionSheetContainer").dxActionSheet({
          // ...
          target: '#targetElement'
      });
  });

  Angular

  app.component.html

  <dx-action-sheet ... 
      target="#targetElement"
  >
  </dx-action-sheet>

  Vue

  App.vue

  <template>
      <DxActionSheet ... 
          target="#targetElement"
      >
      </DxActionSheet>
  </template>
  <script>
  import { DxActionSheet } from 'devextreme-vue/action-sheet';
  
  export default {
      components: {
          DxActionSheet
      }
  };
  </script>

  React

  App.js

  import ActionSheet from 'devextreme-react/action-sheet';
  // ...
  function App() {
      return (
          <ActionSheet ... 
              target="#targetElement"
          >
          </ActionSheet>
      );
  }

• A jQuery wrapper

  jQuery

  index.js

  $(function(){
      $("#actionSheetContainer").dxActionSheet({
          // ...
          target: $('#targetElement')
      });
  });

• A DOM element

  jQuery

  index.js

  $(function(){
      $("#actionSheetContainer").dxActionSheet({
          // ...
          target: document.getElementById('#targetElement')
      });
  });

  Angular

  app.component.html

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

To display the action sheet as a popover specify an element the popover points at via the target property.

View Demo

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

• Function (deprecated since v21.2)
  Refer to the W0017 warning description for information on how you can migrate to viewport units.