React ActionSheet Props

An object defining configuration properties for the ActionSheet UI component.

cancelText

The text displayed in the button that closes the action sheet.

Type:

String

Default Value: 'Cancel'

dataSource

Binds the UI component to data.

Default Value: null

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

NOTE

Review the following notes about data binding:

  • Do not specify the items property if you specified the dataSource, and vice versa.

  • Data field names cannot be equal to this and should not contain the following characters: ., :, [, and ].

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.

Type:

Boolean

Default Value: false

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

Selector: ElementAttr
Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#actionSheetContainer").dxActionSheet({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-action-sheet ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-action-sheet>
import { DxActionSheetModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxActionSheetModule
    ],
    // ...
})
Vue
App.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
App.js
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.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's height.

Default Value: undefined

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.

hint

Specifies text for a hint that appears when a user pauses on the UI component.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.

Type:

Boolean

Default Value: false

itemComponent

An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

itemHoldTimeout

The time period in milliseconds before the onItemHold event is raised.

Type:

Number

Default Value: 750

itemRender

An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

items[]

An array of items displayed by the UI component.

Selector: Item
Type:

Array<String | dxActionSheetItem | any>

Raised Events: onOptionChanged

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:

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

NOTE
Do not use the items property if you use dataSource, and vice versa.

itemTemplate

Specifies a custom template for items.

Type:

template

Template Data:

Object

The item object to be rendered.

Default Name: 'item'

onCancelClick

A function that is executed when the Cancel button is clicked or tapped.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel hiding of the action sheet after the Cancel button is clicked.

component

ActionSheet

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

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.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

ActionSheet

The UI component's instance.

Default Value: null

onDisposing

A function that is executed before the UI component is disposed of.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

ActionSheet

The UI component's instance.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

ActionSheet

The UI component's instance.

Default Value: null

Angular
app.component.html
app.component.ts
<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
App.vue (Options API)
App.vue (Composition API)
<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
App.js
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
jQuery
  • Get a UI component Instance in jQuery
Angular
  • Get a UI component Instance in Angular
Vue
  • Get a UI component Instance in Vue
React
  • Get a UI component Instance in React

onItemClick

A function that is executed when a collection item is clicked or tapped.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
itemIndex

Number

The clicked item's index.

itemElement

HTMLElement | jQuery

The item's container. It is an HTML Element or a jQuery Element when you use jQuery.

itemData

Object

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

HTMLElement | jQuery

The UI component's container.

component

ActionSheet

The UI component's instance.

Default Value: null

onItemContextMenu

A function that is executed when a collection item is right-clicked or pressed.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
itemIndex

Number

The item's index.

itemElement

HTMLElement | jQuery

The item's container. It is an HTML Element or a jQuery Element when you use jQuery.

itemData

Object

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

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

ActionSheet

The UI component's instance.

Default Value: null

onItemHold

A function that is executed when a collection item has been held for a specified period.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
itemIndex

Number

The item's index.

itemElement

HTMLElement | jQuery

The item's container. It is an HTML Element or a jQuery Element when you use jQuery.

itemData

Object

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

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

ActionSheet

The UI component's instance.

Default Value: null

onItemRendered

A function that is executed after a collection item is rendered.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
itemIndex

Number

The current item's index.

itemElement

HTMLElement | jQuery

The item's container. It is an HTML Element or a jQuery Element when you use jQuery.

itemData

Object

The current item's data.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

ActionSheet

The UI component's instance.

Default Value: null

onOptionChanged

A function that is executed after a UI component property is changed.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
value any

The modified property's new value.

previousValue any

The UI component's previous value.

name

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.

fullName

String

The path to the modified property that includes all parent properties.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

ActionSheet

The UI component's instance.

Default Value: null

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

jQuery
index.js
$(function() {
    $("#actionSheetContainer").dxActionSheet({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<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
App.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
App.js
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.

Type:

Boolean

Default Value: false

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.

JavaScript
DevExpress.config({
    rtlEnabled: true
});

DataGrid Demo Navigation UI Demo Editors Demo

showCancelButton

Specifies whether or not to display the Cancel button in action sheet.

Type:

Boolean

Default Value: true

The Cancel button closes the action sheet.

NOTE
The showCancelButton property makes sense only if the usePopover property is disabled. Otherwise, the Cancel button is hidden. In this case, the popover is closed by an outside click.

showTitle

A Boolean value specifying whether or not the title of the action sheet is visible.

Type:

Boolean

Default Value: true

target

Specifies the element the action sheet popover points at. Applies only if usePopover is true.

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

title

The title of the action sheet.

Type:

String

Default Value: ''

usePopover

Specifies whether or not to show the action sheet within a Popover UI component.

Type:

Boolean

Default Value: false, true (iPad)

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

View Demo

visible

A Boolean value specifying whether or not the ActionSheet UI component is visible.

Type:

Boolean

Default Value: false
Raised Events: onOptionChanged

width

Specifies the UI component's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's width.

Default Value: undefined

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.