devextreme/ui/context_menu/ui.menu_base.d.ts

HTML5 JavaScript Component Suite for Responsive Web Development

/**
* DevExtreme (ui/context_menu/ui.menu_base.d.ts)
* Version: 20.1.7
* Build date: Tue Aug 25 2020
*
* Copyright (c) 2012 - 2020 Developer Express Inc. ALL RIGHTS RESERVED
* Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
*/
import {
    animationConfig
} from '../../animation/fx';

import DataSource, {
    DataSourceOptions
} from '../../data/data_source';

import HierarchicalCollectionWidget, {
    HierarchicalCollectionWidgetOptions
} from '../hierarchical_collection/ui.hierarchical_collection_widget';

import {
    dxMenuBaseItem
} from '../menu';

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxMenuBaseOptions<T = dxMenuBase> extends HierarchicalCollectionWidgetOptions<T> {
    /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */
    activeStateEnabled?: boolean;
    /** Configures widget visibility animations. This object contains two fields: show and hide. */
    animation?: { hide?: animationConfig, show?: animationConfig };
    /** Specifies the name of the CSS class to be applied to the root menu level and all submenus. */
    cssClass?: string;
    /** Binds the widget to data. */
    dataSource?: string | Array<dxMenuBaseItem> | DataSource | DataSourceOptions;
    /** Holds an array of menu items. */
    items?: Array<dxMenuBaseItem>;
    /** Specifies whether or not an item becomes selected if a user clicks it. */
    selectByClick?: boolean;
    /** Specifies the selection mode supported by the menu. */
    selectionMode?: 'none' | 'single';
    /** Specifies options of submenu showing and hiding. */
    showSubmenuMode?: { delay?: { hide?: number, show?: number } | number, name?: 'onClick' | 'onHover' } | 'onClick' | 'onHover';
}
/** Warning! This type is used for internal purposes. Do not import it directly. */

export default class dxMenuBase extends HierarchicalCollectionWidget {
    constructor(element: Element, options?: dxMenuBaseOptions)
    constructor(element: JQuery, options?: dxMenuBaseOptions)
    /** Selects an item found using its DOM node. */
    selectItem(itemElement: Element): void;
    /** Cancels the selection of an item found using its DOM node. */
    unselectItem(itemElement: Element): void;
}