devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
413 lines (309 loc) • 15.5 kB
TypeScript
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 Store from 'devextreme/data/abstract_store';
import DataSource, { Options as DataSourceOptions } from 'devextreme/data/data_source';
import DxSlideOut from 'devextreme/ui/slide_out';
import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core';
import { DxiItemComponent } from 'devextreme-angular/ui/nested';
import * as i0 from "@angular/core";
import * as i1 from "devextreme-angular/ui/nested";
import * as i2 from "devextreme-angular/core";
import * as i3 from "@angular/platform-browser";
export { ExplicitTypes } from 'devextreme/ui/slide_out';
/**
* The SlideOut UI component is a classic slide-out menu paired with a view. An end user opens the menu by swiping away the view.
*/
export declare class DxSlideOutComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
private _watcherHelper;
private _idh;
instance: DxSlideOut;
/**
* Specifies whether the UI component changes its visual state as a result of user interaction.
*/
get activeStateEnabled(): boolean;
set activeStateEnabled(value: boolean);
/**
* Specifies a custom template for the UI component content. Rendered only once - when the UI component is created.
*/
get contentTemplate(): any;
set contentTemplate(value: any);
/**
* Binds the UI component to data.
*/
get dataSource(): DataSource | DataSourceOptions | Store | null | string | Array<string | DevExpress.ui.dxSlideOutItem | any>;
set dataSource(value: DataSource | DataSourceOptions | Store | null | string | Array<string | DevExpress.ui.dxSlideOutItem | any>);
/**
* Specifies whether the UI component responds to user interaction.
*/
get disabled(): boolean;
set disabled(value: boolean);
/**
* Specifies the global attributes to be attached to the UI component's container element.
*/
get elementAttr(): any;
set elementAttr(value: any);
/**
* Specifies the UI component's height.
*/
get height(): number | Function | string | undefined;
set height(value: number | Function | string | undefined);
/**
* Specifies text for a hint that appears when a user pauses on the UI component.
*/
get hint(): string | undefined;
set hint(value: string | undefined);
/**
* Specifies whether the UI component changes its state when a user pauses on it.
*/
get hoverStateEnabled(): boolean;
set hoverStateEnabled(value: boolean);
/**
* The time period in milliseconds before the onItemHold event is raised.
*/
get itemHoldTimeout(): number;
set itemHoldTimeout(value: number);
/**
* An array of items displayed by the UI component.
*/
get items(): Array<string | any | {
disabled?: boolean;
html?: string;
menuTemplate?: any;
template?: any;
text?: string;
visible?: boolean;
}>;
set items(value: Array<string | any | {
disabled?: boolean;
html?: string;
menuTemplate?: any;
template?: any;
text?: string;
visible?: boolean;
}>);
/**
* Specifies a custom template for items.
*/
get itemTemplate(): any;
set itemTemplate(value: any);
/**
* A Boolean value specifying whether or not to display a grouped menu.
*/
get menuGrouped(): boolean;
set menuGrouped(value: boolean);
/**
* Specifies a custom template for group captions.
*/
get menuGroupTemplate(): any;
set menuGroupTemplate(value: any);
/**
* Specifies a custom template for menu items.
*/
get menuItemTemplate(): any;
set menuItemTemplate(value: any);
/**
* Specifies the current menu position.
*/
get menuPosition(): string;
set menuPosition(value: string);
/**
* Specifies whether or not the slide-out menu is displayed.
*/
get menuVisible(): boolean;
set menuVisible(value: boolean);
/**
* Specifies the text or HTML markup displayed by the UI component if the item collection is empty.
*/
get noDataText(): string;
set noDataText(value: string);
/**
* Switches the UI component to a right-to-left representation.
*/
get rtlEnabled(): boolean;
set rtlEnabled(value: boolean);
/**
* The index number of the currently selected item.
*/
get selectedIndex(): number;
set selectedIndex(value: number);
/**
* The selected item object.
*/
get selectedItem(): any;
set selectedItem(value: any);
/**
* Indicates whether the menu can be shown/hidden by swiping the UI component's main panel.
*/
get swipeEnabled(): boolean;
set swipeEnabled(value: boolean);
/**
* Specifies whether the UI component is visible.
*/
get visible(): boolean;
set visible(value: boolean);
/**
* Specifies the UI component's width.
*/
get width(): number | Function | string | undefined;
set width(value: number | Function | string | undefined);
/**
* A function that is executed when the UI component is rendered and each time the component is repainted.
*/
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 when a group menu item is rendered.
*/
onMenuGroupRendered: EventEmitter<any>;
/**
* A function that is executed when a regular menu item is rendered.
*/
onMenuItemRendered: 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.
*/
activeStateEnabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
contentTemplateChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dataSourceChange: EventEmitter<DataSource | DataSourceOptions | Store | null | string | Array<string | DevExpress.ui.dxSlideOutItem | 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.
*/
heightChange: EventEmitter<number | Function | string | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hintChange: EventEmitter<string | undefined>;
/**
* 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 | {
disabled?: boolean;
html?: string;
menuTemplate?: any;
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.
*/
menuGroupedChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
menuGroupTemplateChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
menuItemTemplateChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
menuPositionChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
menuVisibleChange: EventEmitter<boolean>;
/**
* 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.
*/
rtlEnabledChange: 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.
*/
swipeEnabledChange: EventEmitter<boolean>;
/**
* 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 | undefined>;
get itemsChildren(): QueryList<DxiItemComponent>;
set itemsChildren(value: 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): DxSlideOut<any, any>;
ngOnDestroy(): void;
ngOnChanges(changes: SimpleChanges): void;
setupChanges(prop: string, changes: SimpleChanges): void;
ngDoCheck(): void;
_setOption(name: string, value: any): void;
static ɵfac: i0.ɵɵFactoryDeclaration<DxSlideOutComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<DxSlideOutComponent, "dx-slide-out", never, { "activeStateEnabled": "activeStateEnabled"; "contentTemplate": "contentTemplate"; "dataSource": "dataSource"; "disabled": "disabled"; "elementAttr": "elementAttr"; "height": "height"; "hint": "hint"; "hoverStateEnabled": "hoverStateEnabled"; "itemHoldTimeout": "itemHoldTimeout"; "items": "items"; "itemTemplate": "itemTemplate"; "menuGrouped": "menuGrouped"; "menuGroupTemplate": "menuGroupTemplate"; "menuItemTemplate": "menuItemTemplate"; "menuPosition": "menuPosition"; "menuVisible": "menuVisible"; "noDataText": "noDataText"; "rtlEnabled": "rtlEnabled"; "selectedIndex": "selectedIndex"; "selectedItem": "selectedItem"; "swipeEnabled": "swipeEnabled"; "visible": "visible"; "width": "width"; }, { "onContentReady": "onContentReady"; "onDisposing": "onDisposing"; "onInitialized": "onInitialized"; "onItemClick": "onItemClick"; "onItemContextMenu": "onItemContextMenu"; "onItemHold": "onItemHold"; "onItemRendered": "onItemRendered"; "onMenuGroupRendered": "onMenuGroupRendered"; "onMenuItemRendered": "onMenuItemRendered"; "onOptionChanged": "onOptionChanged"; "onSelectionChanged": "onSelectionChanged"; "activeStateEnabledChange": "activeStateEnabledChange"; "contentTemplateChange": "contentTemplateChange"; "dataSourceChange": "dataSourceChange"; "disabledChange": "disabledChange"; "elementAttrChange": "elementAttrChange"; "heightChange": "heightChange"; "hintChange": "hintChange"; "hoverStateEnabledChange": "hoverStateEnabledChange"; "itemHoldTimeoutChange": "itemHoldTimeoutChange"; "itemsChange": "itemsChange"; "itemTemplateChange": "itemTemplateChange"; "menuGroupedChange": "menuGroupedChange"; "menuGroupTemplateChange": "menuGroupTemplateChange"; "menuItemTemplateChange": "menuItemTemplateChange"; "menuPositionChange": "menuPositionChange"; "menuVisibleChange": "menuVisibleChange"; "noDataTextChange": "noDataTextChange"; "rtlEnabledChange": "rtlEnabledChange"; "selectedIndexChange": "selectedIndexChange"; "selectedItemChange": "selectedItemChange"; "swipeEnabledChange": "swipeEnabledChange"; "visibleChange": "visibleChange"; "widthChange": "widthChange"; }, ["itemsChildren"], never>;
}
export declare class DxSlideOutModule {
static ɵfac: i0.ɵɵFactoryDeclaration<DxSlideOutModule, never>;
static ɵmod: i0.ɵɵNgModuleDeclaration<DxSlideOutModule, [typeof DxSlideOutComponent], [typeof i1.DxiItemModule, typeof i2.DxIntegrationModule, typeof i2.DxTemplateModule, typeof i3.BrowserTransferStateModule], [typeof DxSlideOutComponent, typeof i1.DxiItemModule, typeof i2.DxTemplateModule]>;
static ɵinj: i0.ɵɵInjectorDeclaration<DxSlideOutModule>;
}