devextreme-vue
Version:
DevExtreme Vue UI and Visualization Components
363 lines (361 loc) • 18.6 kB
TypeScript
/*!
* devextreme-vue
* Version: 25.1.5
* Build date: Wed Sep 03 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-vue
*/
import { PropType } from "vue";
import DeferRendering, { Properties } from "devextreme/ui/defer_rendering";
import { AnimationConfig, AnimationState, AnimationType, CollisionResolution, PositionConfig, CollisionResolutionCombination } from "devextreme/common/core/animation";
import { ContentReadyEvent, DisposingEvent, InitializedEvent, OptionChangedEvent, RenderedEvent, ShownEvent } from "devextreme/ui/defer_rendering";
import { Direction, HorizontalAlignment, VerticalAlignment, PositionAlignment } from "devextreme/common";
type AccessibleOptions = Pick<Properties, "accessKey" | "activeStateEnabled" | "animation" | "disabled" | "elementAttr" | "focusStateEnabled" | "height" | "hint" | "hoverStateEnabled" | "onContentReady" | "onDisposing" | "onInitialized" | "onOptionChanged" | "onRendered" | "onShown" | "renderWhen" | "rtlEnabled" | "showLoadIndicator" | "staggerItemSelector" | "tabIndex" | "visible" | "width">;
interface DxDeferRendering extends AccessibleOptions {
readonly instance?: DeferRendering;
}
declare const DxDeferRendering: import("@vue/runtime-core").DefineComponent<{
accessKey: StringConstructor;
activeStateEnabled: BooleanConstructor;
animation: PropType<string | number | Record<string, any> | AnimationConfig>;
disabled: BooleanConstructor;
elementAttr: PropType<Record<string, any>>;
focusStateEnabled: BooleanConstructor;
height: (NumberConstructor | StringConstructor)[];
hint: StringConstructor;
hoverStateEnabled: BooleanConstructor;
onContentReady: PropType<(e: ContentReadyEvent) => void>;
onDisposing: PropType<(e: DisposingEvent) => void>;
onInitialized: PropType<(e: InitializedEvent) => void>;
onOptionChanged: PropType<(e: OptionChangedEvent) => void>;
onRendered: PropType<(e: RenderedEvent) => void>;
onShown: PropType<(e: ShownEvent) => void>;
renderWhen: {};
rtlEnabled: BooleanConstructor;
showLoadIndicator: BooleanConstructor;
staggerItemSelector: StringConstructor;
tabIndex: NumberConstructor;
visible: BooleanConstructor;
width: (NumberConstructor | StringConstructor)[];
}, unknown, unknown, {
instance(): DeferRendering;
}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {
"update:isActive": null;
"update:hoveredElement": null;
"update:accessKey": null;
"update:activeStateEnabled": null;
"update:animation": null;
"update:disabled": null;
"update:elementAttr": null;
"update:focusStateEnabled": null;
"update:height": null;
"update:hint": null;
"update:hoverStateEnabled": null;
"update:onContentReady": null;
"update:onDisposing": null;
"update:onInitialized": null;
"update:onOptionChanged": null;
"update:onRendered": null;
"update:onShown": null;
"update:renderWhen": null;
"update:rtlEnabled": null;
"update:showLoadIndicator": null;
"update:staggerItemSelector": null;
"update:tabIndex": null;
"update:visible": null;
"update:width": null;
}, string, import("@vue/runtime-core").VNodeProps & import("@vue/runtime-core").AllowedComponentProps & import("@vue/runtime-core").ComponentCustomProps, Readonly<import("@vue/runtime-core").ExtractPropTypes<{
accessKey: StringConstructor;
activeStateEnabled: BooleanConstructor;
animation: PropType<string | number | Record<string, any> | AnimationConfig>;
disabled: BooleanConstructor;
elementAttr: PropType<Record<string, any>>;
focusStateEnabled: BooleanConstructor;
height: (NumberConstructor | StringConstructor)[];
hint: StringConstructor;
hoverStateEnabled: BooleanConstructor;
onContentReady: PropType<(e: ContentReadyEvent) => void>;
onDisposing: PropType<(e: DisposingEvent) => void>;
onInitialized: PropType<(e: InitializedEvent) => void>;
onOptionChanged: PropType<(e: OptionChangedEvent) => void>;
onRendered: PropType<(e: RenderedEvent) => void>;
onShown: PropType<(e: ShownEvent) => void>;
renderWhen: {};
rtlEnabled: BooleanConstructor;
showLoadIndicator: BooleanConstructor;
staggerItemSelector: StringConstructor;
tabIndex: NumberConstructor;
visible: BooleanConstructor;
width: (NumberConstructor | StringConstructor)[];
}>> & {
"onUpdate:isActive"?: ((...args: any[]) => any) | undefined;
"onUpdate:hoveredElement"?: ((...args: any[]) => any) | undefined;
"onUpdate:accessKey"?: ((...args: any[]) => any) | undefined;
"onUpdate:activeStateEnabled"?: ((...args: any[]) => any) | undefined;
"onUpdate:disabled"?: ((...args: any[]) => any) | undefined;
"onUpdate:elementAttr"?: ((...args: any[]) => any) | undefined;
"onUpdate:focusStateEnabled"?: ((...args: any[]) => any) | undefined;
"onUpdate:height"?: ((...args: any[]) => any) | undefined;
"onUpdate:hint"?: ((...args: any[]) => any) | undefined;
"onUpdate:hoverStateEnabled"?: ((...args: any[]) => any) | undefined;
"onUpdate:onContentReady"?: ((...args: any[]) => any) | undefined;
"onUpdate:onDisposing"?: ((...args: any[]) => any) | undefined;
"onUpdate:onInitialized"?: ((...args: any[]) => any) | undefined;
"onUpdate:onOptionChanged"?: ((...args: any[]) => any) | undefined;
"onUpdate:rtlEnabled"?: ((...args: any[]) => any) | undefined;
"onUpdate:tabIndex"?: ((...args: any[]) => any) | undefined;
"onUpdate:visible"?: ((...args: any[]) => any) | undefined;
"onUpdate:width"?: ((...args: any[]) => any) | undefined;
"onUpdate:animation"?: ((...args: any[]) => any) | undefined;
"onUpdate:onShown"?: ((...args: any[]) => any) | undefined;
"onUpdate:onRendered"?: ((...args: any[]) => any) | undefined;
"onUpdate:renderWhen"?: ((...args: any[]) => any) | undefined;
"onUpdate:showLoadIndicator"?: ((...args: any[]) => any) | undefined;
"onUpdate:staggerItemSelector"?: ((...args: any[]) => any) | undefined;
}, {
activeStateEnabled: boolean;
disabled: boolean;
focusStateEnabled: boolean;
hoverStateEnabled: boolean;
rtlEnabled: boolean;
visible: boolean;
showLoadIndicator: boolean;
}>;
declare const DxAnimation: import("@vue/runtime-core").DefineComponent<{
complete: PropType<($element: any, config: AnimationConfig) => void>;
delay: NumberConstructor;
direction: PropType<Direction>;
duration: NumberConstructor;
easing: StringConstructor;
from: PropType<Record<string, any> | AnimationState>;
staggerDelay: NumberConstructor;
start: PropType<($element: any, config: AnimationConfig) => void>;
to: PropType<Record<string, any> | AnimationState>;
type: PropType<AnimationType>;
}, unknown, unknown, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {
"update:isActive": null;
"update:hoveredElement": null;
"update:complete": null;
"update:delay": null;
"update:direction": null;
"update:duration": null;
"update:easing": null;
"update:from": null;
"update:staggerDelay": null;
"update:start": null;
"update:to": null;
"update:type": null;
}, string, import("@vue/runtime-core").VNodeProps & import("@vue/runtime-core").AllowedComponentProps & import("@vue/runtime-core").ComponentCustomProps, Readonly<import("@vue/runtime-core").ExtractPropTypes<{
complete: PropType<($element: any, config: AnimationConfig) => void>;
delay: NumberConstructor;
direction: PropType<Direction>;
duration: NumberConstructor;
easing: StringConstructor;
from: PropType<Record<string, any> | AnimationState>;
staggerDelay: NumberConstructor;
start: PropType<($element: any, config: AnimationConfig) => void>;
to: PropType<Record<string, any> | AnimationState>;
type: PropType<AnimationType>;
}>> & {
"onUpdate:isActive"?: ((...args: any[]) => any) | undefined;
"onUpdate:hoveredElement"?: ((...args: any[]) => any) | undefined;
"onUpdate:type"?: ((...args: any[]) => any) | undefined;
"onUpdate:complete"?: ((...args: any[]) => any) | undefined;
"onUpdate:delay"?: ((...args: any[]) => any) | undefined;
"onUpdate:direction"?: ((...args: any[]) => any) | undefined;
"onUpdate:duration"?: ((...args: any[]) => any) | undefined;
"onUpdate:easing"?: ((...args: any[]) => any) | undefined;
"onUpdate:from"?: ((...args: any[]) => any) | undefined;
"onUpdate:staggerDelay"?: ((...args: any[]) => any) | undefined;
"onUpdate:start"?: ((...args: any[]) => any) | undefined;
"onUpdate:to"?: ((...args: any[]) => any) | undefined;
}, {}>;
declare const DxAt: import("@vue/runtime-core").DefineComponent<{
x: PropType<HorizontalAlignment>;
y: PropType<VerticalAlignment>;
}, unknown, unknown, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {
"update:isActive": null;
"update:hoveredElement": null;
"update:x": null;
"update:y": null;
}, string, import("@vue/runtime-core").VNodeProps & import("@vue/runtime-core").AllowedComponentProps & import("@vue/runtime-core").ComponentCustomProps, Readonly<import("@vue/runtime-core").ExtractPropTypes<{
x: PropType<HorizontalAlignment>;
y: PropType<VerticalAlignment>;
}>> & {
"onUpdate:isActive"?: ((...args: any[]) => any) | undefined;
"onUpdate:hoveredElement"?: ((...args: any[]) => any) | undefined;
"onUpdate:x"?: ((...args: any[]) => any) | undefined;
"onUpdate:y"?: ((...args: any[]) => any) | undefined;
}, {}>;
declare const DxBoundaryOffset: import("@vue/runtime-core").DefineComponent<{
x: NumberConstructor;
y: NumberConstructor;
}, unknown, unknown, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {
"update:isActive": null;
"update:hoveredElement": null;
"update:x": null;
"update:y": null;
}, string, import("@vue/runtime-core").VNodeProps & import("@vue/runtime-core").AllowedComponentProps & import("@vue/runtime-core").ComponentCustomProps, Readonly<import("@vue/runtime-core").ExtractPropTypes<{
x: NumberConstructor;
y: NumberConstructor;
}>> & {
"onUpdate:isActive"?: ((...args: any[]) => any) | undefined;
"onUpdate:hoveredElement"?: ((...args: any[]) => any) | undefined;
"onUpdate:x"?: ((...args: any[]) => any) | undefined;
"onUpdate:y"?: ((...args: any[]) => any) | undefined;
}, {}>;
declare const DxCollision: import("@vue/runtime-core").DefineComponent<{
x: PropType<CollisionResolution>;
y: PropType<CollisionResolution>;
}, unknown, unknown, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {
"update:isActive": null;
"update:hoveredElement": null;
"update:x": null;
"update:y": null;
}, string, import("@vue/runtime-core").VNodeProps & import("@vue/runtime-core").AllowedComponentProps & import("@vue/runtime-core").ComponentCustomProps, Readonly<import("@vue/runtime-core").ExtractPropTypes<{
x: PropType<CollisionResolution>;
y: PropType<CollisionResolution>;
}>> & {
"onUpdate:isActive"?: ((...args: any[]) => any) | undefined;
"onUpdate:hoveredElement"?: ((...args: any[]) => any) | undefined;
"onUpdate:x"?: ((...args: any[]) => any) | undefined;
"onUpdate:y"?: ((...args: any[]) => any) | undefined;
}, {}>;
declare const DxFrom: import("@vue/runtime-core").DefineComponent<{
left: NumberConstructor;
opacity: NumberConstructor;
position: PropType<Record<string, any> | PositionConfig>;
scale: NumberConstructor;
top: NumberConstructor;
}, unknown, unknown, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {
"update:isActive": null;
"update:hoveredElement": null;
"update:left": null;
"update:opacity": null;
"update:position": null;
"update:scale": null;
"update:top": null;
}, string, import("@vue/runtime-core").VNodeProps & import("@vue/runtime-core").AllowedComponentProps & import("@vue/runtime-core").ComponentCustomProps, Readonly<import("@vue/runtime-core").ExtractPropTypes<{
left: NumberConstructor;
opacity: NumberConstructor;
position: PropType<Record<string, any> | PositionConfig>;
scale: NumberConstructor;
top: NumberConstructor;
}>> & {
"onUpdate:isActive"?: ((...args: any[]) => any) | undefined;
"onUpdate:hoveredElement"?: ((...args: any[]) => any) | undefined;
"onUpdate:position"?: ((...args: any[]) => any) | undefined;
"onUpdate:left"?: ((...args: any[]) => any) | undefined;
"onUpdate:opacity"?: ((...args: any[]) => any) | undefined;
"onUpdate:scale"?: ((...args: any[]) => any) | undefined;
"onUpdate:top"?: ((...args: any[]) => any) | undefined;
}, {}>;
declare const DxMy: import("@vue/runtime-core").DefineComponent<{
x: PropType<HorizontalAlignment>;
y: PropType<VerticalAlignment>;
}, unknown, unknown, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {
"update:isActive": null;
"update:hoveredElement": null;
"update:x": null;
"update:y": null;
}, string, import("@vue/runtime-core").VNodeProps & import("@vue/runtime-core").AllowedComponentProps & import("@vue/runtime-core").ComponentCustomProps, Readonly<import("@vue/runtime-core").ExtractPropTypes<{
x: PropType<HorizontalAlignment>;
y: PropType<VerticalAlignment>;
}>> & {
"onUpdate:isActive"?: ((...args: any[]) => any) | undefined;
"onUpdate:hoveredElement"?: ((...args: any[]) => any) | undefined;
"onUpdate:x"?: ((...args: any[]) => any) | undefined;
"onUpdate:y"?: ((...args: any[]) => any) | undefined;
}, {}>;
declare const DxOffset: import("@vue/runtime-core").DefineComponent<{
x: NumberConstructor;
y: NumberConstructor;
}, unknown, unknown, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {
"update:isActive": null;
"update:hoveredElement": null;
"update:x": null;
"update:y": null;
}, string, import("@vue/runtime-core").VNodeProps & import("@vue/runtime-core").AllowedComponentProps & import("@vue/runtime-core").ComponentCustomProps, Readonly<import("@vue/runtime-core").ExtractPropTypes<{
x: NumberConstructor;
y: NumberConstructor;
}>> & {
"onUpdate:isActive"?: ((...args: any[]) => any) | undefined;
"onUpdate:hoveredElement"?: ((...args: any[]) => any) | undefined;
"onUpdate:x"?: ((...args: any[]) => any) | undefined;
"onUpdate:y"?: ((...args: any[]) => any) | undefined;
}, {}>;
declare const DxPosition: import("@vue/runtime-core").DefineComponent<{
at: PropType<Record<string, any> | PositionAlignment>;
boundary: {};
boundaryOffset: PropType<string | Record<string, any>>;
collision: PropType<Record<string, any> | CollisionResolutionCombination>;
my: PropType<Record<string, any> | PositionAlignment>;
of: {};
offset: PropType<string | Record<string, any>>;
}, unknown, unknown, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {
"update:isActive": null;
"update:hoveredElement": null;
"update:at": null;
"update:boundary": null;
"update:boundaryOffset": null;
"update:collision": null;
"update:my": null;
"update:of": null;
"update:offset": null;
}, string, import("@vue/runtime-core").VNodeProps & import("@vue/runtime-core").AllowedComponentProps & import("@vue/runtime-core").ComponentCustomProps, Readonly<import("@vue/runtime-core").ExtractPropTypes<{
at: PropType<Record<string, any> | PositionAlignment>;
boundary: {};
boundaryOffset: PropType<string | Record<string, any>>;
collision: PropType<Record<string, any> | CollisionResolutionCombination>;
my: PropType<Record<string, any> | PositionAlignment>;
of: {};
offset: PropType<string | Record<string, any>>;
}>> & {
"onUpdate:isActive"?: ((...args: any[]) => any) | undefined;
"onUpdate:hoveredElement"?: ((...args: any[]) => any) | undefined;
"onUpdate:at"?: ((...args: any[]) => any) | undefined;
"onUpdate:boundary"?: ((...args: any[]) => any) | undefined;
"onUpdate:boundaryOffset"?: ((...args: any[]) => any) | undefined;
"onUpdate:collision"?: ((...args: any[]) => any) | undefined;
"onUpdate:my"?: ((...args: any[]) => any) | undefined;
"onUpdate:of"?: ((...args: any[]) => any) | undefined;
"onUpdate:offset"?: ((...args: any[]) => any) | undefined;
}, {}>;
declare const DxTo: import("@vue/runtime-core").DefineComponent<{
left: NumberConstructor;
opacity: NumberConstructor;
position: PropType<Record<string, any> | PositionConfig>;
scale: NumberConstructor;
top: NumberConstructor;
}, unknown, unknown, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {
"update:isActive": null;
"update:hoveredElement": null;
"update:left": null;
"update:opacity": null;
"update:position": null;
"update:scale": null;
"update:top": null;
}, string, import("@vue/runtime-core").VNodeProps & import("@vue/runtime-core").AllowedComponentProps & import("@vue/runtime-core").ComponentCustomProps, Readonly<import("@vue/runtime-core").ExtractPropTypes<{
left: NumberConstructor;
opacity: NumberConstructor;
position: PropType<Record<string, any> | PositionConfig>;
scale: NumberConstructor;
top: NumberConstructor;
}>> & {
"onUpdate:isActive"?: ((...args: any[]) => any) | undefined;
"onUpdate:hoveredElement"?: ((...args: any[]) => any) | undefined;
"onUpdate:position"?: ((...args: any[]) => any) | undefined;
"onUpdate:left"?: ((...args: any[]) => any) | undefined;
"onUpdate:opacity"?: ((...args: any[]) => any) | undefined;
"onUpdate:scale"?: ((...args: any[]) => any) | undefined;
"onUpdate:top"?: ((...args: any[]) => any) | undefined;
}, {}>;
export default DxDeferRendering;
export { DxDeferRendering, DxAnimation, DxAt, DxBoundaryOffset, DxCollision, DxFrom, DxMy, DxOffset, DxPosition, DxTo };
import type * as DxDeferRenderingTypes from "devextreme/ui/defer_rendering_types";
export { DxDeferRenderingTypes };