@vtj/ui 0.5.2 → 0.6.0

package/types/components/action/Trigger.d.ts

@@ -0,0 +1,187 @@
+import { EpPropFinalized, Arrayable, EpPropMergeType } from 'element-plus/es/utils';
+import { ElTooltipProps, BadgeProps, TooltipTriggerType, Placement, Options, ButtonProps } from 'element-plus';
+import { ActionMode, ActionMenuItem } from './types';
+import { IconParam, BaseSize, BaseType } from '..';
+import { DefineComponent, PropType, ExtractPropTypes, ComponentOptionsMixin, VNodeProps, AllowedComponentProps, ComponentCustomProps } from 'vue';
+declare const _default: DefineComponent<{
+    name: {
+        type: StringConstructor;
+    };
+    label: {
+        type: StringConstructor;
+    };
+    value: {
+        type: PropType<unknown>;
+    };
+    icon: {
+        type: PropType<IconParam>;
+    };
+    mode: {
+        type: PropType<ActionMode>;
+        default: string;
+    };
+    menus: {
+        type: PropType<ActionMenuItem[]>;
+    };
+    tooltip: {
+        type: PropType<string | Partial<ElTooltipProps>>;
+    };
+    badge: {
+        type: PropType<string | number | Partial<BadgeProps>>;
+    };
+    dropdown: {
+        type: PropType<Partial<ExtractPropTypes<{
+            readonly trigger: EpPropFinalized<(new (...args: any[]) => "click" | "hover" | "focus" | "contextmenu" | TooltipTriggerType[]) | (() => Arrayable<TooltipTriggerType>) | ((new (...args: any[]) => "click" | "hover" | "focus" | "contextmenu" | TooltipTriggerType[]) | (() => Arrayable<TooltipTriggerType>))[], unknown, unknown, "hover", boolean>;
+            readonly effect: {
+                readonly default: "light";
+                readonly type: PropType<string>;
+                readonly required: false;
+                readonly validator: ((val: unknown) => boolean) | undefined;
+                readonly __epPropKey: true;
+            };
+            readonly type: {
+                readonly type: PropType<EpPropMergeType<(new (...args: any[]) => "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text") | (() => EpPropMergeType<StringConstructor, "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text", unknown>) | ((new (...args: any[]) => "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text") | (() => EpPropMergeType<StringConstructor, "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text", unknown>))[], unknown, unknown>>;
+                readonly required: false;
+                readonly validator: ((val: unknown) => boolean) | undefined;
+                __epPropKey: true;
+            };
+            readonly placement: EpPropFinalized<(new (...args: any[]) => "right" | "left" | "auto" | "auto-start" | "auto-end" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end") | (() => Placement) | ((new (...args: any[]) => "right" | "left" | "auto" | "auto-start" | "auto-end" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end") | (() => Placement))[], unknown, unknown, "bottom", boolean>;
+            readonly popperOptions: EpPropFinalized<(new (...args: any[]) => Partial<Options>) | (() => Partial<Options>) | ((new (...args: any[]) => Partial<Options>) | (() => Partial<Options>))[], unknown, unknown, () => {}, boolean>;
+            readonly id: StringConstructor;
+            readonly size: EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+            readonly splitButton: BooleanConstructor;
+            readonly hideOnClick: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+            readonly loop: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+            readonly showTimeout: EpPropFinalized<NumberConstructor, unknown, unknown, 150, boolean>;
+            readonly hideTimeout: EpPropFinalized<NumberConstructor, unknown, unknown, 150, boolean>;
+            readonly tabindex: EpPropFinalized<(new (...args: any[]) => string | number) | (() => string | number) | ((new (...args: any[]) => string | number) | (() => string | number))[], unknown, unknown, 0, boolean>;
+            readonly maxHeight: EpPropFinalized<(new (...args: any[]) => string | number) | (() => string | number) | ((new (...args: any[]) => string | number) | (() => string | number))[], unknown, unknown, "", boolean>;
+            readonly popperClass: EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+            readonly disabled: EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
+            readonly role: EpPropFinalized<StringConstructor, unknown, unknown, "menu", boolean>;
+            readonly buttonProps: {
+                readonly type: PropType<ButtonProps>;
+                readonly required: false;
+                readonly validator: ((val: unknown) => boolean) | undefined;
+                __epPropKey: true;
+            };
+            readonly teleported: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+        }>>>;
+    };
+    button: {
+        type: PropType<Partial<ButtonProps>>;
+    };
+    disabled: {
+        type: PropType<boolean | (() => boolean)>;
+    };
+    size: {
+        type: PropType<BaseSize>;
+        default: string;
+    };
+    type: {
+        type: PropType<BaseType>;
+        default: string;
+    };
+    background: {
+        type: PropType<"hover" | "always">;
+        default: string;
+    };
+    circle: {
+        type: BooleanConstructor;
+    };
+}, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, "click"[], "click", VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+    };
+    label: {
+        type: StringConstructor;
+    };
+    value: {
+        type: PropType<unknown>;
+    };
+    icon: {
+        type: PropType<IconParam>;
+    };
+    mode: {
+        type: PropType<ActionMode>;
+        default: string;
+    };
+    menus: {
+        type: PropType<ActionMenuItem[]>;
+    };
+    tooltip: {
+        type: PropType<string | Partial<ElTooltipProps>>;
+    };
+    badge: {
+        type: PropType<string | number | Partial<BadgeProps>>;
+    };
+    dropdown: {
+        type: PropType<Partial<ExtractPropTypes<{
+            readonly trigger: EpPropFinalized<(new (...args: any[]) => "click" | "hover" | "focus" | "contextmenu" | TooltipTriggerType[]) | (() => Arrayable<TooltipTriggerType>) | ((new (...args: any[]) => "click" | "hover" | "focus" | "contextmenu" | TooltipTriggerType[]) | (() => Arrayable<TooltipTriggerType>))[], unknown, unknown, "hover", boolean>;
+            readonly effect: {
+                readonly default: "light";
+                readonly type: PropType<string>;
+                readonly required: false;
+                readonly validator: ((val: unknown) => boolean) | undefined;
+                readonly __epPropKey: true;
+            };
+            readonly type: {
+                readonly type: PropType<EpPropMergeType<(new (...args: any[]) => "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text") | (() => EpPropMergeType<StringConstructor, "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text", unknown>) | ((new (...args: any[]) => "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text") | (() => EpPropMergeType<StringConstructor, "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text", unknown>))[], unknown, unknown>>;
+                readonly required: false;
+                readonly validator: ((val: unknown) => boolean) | undefined;
+                __epPropKey: true;
+            };
+            readonly placement: EpPropFinalized<(new (...args: any[]) => "right" | "left" | "auto" | "auto-start" | "auto-end" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end") | (() => Placement) | ((new (...args: any[]) => "right" | "left" | "auto" | "auto-start" | "auto-end" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end") | (() => Placement))[], unknown, unknown, "bottom", boolean>;
+            readonly popperOptions: EpPropFinalized<(new (...args: any[]) => Partial<Options>) | (() => Partial<Options>) | ((new (...args: any[]) => Partial<Options>) | (() => Partial<Options>))[], unknown, unknown, () => {}, boolean>;
+            readonly id: StringConstructor;
+            readonly size: EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+            readonly splitButton: BooleanConstructor;
+            readonly hideOnClick: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+            readonly loop: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+            readonly showTimeout: EpPropFinalized<NumberConstructor, unknown, unknown, 150, boolean>;
+            readonly hideTimeout: EpPropFinalized<NumberConstructor, unknown, unknown, 150, boolean>;
+            readonly tabindex: EpPropFinalized<(new (...args: any[]) => string | number) | (() => string | number) | ((new (...args: any[]) => string | number) | (() => string | number))[], unknown, unknown, 0, boolean>;
+            readonly maxHeight: EpPropFinalized<(new (...args: any[]) => string | number) | (() => string | number) | ((new (...args: any[]) => string | number) | (() => string | number))[], unknown, unknown, "", boolean>;
+            readonly popperClass: EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+            readonly disabled: EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
+            readonly role: EpPropFinalized<StringConstructor, unknown, unknown, "menu", boolean>;
+            readonly buttonProps: {
+                readonly type: PropType<ButtonProps>;
+                readonly required: false;
+                readonly validator: ((val: unknown) => boolean) | undefined;
+                __epPropKey: true;
+            };
+            readonly teleported: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+        }>>>;
+    };
+    button: {
+        type: PropType<Partial<ButtonProps>>;
+    };
+    disabled: {
+        type: PropType<boolean | (() => boolean)>;
+    };
+    size: {
+        type: PropType<BaseSize>;
+        default: string;
+    };
+    type: {
+        type: PropType<BaseType>;
+        default: string;
+    };
+    background: {
+        type: PropType<"hover" | "always">;
+        default: string;
+    };
+    circle: {
+        type: BooleanConstructor;
+    };
+}>> & {
+    onClick?: ((...args: any[]) => any) | undefined;
+}, {
+    type: BaseType;
+    size: BaseSize;
+    circle: boolean;
+    mode: ActionMode;
+    background: "hover" | "always";
+}, {}>;
+export default _default;

