vue-devui 1.2.0 → 1.2.1-alpha.0

package/types/shared/devui-highlight/devui-highlight.d.ts

@@ -0,0 +1,8 @@
+declare const _default: import("vue").DefineComponent<{
+    code: StringConstructor;
+    language: StringConstructor;
+}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    code: StringConstructor;
+    language: StringConstructor;
+}>>, {}>;
+export default _default;

package/types/shared/hooks/use-demo.d.ts

@@ -0,0 +1,9 @@
+interface ExampleItem {
+    id: `${string}-${string}`;
+    title: string;
+    text?: string;
+    code: string;
+    content: JSX.Element;
+}
+export declare function useDemo(exampleList: ExampleItem[]): JSX.Element;
+export {};

package/types/shared/hooks/use-namespace.d.ts

@@ -0,0 +1,14 @@
+export declare type UseNamespace = {
+    b: () => string;
+    e: (el: string) => string;
+    m: (mo: string) => string;
+    em: (el: string, mo: string) => string;
+};
+/**
+ * useNamespace
+ *
+ * @param block current block name
+ * @param needDot Do you need a dot prefix (defalut: false)
+ * @returns UseNamespace
+ */
+export declare function useNamespace(block: string, needDot?: boolean): UseNamespace;

package/types/shared/scripts/component.d.ts

@@ -0,0 +1,12 @@
+import type { VNode } from 'vue';
+/**
+ * 创建组件实例对象
+ * 返回的实例和调用 getCurrentComponent() 返回的一致
+ * @param {*} Component
+ */
+export declare function createComponent(component: any, props: any, children?: any): VNode['component'];
+/**
+ * 销毁组件实例对象
+ * @param {*} ComponnetInstance 通过createComponent方法得到的组件实例对象
+ */
+export declare function unmountComponent(ComponnetInstance: any): void;

package/types/shared/utils/class.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 判断 DOM 中的元素是否含有某个类
+ * @param el 元素
+ * @param className 类名
+ * @returns
+ */
+export declare function hasClass(el: HTMLElement, className: string): boolean;
+/**
+ * 向 DOM 中的元素添加一个类
+ * @param el 元素
+ * @param className 类名
+ */
+export declare function addClass(el: HTMLElement, className: string): void;
+/**
+ * 从 DOM 中的元素移除一个类
+ * @param el 元素
+ * @param className 类名
+ */
+export declare function removeClass(el: HTMLElement, className: string): void;

package/types/shared/utils/common-var.d.ts

@@ -0,0 +1 @@
+export declare const inBrowser: boolean;

package/types/shared/utils/debounce.d.ts

@@ -0,0 +1,8 @@
+/**
+ *
+ * @param func The function to debounce.
+ * @param wait The number of milliseconds to delay.
+ * @param immediate Whether to execute immediately
+ * @returns Returns the new debounced function.
+ */
+export declare function debounce<A extends Array<any>, R = void>(func: (...args: A) => R, wait: number, immediate: boolean): (...args: A) => R;

package/types/shared/utils/deep-assign.d.ts

@@ -0,0 +1 @@
+export declare function deepAssign(...objects: Record<string, unknown>[]): Record<string, unknown>;

package/types/shared/utils/dom.d.ts

@@ -0,0 +1,13 @@
+import { ComponentPublicInstance } from '@vue/runtime-core';
+/**
+ *
+ * @param {any} origin
+ * @returns
+ */
+export declare function isComponent(target: any): target is ComponentPublicInstance;
+/**
+ * 提取 Vue Intance 中的元素，如果本身就是元素，直接返回。
+ * @param {any} element
+ * @returns {Element | null}
+ */
+export declare function getElement(element: Element | ComponentPublicInstance | null): Element | null;

package/types/shared/utils/index.d.ts

@@ -0,0 +1,12 @@
+export * from './class';
+export * from './common-var';
+export * from './debounce';
+export * from './dom';
+export * from './lock-scroll';
+export * from './props-util';
+export * from './random-id';
+export * from './set-style';
+export * from './middle-num';
+export * from './is';
+export * from './wait';
+export * from './omit';

