UNPKG

devextreme-angular

Version:

Angular UI and visualization components based on DevExtreme widgets

403 lines (296 loc) • 12.1 kB
/*! * devextreme-angular * Version: 20.2.5 * Build date: Fri Jan 15 2021 * * Copyright (c) 2012 - 2021 Developer Express Inc. ALL RIGHTS RESERVED * * This software may be modified and distributed under the terms * of the MIT license. See the LICENSE file in the root of the project for details. * * https://github.com/DevExpress/devextreme-angular */ import { TransferState } from '@angular/platform-browser'; import { ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges, QueryList } from '@angular/core'; import DevExpress from 'devextreme/bundles/dx.all'; import DxTabs from 'devextreme/ui/tabs'; import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core'; import { DxiItemComponent } from 'devextreme-angular/ui/nested'; /** * The Tabs is a tab strip used to switch between pages or views. This UI component is included in the TabPanel UI component, but you can use the Tabs separately as well. */ export declare class DxTabsComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck { private _watcherHelper; private _idh; instance: DxTabs; /** * Specifies the shortcut key that sets focus on the UI component. */ accessKey: string; /** * Binds the UI component to data. */ dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.dxTabsItem | any>; /** * Specifies whether the UI component responds to user interaction. */ disabled: boolean; /** * Specifies the global attributes to be attached to the UI component's container element. */ elementAttr: any; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled: boolean; /** * Specifies the UI component's height. */ height: number | Function | string; /** * Specifies text for a hint that appears when a user pauses on the UI component. */ hint: string; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled: boolean; /** * The time period in milliseconds before the onItemHold event is raised. */ itemHoldTimeout: number; /** * An array of items displayed by the UI component. */ items: Array<string | any | { badge?: string; disabled?: boolean; html?: string; icon?: string; template?: any; text?: string; visible?: boolean; }>; /** * Specifies a custom template for items. */ itemTemplate: any; /** * Specifies the key property that provides key values to access data items. Each key value must be unique. */ keyExpr: Function | string; /** * The text or HTML markup displayed by the UI component if the item collection is empty. */ noDataText: string; /** * Specifies whether to repaint only those elements whose data changed. */ repaintChangesOnly: boolean; /** * Switches the UI component to a right-to-left representation. */ rtlEnabled: 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; /** * The index of the currently selected UI component 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<string | number | any>; /** * Specifies whether the UI component enables an end-user to select only a single item or multiple items. */ selectionMode: string; /** * Specifies whether navigation buttons should be available when tabs exceed the UI component's width. */ showNavButtons: boolean; /** * Specifies the number of the element when the Tab key is used for navigating. */ tabIndex: number; /** * Specifies whether the UI component is visible. */ visible: boolean; /** * Specifies the UI component's width. */ width: number | Function | string; /** * A function that is executed when the UI component's content is ready and each time the content is changed. */ onContentReady: EventEmitter<any>; /** * A function that is executed before the UI component is disposed of. */ onDisposing: EventEmitter<any>; /** * A function used in JavaScript frameworks to save the UI component instance. */ onInitialized: EventEmitter<any>; /** * A function that is executed when a collection item is clicked or tapped. */ onItemClick: EventEmitter<any>; /** * A function that is executed when a collection item is right-clicked or pressed. */ onItemContextMenu: EventEmitter<any>; /** * A function that is executed when a collection item has been held for a specified period. */ onItemHold: EventEmitter<any>; /** * A function that is executed after a collection item is rendered. */ onItemRendered: EventEmitter<any>; /** * A function that is executed after a UI component property is changed. */ onOptionChanged: EventEmitter<any>; /** * A function that is executed when a collection item is selected or selection is canceled. */ onSelectionChanged: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ accessKeyChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ dataSourceChange: EventEmitter<DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.dxTabsItem | any>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ disabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ elementAttrChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ focusStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ heightChange: EventEmitter<number | Function | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hintChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hoverStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemHoldTimeoutChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemsChange: EventEmitter<Array<string | any | { badge?: string; disabled?: boolean; html?: string; icon?: string; template?: any; text?: string; visible?: boolean; }>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemTemplateChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ keyExprChange: EventEmitter<Function | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ noDataTextChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ repaintChangesOnlyChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ rtlEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ scrollByContentChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ scrollingEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectedIndexChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectedItemChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectedItemKeysChange: EventEmitter<Array<any>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectedItemsChange: EventEmitter<Array<string | number | any>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectionModeChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showNavButtonsChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ tabIndexChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ visibleChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ widthChange: EventEmitter<number | Function | string>; itemsChildren: QueryList<DxiItemComponent>; constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxTabs; ngOnDestroy(): void; ngOnChanges(changes: SimpleChanges): void; setupChanges(prop: string, changes: SimpleChanges): void; ngDoCheck(): void; _setOption(name: string, value: any): void; } export declare class DxTabsModule { }