package/types/components/action/hooks.d.ts

@@ -0,0 +1,43 @@
+import { EpPropFinalized, Arrayable, EpPropMergeType } from 'element-plus/es/utils';
+import { ComputedRef, ExtractPropTypes, PropType } from 'vue';
+import { TooltipTriggerType, Placement, Options, ButtonProps, ElTooltipProps, BadgeProps } from 'element-plus';
+import { ActionProps } from './types';
+export declare function useTooltip(props: ActionProps): ComputedRef<Partial<ElTooltipProps> | undefined>;
+export declare function useBadge(props: ActionProps): ComputedRef<Partial<BadgeProps> | undefined>;
+export declare function useDropdown(props: ActionProps): ComputedRef<Partial<ExtractPropTypes<{
+    readonly trigger: EpPropFinalized<(new (...args: any[]) => "click" | "hover" | "focus" | "contextmenu" | TooltipTriggerType[]) | (() => Arrayable<TooltipTriggerType>) | ((new (...args: any[]) => "click" | "hover" | "focus" | "contextmenu" | TooltipTriggerType[]) | (() => Arrayable<TooltipTriggerType>))[], unknown, unknown, "hover", boolean>;
+    readonly effect: {
+        readonly default: "light";
+        readonly type: PropType<string>;
+        readonly required: false;
+        readonly validator: ((val: unknown) => boolean) | undefined;
+        readonly __epPropKey: true;
+    };
+    readonly type: {
+        readonly type: PropType<EpPropMergeType<(new (...args: any[]) => "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text") | (() => EpPropMergeType<StringConstructor, "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text", unknown>) | ((new (...args: any[]) => "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text") | (() => EpPropMergeType<StringConstructor, "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text", unknown>))[], unknown, unknown>>;
+        readonly required: false;
+        readonly validator: ((val: unknown) => boolean) | undefined;
+        __epPropKey: true;
+    };
+    readonly placement: EpPropFinalized<(new (...args: any[]) => "right" | "left" | "auto" | "auto-start" | "auto-end" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end") | (() => Placement) | ((new (...args: any[]) => "right" | "left" | "auto" | "auto-start" | "auto-end" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end") | (() => Placement))[], unknown, unknown, "bottom", boolean>;
+    readonly popperOptions: EpPropFinalized<(new (...args: any[]) => Partial<Options>) | (() => Partial<Options>) | ((new (...args: any[]) => Partial<Options>) | (() => Partial<Options>))[], unknown, unknown, () => {}, boolean>;
+    readonly id: StringConstructor;
+    readonly size: EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+    readonly splitButton: BooleanConstructor;
+    readonly hideOnClick: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+    readonly loop: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+    readonly showTimeout: EpPropFinalized<NumberConstructor, unknown, unknown, 150, boolean>;
+    readonly hideTimeout: EpPropFinalized<NumberConstructor, unknown, unknown, 150, boolean>;
+    readonly tabindex: EpPropFinalized<(new (...args: any[]) => string | number) | (() => string | number) | ((new (...args: any[]) => string | number) | (() => string | number))[], unknown, unknown, 0, boolean>;
+    readonly maxHeight: EpPropFinalized<(new (...args: any[]) => string | number) | (() => string | number) | ((new (...args: any[]) => string | number) | (() => string | number))[], unknown, unknown, "", boolean>;
+    readonly popperClass: EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+    readonly disabled: EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
+    readonly role: EpPropFinalized<StringConstructor, unknown, unknown, "menu", boolean>;
+    readonly buttonProps: {
+        readonly type: PropType<ButtonProps>;
+        readonly required: false;
+        readonly validator: ((val: unknown) => boolean) | undefined;
+        __epPropKey: true;
+    };
+    readonly teleported: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+}>> | undefined>;

