Angular ActionSheet - items

An array of items displayed by the UI component.

Selector: dxi-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.

disabled

Specifies whether the UI component item responds to user interaction.

Type:

Boolean

Default Value: false

icon

Specifies the icon to be displayed on the action sheet button.

Type:

String

This property accepts one of the following:

onClick

A handler for the click event raised for the button representing the given action sheet button.

Type:

Function

Function parameters:
e:

NativeEventInfo

Information about the event.

Object structure:
Name Type Description
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.
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.
Default Value: null

Assign a function to perform a custom action when a button representing an action sheet item is clicked.

To navigate to a specific URL when the click event fires for action sheet buttons, assign that URL directly to this property.

stylingMode

Specifies which style to apply to the button that is an action sheet item.

Type:

ButtonStyle

Default Value: 'outlined'

The following styles are available:

ActionSheet Item Styling Modes

See Also

template

Specifies a template that should be used to render this item only.

Type:

template

Template Data:

CollectionWidgetItem

The item object to be rendered.

jQuery

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a jQuery object of the template's container.
  • Assign a DOM Node of the template's container.
  • Assign a function that returns the jQuery object or a DOM Node of the template's container.

The following example adds a custom item to the component.

index.js
$(function() {
    $("#actionSheetContainer").dxActionSheet({
        // ...
        items: [
            {
                // ...
                template: '<div>Custom Item</div>'
            }
        ]
    });
});
Angular

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a DOM Node of the template's container.

The following example adds a custom item to the component. Note that Angular uses custom templates instead of the template property.

app.component.html
app.component.ts
app.module.ts
<dx-action-sheet ... >
    <dxi-item ... >
        <div *dxTemplate>
            <div>Custom Item</div>
        </div>
    </dxi-item>
</dx-action-sheet>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}
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

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a DOM Node of the template's container.

The following example adds a custom item to the component. Note that Vue uses custom templates instead of the template property.

App.vue
<template>
    <DxActionSheet ... >
        <dxItem ... >
            <div>Custom Item</div>
        </dxItem>
    </DxActionSheet>
</template>

<script>

import DxActionSheet, {
    DxItem
} from 'devextreme-vue/action-sheet';

export default {
    components: {
        DxActionSheet,
        DxItem
    },
    // ...
}
</script>
React

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a DOM Node of the template's container.

The following example adds a custom item to the component. In React, specify the render or component properties.

App.js
import React from 'react';

import ActionSheet, {
    Item
} from 'devextreme-react/action-sheet';

const renderCustomItem = () => {
    return <div>Custom Item</div>;
}

const App() = () => {
    return (
        <ActionSheet ... >
            <Item ...
                render={renderCustomItem}
            >
            </Item>
        </ActionSheet>
    );
}
export default App;
See Also

text

Specifies text displayed for the UI component item.

Type:

String

If you use both this property and a template, the template overrides the text.

type

Specifies the type of the button that is an action sheet item.

Type:

ButtonType

Default Value: 'normal'

See Also