devextreme/ui/tabs.d.ts

HTML5 JavaScript Component Suite for Responsive Web Development

/**
* DevExtreme (ui/tabs.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 DataSource, {
    DataSourceOptions
} from '../data/data_source';

import CollectionWidget, {
    CollectionWidgetItem,
    CollectionWidgetOptions
} from './collection/ui.collection_widget.base';

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxTabsOptions<T = dxTabs> extends CollectionWidgetOptions<T> {
    /** Binds the widget to data. */
    dataSource?: string | Array<string | dxTabsItem | any> | DataSource | DataSourceOptions;
    /** Specifies whether the widget can be focused using keyboard navigation. */
    focusStateEnabled?: boolean;
    /** Specifies whether the widget changes its state when a user pauses on it. */
    hoverStateEnabled?: boolean;
    /** An array of items displayed by the widget. */
    items?: Array<string | dxTabsItem | any>;
    /** Specifies whether to repaint only those elements whose data changed. */
    repaintChangesOnly?: boolean;
    /** Specifies whether or not an end-user can scroll tabs by swiping. */
    scrollByContent?: boolean;
    /** Specifies whether or not an end-user can scroll tabs. */
    scrollingEnabled?: boolean;
    /** An array of currently selected item objects. */
    selectedItems?: Array<string | number | any>;
    /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */
    selectionMode?: 'multiple' | 'single';
    /** Specifies whether navigation buttons should be available when tabs exceed the widget's width. */
    showNavButtons?: boolean;
}
/** The Tabs is a tab strip used to switch between pages or views. This widget is included in the TabPanel widget, but you can use the Tabs separately as well. */
export default class dxTabs extends CollectionWidget {
    constructor(element: Element, options?: dxTabsOptions)
    constructor(element: JQuery, options?: dxTabsOptions)
}

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface dxTabsItem extends CollectionWidgetItem {
    /** Specifies a badge text for the tab. */
    badge?: string;
    /** Specifies the icon to be displayed on the tab. */
    icon?: string;
}

declare global {
interface JQuery {
    dxTabs(): JQuery;
    dxTabs(options: "instance"): dxTabs;
    dxTabs(options: string): any;
    dxTabs(options: string, ...params: any[]): any;
    dxTabs(options: dxTabsOptions): JQuery;
}
}
/** Warning! This type is used for internal purposes. Do not import it directly. */
export type Options = dxTabsOptions;

/** @deprecated use Options instead */
/** Warning! This type is used for internal purposes. Do not import it directly. */
export type IOptions = dxTabsOptions;