devextreme/ui/collection/ui.collection_widget.base.d.ts

HTML5 JavaScript Component Suite for Responsive Web Development

/**
* DevExtreme (ui/collection/ui.collection_widget.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 '../../jquery_augmentation';

import {
    dxElement
} from '../../core/element';

import {
    template
} from '../../core/templates/template';

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

import {
    event
} from '../../events/index';

import Widget, {
    WidgetOptions
} from '../widget/ui.widget';

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface CollectionWidgetOptions<T = CollectionWidget> extends WidgetOptions<T> {
    /** Binds the widget to data. */
    dataSource?: string | Array<string | CollectionWidgetItem> | DataSource | DataSourceOptions;
    /** The time period in milliseconds before the onItemHold event is raised. */
    itemHoldTimeout?: number;
    /** Specifies a custom template for items. */
    itemTemplate?: template | ((itemData: any, itemIndex: number, itemElement: dxElement) => string | Element | JQuery);
    /** An array of items displayed by the widget. */
    items?: Array<string | CollectionWidgetItem | any>;
    /** Specifies the key property that provides key values to access data items. Each key value must be unique. */
    keyExpr?: string | Function;
    /** The text or HTML markup displayed by the widget if the item collection is empty. */
    noDataText?: string;
    /** A function that is executed when a collection item is clicked or tapped. */
    onItemClick?: ((e: { component?: T, element?: dxElement, model?: any, itemData?: any, itemElement?: dxElement, itemIndex?: number, jQueryEvent?: JQueryEventObject, event?: event }) => any) | string;
    /** A function that is executed when a collection item is right-clicked or pressed. */
    onItemContextMenu?: ((e: { component?: T, element?: dxElement, model?: any, itemData?: any, itemElement?: dxElement, itemIndex?: number, jQueryEvent?: JQueryEventObject, event?: event }) => any);
    /** A function that is executed when a collection item has been held for a specified period. */
    onItemHold?: ((e: { component?: T, element?: dxElement, model?: any, itemData?: any, itemElement?: dxElement, itemIndex?: number, event?: event }) => any);
    /** A function that is executed after a collection item is rendered. */
    onItemRendered?: ((e: { component?: T, element?: dxElement, model?: any, itemData?: any, itemElement?: dxElement, itemIndex?: number }) => any);
    /** A function that is executed when a collection item is selected or selection is canceled. */
    onSelectionChanged?: ((e: { component?: T, element?: dxElement, model?: any, addedItems?: Array<any>, removedItems?: Array<any> }) => any);
    /** The index of the currently selected widget item. */
    selectedIndex?: number;
    /** The selected item object. */
    selectedItem?: any;
    /** Specifies an array of currently selected item keys. */
    selectedItemKeys?: Array<any>;
    /** An array of currently selected item objects. */
    selectedItems?: Array<any>;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
/** The base class for widgets containing an item collection. */
export default class CollectionWidget extends Widget {
    constructor(element: Element, options?: CollectionWidgetOptions)
    constructor(element: JQuery, options?: CollectionWidgetOptions)
    getDataSource(): DataSource;
}

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface CollectionWidgetItem {
    /** Specifies whether the widget item responds to user interaction. */
    disabled?: boolean;
    /** Specifies html code inserted into the widget item element. */
    html?: string;
    /** Specifies a template that should be used to render this item only. */
    template?: template | (() => string | Element | JQuery);
    /** Specifies text displayed for the widget item. */
    text?: string;
    /** Specifies whether or not a widget item must be displayed. */
    visible?: boolean;
}