hongluan-ui
Version:
Hongluan Component Library for Vue 3
190 lines (189 loc) • 11.1 kB
TypeScript
import type { ExtractPropTypes } from 'vue';
import type { Placement, Options } from '@popperjs/core';
import type { Measurable } from 'hongluan-ui/es/tokens';
import type Content from './content.vue';
declare type ClassObjectType = Record<string, boolean>;
declare type ClassType = string | ClassObjectType | ClassType[];
export interface CreatePopperInstanceParams {
referenceEl: Measurable;
popperContentEl: HTMLElement;
arrowEl: HTMLElement | undefined;
}
export declare const popperCoreConfigProps: {
readonly boundariesPadding: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
readonly fallbackPlacements: {
readonly type: import("vue").PropType<Placement[]>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly gpuAcceleration: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
readonly offset: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 8, boolean>;
readonly placement: import("hongluan-ui/es/utils").EpPropFinalized<StringConstructor, Placement, unknown, "bottom", boolean>;
readonly popperOptions: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<Partial<Options>>, unknown, unknown, () => Partial<Options>, boolean>;
readonly strategy: import("hongluan-ui/es/utils").EpPropFinalized<StringConstructor, "fixed" | "absolute", unknown, "absolute", boolean>;
};
export declare type PopperCoreConfigProps = ExtractPropTypes<typeof popperCoreConfigProps>;
export declare const popperContentProps: {
readonly ariaLabel: StringConstructor;
readonly id: StringConstructor;
readonly style: {
readonly type: import("vue").PropType<unknown>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly className: {
readonly type: import("vue").PropType<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<ClassType>, unknown, unknown>>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly effect: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<string>, unknown, unknown, "", boolean>;
readonly visible: BooleanConstructor;
readonly enterable: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
readonly pure: BooleanConstructor;
readonly focusOnShow: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
readonly trapping: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
readonly popperClass: {
readonly type: import("vue").PropType<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<ClassType>, unknown, unknown>>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly popperStyle: {
readonly type: import("vue").PropType<unknown>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly referenceEl: {
readonly type: import("vue").PropType<HTMLElement>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly triggerTargetEl: {
readonly type: import("vue").PropType<HTMLElement>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly stopPopperMouseEvent: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
readonly virtualTriggering: BooleanConstructor;
readonly zIndex: NumberConstructor;
readonly boundariesPadding: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
readonly fallbackPlacements: {
readonly type: import("vue").PropType<Placement[]>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly gpuAcceleration: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
readonly offset: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 8, boolean>;
readonly placement: import("hongluan-ui/es/utils").EpPropFinalized<StringConstructor, Placement, unknown, "bottom", boolean>;
readonly popperOptions: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<Partial<Options>>, unknown, unknown, () => Partial<Options>, boolean>;
readonly strategy: import("hongluan-ui/es/utils").EpPropFinalized<StringConstructor, "fixed" | "absolute", unknown, "absolute", boolean>;
};
export declare type PopperContentProps = ExtractPropTypes<typeof popperContentProps>;
export declare const popperContentEmits: {
mouseenter: (evt: MouseEvent) => boolean;
mouseleave: (evt: MouseEvent) => boolean;
focus: () => boolean;
blur: () => boolean;
close: () => boolean;
};
export declare type PopperContentEmits = typeof popperContentEmits;
export declare type PopperContentInstance = InstanceType<typeof Content>;
/** @deprecated use `popperCoreConfigProps` instead, and it will be deprecated in the next major version */
export declare const usePopperCoreConfigProps: {
readonly boundariesPadding: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
readonly fallbackPlacements: {
readonly type: import("vue").PropType<Placement[]>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly gpuAcceleration: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
readonly offset: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 8, boolean>;
readonly placement: import("hongluan-ui/es/utils").EpPropFinalized<StringConstructor, Placement, unknown, "bottom", boolean>;
readonly popperOptions: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<Partial<Options>>, unknown, unknown, () => Partial<Options>, boolean>;
readonly strategy: import("hongluan-ui/es/utils").EpPropFinalized<StringConstructor, "fixed" | "absolute", unknown, "absolute", boolean>;
};
/** @deprecated use `popperContentProps` instead, and it will be deprecated in the next major version */
export declare const usePopperContentProps: {
readonly ariaLabel: StringConstructor;
readonly id: StringConstructor;
readonly style: {
readonly type: import("vue").PropType<unknown>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly className: {
readonly type: import("vue").PropType<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<ClassType>, unknown, unknown>>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly effect: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<string>, unknown, unknown, "", boolean>;
readonly visible: BooleanConstructor;
readonly enterable: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
readonly pure: BooleanConstructor;
readonly focusOnShow: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
readonly trapping: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
readonly popperClass: {
readonly type: import("vue").PropType<import("hongluan-ui/es/utils").EpPropMergeType<import("vue").PropType<ClassType>, unknown, unknown>>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly popperStyle: {
readonly type: import("vue").PropType<unknown>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly referenceEl: {
readonly type: import("vue").PropType<HTMLElement>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly triggerTargetEl: {
readonly type: import("vue").PropType<HTMLElement>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly stopPopperMouseEvent: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
readonly virtualTriggering: BooleanConstructor;
readonly zIndex: NumberConstructor;
readonly boundariesPadding: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
readonly fallbackPlacements: {
readonly type: import("vue").PropType<Placement[]>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly gpuAcceleration: import("hongluan-ui/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
readonly offset: import("hongluan-ui/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 8, boolean>;
readonly placement: import("hongluan-ui/es/utils").EpPropFinalized<StringConstructor, Placement, unknown, "bottom", boolean>;
readonly popperOptions: import("hongluan-ui/es/utils").EpPropFinalized<import("vue").PropType<Partial<Options>>, unknown, unknown, () => Partial<Options>, boolean>;
readonly strategy: import("hongluan-ui/es/utils").EpPropFinalized<StringConstructor, "fixed" | "absolute", unknown, "absolute", boolean>;
};
/** @deprecated use `popperContentEmits` instead, and it will be deprecated in the next major version */
export declare const usePopperContentEmits: {
mouseenter: (evt: MouseEvent) => boolean;
mouseleave: (evt: MouseEvent) => boolean;
focus: () => boolean;
blur: () => boolean;
close: () => boolean;
};
/** @deprecated use `PopperCoreConfigProps` instead, and it will be deprecated in the next major version */
export declare type UsePopperCoreConfigProps = PopperCoreConfigProps;
/** @deprecated use `PopperContentProps` instead, and it will be deprecated in the next major version */
export declare type UsePopperContentProps = PopperContentProps;
/** @deprecated use `PopperContentInstance` instead, and it will be deprecated in the next major version */
export declare type PopperArrowContent = PopperContentInstance;
export {};