devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
276 lines (208 loc) • 12.7 kB
TypeScript
/*!
* devextreme-angular
* Version: 24.2.6
* Build date: Mon Mar 17 2025
*
* Copyright (c) 2012 - 2025 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, ElementRef, NgZone, OnDestroy, EventEmitter } from '@angular/core';
import { AnimationConfig } from 'devextreme/common/core/animation';
import { ContentReadyEvent, DisposingEvent, InitializedEvent, OptionChangedEvent, RenderedEvent, ShownEvent } from 'devextreme/ui/defer_rendering';
import { DxPromise } from 'devextreme/core/utils/deferred';
import DxDeferRendering from 'devextreme/ui/defer_rendering';
import { DxComponent, DxTemplateHost, NestedOptionHost, WatcherHelper } from 'devextreme-angular/core';
import type * as DxDeferRenderingTypes from "devextreme/ui/defer_rendering_types";
import * as i0 from "@angular/core";
import * as i1 from "devextreme-angular/ui/nested";
import * as i2 from "devextreme-angular/ui/defer-rendering/nested";
import * as i3 from "devextreme-angular/core";
/**
* The DeferRendering is a UI component that waits for its content to be ready before rendering it. While the content is getting ready, the DeferRendering displays a loading indicator.
*/
export declare class DxDeferRenderingComponent extends DxComponent implements OnDestroy {
instance: DxDeferRendering;
/**
* Specifies the shortcut key that sets focus on the UI component.
*/
get accessKey(): string | undefined;
set accessKey(value: string | undefined);
/**
* Specifies whether the UI component changes its visual state as a result of user interaction.
*/
get activeStateEnabled(): boolean;
set activeStateEnabled(value: boolean);
/**
* Specifies the animation to be used to show the rendered content.
*/
get animation(): AnimationConfig | undefined;
set animation(value: AnimationConfig | undefined);
/**
* 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(): Record<string, any>;
set elementAttr(value: Record<string, any>);
/**
* Specifies whether the UI component can be focused using keyboard navigation.
*/
get focusStateEnabled(): boolean;
set focusStateEnabled(value: boolean);
/**
* Specifies the UI component's height.
*/
get height(): (() => number | string) | number | string | undefined;
set height(value: (() => number | string) | number | 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);
/**
* Specifies when the UI component content is rendered.
*/
get renderWhen(): boolean | DxPromise | undefined;
set renderWhen(value: boolean | DxPromise | undefined);
/**
* Switches the UI component to a right-to-left representation.
*/
get rtlEnabled(): boolean;
set rtlEnabled(value: boolean);
/**
* Indicates if a load indicator should be shown until the UI component's content is rendered.
*/
get showLoadIndicator(): boolean;
set showLoadIndicator(value: boolean);
/**
* Specifies a jQuery selector of items that should be rendered using a staggered animation.
*/
get staggerItemSelector(): string | undefined;
set staggerItemSelector(value: string | undefined);
/**
* Specifies the number of the element when the Tab key is used for navigating.
*/
get tabIndex(): number;
set tabIndex(value: number);
/**
* Specifies whether the UI component is visible.
*/
get visible(): boolean;
set visible(value: boolean);
/**
* Specifies the UI component's width.
*/
get width(): (() => number | string) | number | string | undefined;
set width(value: (() => number | string) | number | string | undefined);
/**
* A function that is executed when the UI component is rendered and each time the component is repainted.
*/
onContentReady: EventEmitter<ContentReadyEvent>;
/**
* A function that is executed before the UI component is disposed of.
*/
onDisposing: EventEmitter<DisposingEvent>;
/**
* A function used in JavaScript frameworks to save the UI component instance.
*/
onInitialized: EventEmitter<InitializedEvent>;
/**
* A function that is executed after a UI component property is changed.
*/
onOptionChanged: EventEmitter<OptionChangedEvent>;
/**
* A function that is executed when the content is rendered but not yet displayed.
*/
onRendered: EventEmitter<RenderedEvent>;
/**
* A function that is executed when the content is displayed and animation is completed.
*/
onShown: EventEmitter<ShownEvent>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
accessKeyChange: EventEmitter<string | undefined>;
/**
* 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.
*/
animationChange: EventEmitter<AnimationConfig | undefined>;
/**
* 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<Record<string, 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 | string) | number | 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.
*/
renderWhenChange: EventEmitter<boolean | DxPromise | undefined>;
/**
* 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.
*/
showLoadIndicatorChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
staggerItemSelectorChange: EventEmitter<string | undefined>;
/**
* 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 | string) | number | string | undefined>;
constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
protected _createInstance(element: any, options: any): DxDeferRendering;
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<DxDeferRenderingComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<DxDeferRenderingComponent, "dx-defer-rendering", never, { "accessKey": { "alias": "accessKey"; "required": false; }; "activeStateEnabled": { "alias": "activeStateEnabled"; "required": false; }; "animation": { "alias": "animation"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "elementAttr": { "alias": "elementAttr"; "required": false; }; "focusStateEnabled": { "alias": "focusStateEnabled"; "required": false; }; "height": { "alias": "height"; "required": false; }; "hint": { "alias": "hint"; "required": false; }; "hoverStateEnabled": { "alias": "hoverStateEnabled"; "required": false; }; "renderWhen": { "alias": "renderWhen"; "required": false; }; "rtlEnabled": { "alias": "rtlEnabled"; "required": false; }; "showLoadIndicator": { "alias": "showLoadIndicator"; "required": false; }; "staggerItemSelector": { "alias": "staggerItemSelector"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "visible": { "alias": "visible"; "required": false; }; "width": { "alias": "width"; "required": false; }; }, { "onContentReady": "onContentReady"; "onDisposing": "onDisposing"; "onInitialized": "onInitialized"; "onOptionChanged": "onOptionChanged"; "onRendered": "onRendered"; "onShown": "onShown"; "accessKeyChange": "accessKeyChange"; "activeStateEnabledChange": "activeStateEnabledChange"; "animationChange": "animationChange"; "disabledChange": "disabledChange"; "elementAttrChange": "elementAttrChange"; "focusStateEnabledChange": "focusStateEnabledChange"; "heightChange": "heightChange"; "hintChange": "hintChange"; "hoverStateEnabledChange": "hoverStateEnabledChange"; "renderWhenChange": "renderWhenChange"; "rtlEnabledChange": "rtlEnabledChange"; "showLoadIndicatorChange": "showLoadIndicatorChange"; "staggerItemSelectorChange": "staggerItemSelectorChange"; "tabIndexChange": "tabIndexChange"; "visibleChange": "visibleChange"; "widthChange": "widthChange"; }, never, never, false, never>;
}
export declare class DxDeferRenderingModule {
static ɵfac: i0.ɵɵFactoryDeclaration<DxDeferRenderingModule, never>;
static ɵmod: i0.ɵɵNgModuleDeclaration<DxDeferRenderingModule, [typeof DxDeferRenderingComponent], [typeof i1.DxoAnimationModule, typeof i1.DxoFromModule, typeof i1.DxoPositionModule, typeof i1.DxoAtModule, typeof i1.DxoBoundaryOffsetModule, typeof i1.DxoCollisionModule, typeof i1.DxoMyModule, typeof i1.DxoOffsetModule, typeof i1.DxoToModule, typeof i2.DxoDeferRenderingAnimationModule, typeof i2.DxoDeferRenderingAtModule, typeof i2.DxoDeferRenderingBoundaryOffsetModule, typeof i2.DxoDeferRenderingCollisionModule, typeof i2.DxoDeferRenderingFromModule, typeof i2.DxoDeferRenderingMyModule, typeof i2.DxoDeferRenderingOffsetModule, typeof i2.DxoDeferRenderingPositionModule, typeof i2.DxoDeferRenderingToModule, typeof i3.DxIntegrationModule, typeof i3.DxTemplateModule], [typeof DxDeferRenderingComponent, typeof i1.DxoAnimationModule, typeof i1.DxoFromModule, typeof i1.DxoPositionModule, typeof i1.DxoAtModule, typeof i1.DxoBoundaryOffsetModule, typeof i1.DxoCollisionModule, typeof i1.DxoMyModule, typeof i1.DxoOffsetModule, typeof i1.DxoToModule, typeof i2.DxoDeferRenderingAnimationModule, typeof i2.DxoDeferRenderingAtModule, typeof i2.DxoDeferRenderingBoundaryOffsetModule, typeof i2.DxoDeferRenderingCollisionModule, typeof i2.DxoDeferRenderingFromModule, typeof i2.DxoDeferRenderingMyModule, typeof i2.DxoDeferRenderingOffsetModule, typeof i2.DxoDeferRenderingPositionModule, typeof i2.DxoDeferRenderingToModule, typeof i3.DxTemplateModule]>;
static ɵinj: i0.ɵɵInjectorDeclaration<DxDeferRenderingModule>;
}
export { DxDeferRenderingTypes };