package/types/shared/utils/is.d.ts

@@ -0,0 +1,7 @@
+export declare const isNumber: (value: unknown) => value is number;
+export declare const isBoolean: (value: unknown) => value is boolean;
+export declare const isString: (value: unknown) => value is string;
+export declare const isObject: (value: unknown) => value is Record<string, unknown>;
+export declare const isFunction: (value: unknown) => value is () => unknown;
+export declare const isUndefined: (value: unknown) => value is undefined;
+export declare const isNull: (value: unknown) => value is null;

package/types/shared/utils/lock-scroll.d.ts

@@ -0,0 +1 @@
+export declare function lockScroll(): () => void | undefined;

package/types/shared/utils/middle-num.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Get Middle Value
+ *
+ * @param num to judge the value
+ * @param min min value, default value 0
+ * @param max max value, default value 100
+ * @returns middle value
+ */
+export declare function middleNum(num: number, min?: number, max?: number): number;

package/types/shared/utils/omit.d.ts

@@ -0,0 +1,3 @@
+declare function omit<T extends Record<string, unknown>, K extends keyof T>(obj: T, fields: K[]): Omit<T, K>;
+export { omit };
+export default omit;

package/types/shared/utils/props-util.d.ts

@@ -0,0 +1,2 @@
+import type { Slots, VNode } from 'vue';
+export declare function getPropsSlot(slots: Slots, props: unknown, prop?: string): VNode | string | undefined;

package/types/shared/utils/random-id.d.ts

@@ -0,0 +1 @@
+export declare function randomId(n?: number): string;

package/types/shared/utils/set-style.d.ts

@@ -0,0 +1,8 @@
+import type { CSSProperties } from 'vue';
+/**
+ * 设置元素的样式，返回上一次的样式
+ * @param element
+ * @param style
+ * @returns
+ */
+export declare function setStyle(element: HTMLElement, style: CSSProperties): CSSProperties;

package/types/shared/utils/url.d.ts

@@ -0,0 +1,2 @@
+export declare function isUrl(value: string): boolean;
+export declare function isBase64(value: string): boolean;

package/types/shared/utils/wait.d.ts

@@ -0,0 +1 @@
+export declare const wait: (delay?: number) => Promise<boolean>;

package/types/skeleton/__tests__/skeleton.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/types/skeleton/index.d.ts

@@ -0,0 +1,13 @@
+import type { App } from 'vue';
+import Skeleton from './src/skeleton';
+import SkeletonItem from './src/components/skeleton-item';
+export * from './src/skeleton-types';
+export * from './src/components/skeleton-item-types';
+export { Skeleton, SkeletonItem };
+declare const _default: {
+    title: string;
+    category: string;
+    status: string;
+    install(app: App): void;
+};
+export default _default;

package/types/skeleton/src/components/image-icon.d.ts

@@ -0,0 +1 @@
+export declare function ImageIcon(): JSX.Element;

package/types/skeleton/src/components/skeleton-item-types.d.ts

@@ -0,0 +1,17 @@
+import type { ExtractPropTypes, PropType, ComputedRef } from 'vue';
+export declare type IVariant = 'image' | 'circle' | 'square';
+export declare type ISize = 'lg' | 'md' | 'sm';
+export declare const skeletonItemProps: {
+    readonly variant: {
+        readonly type: PropType<IVariant>;
+        readonly default: "square";
+    };
+    readonly size: {
+        readonly type: PropType<ISize>;
+        readonly default: "md";
+    };
+};
+export declare type SkeletonItemProps = ExtractPropTypes<typeof skeletonItemProps>;
+export interface UseSkeletonItem {
+    classes: ComputedRef<Record<string, boolean>>;
+}

package/types/skeleton/src/components/skeleton-item.d.ts