package/types/components/action/index.d.ts

@@ -0,0 +1,3 @@
+import XAction from "./Action";
+export { XAction };
+export * from './types';

package/types/components/action/types.d.ts

@@ -0,0 +1,151 @@
+import { EpPropFinalized, Arrayable, EpPropMergeType } from 'element-plus/es/utils';
+import { PropType, ExtractPropTypes } from 'vue';
+import { TooltipTriggerType, Placement, Options, ElTooltipProps, BadgeProps, dropdownProps, ButtonProps } from 'element-plus';
+import { ComponentPropsType, BaseSize, BaseType } from '../shared';
+import { IconParam } from '../icon';
+export type ActionMode = 'button' | 'text' | 'icon';
+export interface ActionMenuItem {
+    command: string | number | object;
+    disabled?: boolean;
+    divided?: boolean;
+    icon?: IconParam;
+    label?: string;
+}
+export type ActionDropdown = Partial<ExtractPropTypes<typeof dropdownProps>>;
+export declare const actionProps: {
+    /**
+     * 动作名称标识
+     */
+    name: {
+        type: StringConstructor;
+    };
+    /**
+     * 动作标题文本
+     */
+    label: {
+        type: StringConstructor;
+    };
+    /**
+     * 动作值，用来传输数据
+     */
+    value: {
+        type: PropType<unknown>;
+    };
+    /**
+     *  图标配置
+     */
+    icon: {
+        type: PropType<IconParam>;
+    };
+    /**
+     * 模式
+     */
+    mode: {
+        type: PropType<ActionMode>;
+        default: string;
+    };
+    /**
+     * 下拉菜单配置
+     */
+    menus: {
+        type: PropType<ActionMenuItem[]>;
+    };
+    /**
+     *  tooltip 配置
+     */
+    tooltip: {
+        type: PropType<string | Partial<ElTooltipProps>>;
+    };
+    /**
+     * Badge 配置
+     */
+    badge: {
+        type: PropType<string | number | Partial<BadgeProps>>;
+    };
+    /**
+     * ElDropdown 组件配置
+     */
+    dropdown: {
+        type: PropType<Partial<ExtractPropTypes<{
+            readonly trigger: EpPropFinalized<(new (...args: any[]) => "click" | "hover" | "focus" | "contextmenu" | TooltipTriggerType[]) | (() => Arrayable<TooltipTriggerType>) | ((new (...args: any[]) => "click" | "hover" | "focus" | "contextmenu" | TooltipTriggerType[]) | (() => Arrayable<TooltipTriggerType>))[], unknown, unknown, "hover", boolean>;
+            readonly effect: {
+                readonly default: "light";
+                readonly type: PropType<string>;
+                readonly required: false;
+                readonly validator: ((val: unknown) => boolean) | undefined;
+                readonly __epPropKey: true;
+            };
+            readonly type: {
+                readonly type: PropType<EpPropMergeType<(new (...args: any[]) => "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text") | (() => EpPropMergeType<StringConstructor, "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text", unknown>) | ((new (...args: any[]) => "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text") | (() => EpPropMergeType<StringConstructor, "" | "success" | "warning" | "info" | "primary" | "danger" | "default" | "text", unknown>))[], unknown, unknown>>;
+                readonly required: false;
+                readonly validator: ((val: unknown) => boolean) | undefined;
+                __epPropKey: true;
+            };
+            readonly placement: EpPropFinalized<(new (...args: any[]) => "right" | "left" | "auto" | "auto-start" | "auto-end" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end") | (() => Placement) | ((new (...args: any[]) => "right" | "left" | "auto" | "auto-start" | "auto-end" | "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end") | (() => Placement))[], unknown, unknown, "bottom", boolean>;
+            readonly popperOptions: EpPropFinalized<(new (...args: any[]) => Partial<Options>) | (() => Partial<Options>) | ((new (...args: any[]) => Partial<Options>) | (() => Partial<Options>))[], unknown, unknown, () => {}, boolean>;
+            readonly id: StringConstructor;
+            readonly size: EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+            readonly splitButton: BooleanConstructor;
+            readonly hideOnClick: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+            readonly loop: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+            readonly showTimeout: EpPropFinalized<NumberConstructor, unknown, unknown, 150, boolean>;
+            readonly hideTimeout: EpPropFinalized<NumberConstructor, unknown, unknown, 150, boolean>;
+            readonly tabindex: EpPropFinalized<(new (...args: any[]) => string | number) | (() => string | number) | ((new (...args: any[]) => string | number) | (() => string | number))[], unknown, unknown, 0, boolean>;
+            readonly maxHeight: EpPropFinalized<(new (...args: any[]) => string | number) | (() => string | number) | ((new (...args: any[]) => string | number) | (() => string | number))[], unknown, unknown, "", boolean>;
+            readonly popperClass: EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+            readonly disabled: EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
+            readonly role: EpPropFinalized<StringConstructor, unknown, unknown, "menu", boolean>;
+            readonly buttonProps: {
+                readonly type: PropType<ButtonProps>;
+                readonly required: false;
+                readonly validator: ((val: unknown) => boolean) | undefined;
+                __epPropKey: true;
+            };
+            readonly teleported: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+        }>>>;
+    };
+    /**
+     * ElButton 组件配置，mode为button时有效
+     */
+    button: {
+        type: PropType<Partial<ButtonProps>>;
+    };
+    /**
+     * 禁用
+     */
+    disabled: {
+        type: PropType<boolean | (() => boolean)>;
+    };
+    /**
+     * 尺寸
+     */
+    size: {
+        type: PropType<BaseSize>;
+        default: string;
+    };
+    /**
+     * 颜色类型
+     */
+    type: {
+        type: PropType<BaseType>;
+        default: string;
+    };
+    /**
+     * icon 背景设置，当 mode为 icon 时有效
+     */
+    background: {
+        type: PropType<"hover" | "always">;
+        default: string;
+    };
+    /**
+     * icon 背景样式圆形，当 mode为 icon 时有效
+     */
+    circle: {
+        type: BooleanConstructor;
+    };
+};
+export type ActionProps = ComponentPropsType<typeof actionProps>;
+export type ActionEmits = {
+    click: [props: ActionProps];
+    command: [item: ActionMenuItem];
+};