@@ -0,0 +1,24 @@
+import './skeleton-item.scss';
+declare const _default: import("vue").DefineComponent<{
+    readonly variant: {
+        readonly type: import("vue").PropType<import("./skeleton-item-types").IVariant>;
+        readonly default: "square";
+    };
+    readonly size: {
+        readonly type: import("vue").PropType<import("./skeleton-item-types").ISize>;
+        readonly default: "md";
+    };
+}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    readonly variant: {
+        readonly type: import("vue").PropType<import("./skeleton-item-types").IVariant>;
+        readonly default: "square";
+    };
+    readonly size: {
+        readonly type: import("vue").PropType<import("./skeleton-item-types").ISize>;
+        readonly default: "md";
+    };
+}>>, {
+    readonly size: import("./skeleton-item-types").ISize;
+    readonly variant: import("./skeleton-item-types").IVariant;
+}>;
+export default _default;

package/types/skeleton/src/composables/use-skeleton-item.d.ts

@@ -0,0 +1,2 @@
+import { SkeletonItemProps, UseSkeletonItem } from '../components/skeleton-item-types';
+export declare function useSkeletonItem(props: SkeletonItemProps): UseSkeletonItem;

package/types/skeleton/src/skeleton-types.d.ts

@@ -0,0 +1,22 @@
+import type { ExtractPropTypes, InjectionKey, Ref } from 'vue';
+export declare const skeletonProps: {
+    readonly rows: {
+        readonly type: NumberConstructor;
+        readonly default: 3;
+    };
+    readonly round: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly loading: {
+        readonly type: BooleanConstructor;
+        readonly default: true;
+    };
+    readonly showAnimation: {
+        readonly type: BooleanConstructor;
+        readonly default: true;
+    };
+};
+export declare type SkeletonProps = ExtractPropTypes<typeof skeletonProps>;
+export declare const roundInjectionKey: InjectionKey<Ref<boolean>>;
+export declare const animationInjectionKey: InjectionKey<Ref<boolean>>;

package/types/skeleton/src/skeleton.d.ts

@@ -0,0 +1,44 @@
+import './skeleton.scss';
+declare const _default: import("vue").DefineComponent<{
+    readonly rows: {
+        readonly type: NumberConstructor;
+        readonly default: 3;
+    };
+    readonly round: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly loading: {
+        readonly type: BooleanConstructor;
+        readonly default: true;
+    };
+    readonly showAnimation: {
+        readonly type: BooleanConstructor;
+        readonly default: true;
+    };
+}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>[] | JSX.Element | undefined, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    readonly rows: {
+        readonly type: NumberConstructor;
+        readonly default: 3;
+    };
+    readonly round: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly loading: {
+        readonly type: BooleanConstructor;
+        readonly default: true;
+    };
+    readonly showAnimation: {
+        readonly type: BooleanConstructor;
+        readonly default: true;
+    };
+}>>, {
+    readonly round: boolean;
+    readonly loading: boolean;
+    readonly showAnimation: boolean;
+    readonly rows: number;
+}>;
+export default _default;

package/types/slider/__tests__/slider.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/types/slider/index.d.ts

@@ -0,0 +1,11 @@
+import type { App } from 'vue';
+import Slider from './src/slider';
+export * from './src/slider-types';
+export { Slider };
+declare const _default: {
+    title: string;
+    category: string;
+    status: string;
+    install(app: App): void;
+};
+export default _default;

package/types/slider/src/slider-types.d.ts

@@ -0,0 +1,36 @@
+import type { ExtractPropTypes, PropType, Ref } from 'vue';
+export declare const sliderProps: {
+    readonly disabled: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly max: {
+        readonly type: NumberConstructor;
+        readonly default: 100;
+    };
+    readonly min: {
+        readonly type: NumberConstructor;
+        readonly default: 0;
+    };
+    readonly modelValue: {
+        readonly type: NumberConstructor;
+        readonly default: 0;
+    };
+    readonly step: {
+        readonly type: NumberConstructor;
+        readonly default: 1;
+    };
+    readonly tipsRenderer: {
+        readonly type: PropType<(val: number) => string | null>;
+        readonly default: () => (value: number) => string;
+    };
+};
+export declare type SliderProps = ExtractPropTypes<typeof sliderProps>;
+export interface UseSliderEvent {
+    sliderRunway: Ref<HTMLDivElement | undefined>;
+    popoverShow: Ref<boolean>;
+    percentDisplay: Ref<string>;
+    currentValue: Ref<number>;
+    handleRunwayMousedown: (e: MouseEvent) => void;
+    handleButtonMousedown: (e: MouseEvent) => void;
+}

package/types/slider/src/slider.d.ts

@@ -0,0 +1,60 @@
+import './slider.scss';
+declare const _default: import("vue").DefineComponent<{
+    readonly disabled: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly max: {
+        readonly type: NumberConstructor;
+        readonly default: 100;
+    };
+    readonly min: {
+        readonly type: NumberConstructor;
+        readonly default: 0;
+    };
+    readonly modelValue: {
+        readonly type: NumberConstructor;
+        readonly default: 0;
+    };
+    readonly step: {
+        readonly type: NumberConstructor;
+        readonly default: 1;
+    };
+    readonly tipsRenderer: {
+        readonly type: import("vue").PropType<(val: number) => string | null>;
+        readonly default: () => (value: number) => string;
+    };
+}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    readonly disabled: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly max: {
+        readonly type: NumberConstructor;
+        readonly default: 100;
+    };
+    readonly min: {
+        readonly type: NumberConstructor;
+        readonly default: 0;
+    };
+    readonly modelValue: {
+        readonly type: NumberConstructor;
+        readonly default: 0;
+    };
+    readonly step: {
+        readonly type: NumberConstructor;
+        readonly default: 1;
+    };
+    readonly tipsRenderer: {
+        readonly type: import("vue").PropType<(val: number) => string | null>;
+        readonly default: () => (value: number) => string;
+    };
+}>>, {
+    readonly max: number;
+    readonly disabled: boolean;
+    readonly step: number;
+    readonly min: number;
+    readonly modelValue: number;
+    readonly tipsRenderer: (val: number) => string | null;
+}>;
+export default _default;

package/types/slider/src/use-slider.d.ts

@@ -0,0 +1,3 @@
+import { SetupContext } from 'vue';
+import { SliderProps, UseSliderEvent } from './slider-types';
+export declare function useSliderEvent(props: SliderProps, ctx: SetupContext): UseSliderEvent;

package/types/splitter/__mocks__/event-helper.d.ts

@@ -0,0 +1,9 @@
+export declare function createMouseEvent(type: string, x?: number, y?: number): MouseEvent;
+export declare function dispatchMouseEvent(node: Node, type: string, x?: number, y?: number, event?: MouseEvent): void;
+export declare function mouseMoveTrigger(el: HTMLElement, from: {
+    x: number;
+    y: number;
+}, to: {
+    x: number;
+    y: number;
+}): void;

package/types/splitter/__tests__/splitter.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/types/splitter/index.d.ts

@@ -0,0 +1,11 @@
+import type { App } from 'vue';
+import Splitter from './src/splitter';
+export * from './src/splitter-types';
+export { Splitter };
+declare const _default: {
+    title: string;
+    category: string;
+    status: string;
+    install(app: App): void;
+};
+export default _default;

package/types/splitter/src/components/splitter-bar-types.d.ts

@@ -0,0 +1,38 @@
+import { PropType, ExtractPropTypes } from 'vue';
+import { SplitterOrientation } from '../splitter-types';
+export declare const splitterBarProps: {
+    /**
+     * 当前 pane 的索引
+     */
+    readonly index: {
+        readonly type: NumberConstructor;
+    };
+    /**
+     * 必选，指定 SplitterBar 的方向
+     */
+    readonly orientation: {
+        readonly type: PropType<SplitterOrientation>;
+        readonly required: true;
+    };
+    /**
+     * 分隔条大小
+     */
+    readonly splitBarSize: {
+        readonly type: StringConstructor;
+        readonly required: true;
+    };
+    /**
+     * 可选，pane 设置不可调整宽度时生效
+     */
+    readonly disabledBarSize: {
+        readonly type: StringConstructor;
+        readonly default: "1px";
+    };
+    /**
+     * 是否显示展开/收缩按钮
+     */
+    readonly showCollapseButton: {
+        readonly type: BooleanConstructor;
+    };
+};
+export declare type SplitterBarProps = ExtractPropTypes<typeof splitterBarProps>;

package/types/splitter/src/components/splitter-bar.d.ts

@@ -0,0 +1,44 @@
+import './splitter-bar.scss';
+declare const _default: import("vue").DefineComponent<{
+    readonly index: {
+        readonly type: NumberConstructor;
+    };
+    readonly orientation: {
+        readonly type: import("vue").PropType<import("../splitter-types").SplitterOrientation>;
+        readonly required: true;
+    };
+    readonly splitBarSize: {
+        readonly type: StringConstructor;
+        readonly required: true;
+    };
+    readonly disabledBarSize: {
+        readonly type: StringConstructor;
+        readonly default: "1px";
+    };
+    readonly showCollapseButton: {
+        readonly type: BooleanConstructor;
+    };
+}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    readonly index: {
+        readonly type: NumberConstructor;
+    };
+    readonly orientation: {
+        readonly type: import("vue").PropType<import("../splitter-types").SplitterOrientation>;
+        readonly required: true;
+    };
+    readonly splitBarSize: {
+        readonly type: StringConstructor;
+        readonly required: true;
+    };
+    readonly disabledBarSize: {
+        readonly type: StringConstructor;
+        readonly default: "1px";
+    };
+    readonly showCollapseButton: {
+        readonly type: BooleanConstructor;
+    };
+}>>, {
+    readonly disabledBarSize: string;
+    readonly showCollapseButton: boolean;
+}>;
+export default _default;

package/types/splitter/src/components/splitter-pane-types.d.ts

@@ -0,0 +1,66 @@
+import { ExtractPropTypes, PropType } from 'vue';
+import { CollapseDirection } from '../splitter-types';
+export declare const splitterPaneProps: {
+    /**
+     * 可选，指定 pane 宽度，设置像素值或者百分比
+     * pane初始化大小
+     */
+    readonly size: {
+        readonly type: StringConstructor;
+    };
+    /**
+     * 可选，指定 pane 最小宽度，设置像素值或者百分比
+     */
+    readonly minSize: {
+        readonly type: StringConstructor;
+    };
+    /**
+     * 可选，指定 pane 最大宽度，设置像素值或者百分比
+     */
+    readonly maxSize: {
+        readonly type: StringConstructor;
+    };
+    /**
+     * 可选，指定 pane 是否可调整大小，会影响相邻 pane
+     */
+    readonly resizable: {
+        readonly type: BooleanConstructor;
+        readonly default: true;
+    };
+    /**
+     * 可选，指定 pane 是否可折叠收起
+     */
+    readonly collapsible: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    /**
+     * 可选，指定 pane 初始化是否收起，配合 collapsible 使用
+     */
+    readonly collapsed: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    /**
+     * 非边缘面板折叠方向，before 只生成向前折叠的按钮，after 生成向后折叠按钮，both 生成两个
+     */
+    readonly collapseDirection: {
+        readonly type: PropType<CollapseDirection>;
+        readonly default: "both";
+    };
+    /**
+     * 可选，是否在 pane 进行折叠后收缩 pane 宽度而非收起
+     */
+    readonly shrink: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    /**
+     * 可选，折叠后收缩的 pane 宽度 （单位：px）
+     */
+    readonly shrinkWidth: {
+        readonly type: NumberConstructor;
+        readonly default: 36;
+    };
+};
+export declare type SplitterPaneProps = ExtractPropTypes<typeof splitterPaneProps>;