@wapri/element-pro 3.0.0

package/dist/Sidebar/components/SidebarItemContent.vue.d.ts

@@ -0,0 +1,27 @@
+import { SidebarIconRender } from '../types';
+
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+    /** 图标名称 */
+    icon?: string;
+    /** 菜单标题 */
+    title?: string;
+    /** 自定义图标渲染函数 */
+    renderIcon?: SidebarIconRender;
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+    /** 图标名称 */
+    icon?: string;
+    /** 菜单标题 */
+    title?: string;
+    /** 自定义图标渲染函数 */
+    renderIcon?: SidebarIconRender;
+}>>> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/Sidebar/components/SidebarLink.vue.d.ts

@@ -0,0 +1,54 @@
+import { Component } from 'vue';
+import { SidebarLinkTarget } from '../types';
+
+declare function __VLS_template(): {
+    default?(_: {}): any;
+};
+declare const __VLS_component: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    /** 跳转目标 */
+    to: SidebarLinkTarget;
+    /** 是否渲染为外链，不传时按 `to` 自动判断 */
+    external?: boolean;
+    /** 内部链接使用的组件，默认 `router-link` */
+    linkComponent?: string | Component;
+}>, {
+    external: undefined;
+    linkComponent: string;
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    /** 跳转目标 */
+    to: SidebarLinkTarget;
+    /** 是否渲染为外链，不传时按 `to` 自动判断 */
+    external?: boolean;
+    /** 内部链接使用的组件，默认 `router-link` */
+    linkComponent?: string | Component;
+}>, {
+    external: undefined;
+    linkComponent: string;
+}>>> & Readonly<{}>, {
+    external: boolean;
+    linkComponent: string | Component;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, ReturnType<typeof __VLS_template>>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/Sidebar/components/SidebarLogo.vue.d.ts

@@ -0,0 +1,48 @@
+import { SidebarLogoProps } from '../types';
+
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<SidebarLogoProps>, {
+    collapse: boolean;
+    grouped: boolean;
+    logo: string;
+    title: string;
+    subtitle: string;
+    portal: string;
+    to: string;
+    linkComponent: string;
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<SidebarLogoProps>, {
+    collapse: boolean;
+    grouped: boolean;
+    logo: string;
+    title: string;
+    subtitle: string;
+    portal: string;
+    to: string;
+    linkComponent: string;
+}>>> & Readonly<{}>, {
+    title: string;
+    grouped: boolean;
+    collapse: boolean;
+    to: import('../types').SidebarLinkTarget;
+    linkComponent: string | import('vue').Component;
+    logo: string;
+    subtitle: string;
+    portal: import('../types').SidebarPortal;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/Sidebar/composables/useActiveMenuScroll.d.ts

@@ -0,0 +1,18 @@
+import { Ref } from 'vue';
+
+export interface UseActiveMenuScrollOptions {
+    /** el-scrollbar 组件实例，`wrapRef` 在运行时可能已被 proxyRefs 解包 */
+    scrollbarRef: Ref<{
+        wrapRef?: unknown;
+    } | undefined>;
+    /** 当前激活菜单路径 */
+    activeMenu: Ref<string>;
+    /** 侧栏菜单数量，变化时重新对齐 */
+    menuCount: Ref<number>;
+    /** 侧栏是否折叠 */
+    collapse: Ref<boolean>;
+}
+/** 将激活菜单滚动到可视区域，并在切换菜单、折叠侧栏时保持对齐 */
+export declare function useActiveMenuScroll(options: UseActiveMenuScrollOptions): {
+    alignActiveMenu: () => void;
+};

package/dist/Sidebar/context.d.ts

@@ -0,0 +1,10 @@
+import { ComputedRef, CSSProperties, InjectionKey } from 'vue';
+
+/**
+ * 侧栏主题变量的样式对象。
+ * 折叠态浮层（分组浮层、经典子菜单浮层）会被 teleport 到 body，脱离侧栏根节点，
+ * 需要把同一份 CSS 变量挂到浮层根节点上，浮层内的配色才能与侧栏保持一致。
+ */
+export declare const sidebarThemeStyleKey: InjectionKey<ComputedRef<CSSProperties>>;
+/** 取侧栏主题变量样式对象，用于浮层根节点；不在 Sidebar 内使用时返回 undefined */
+export declare function useSidebarThemeStyle(): ComputedRef<CSSProperties> | undefined;

package/dist/Sidebar/index.d.ts

@@ -0,0 +1,350 @@
+export declare const Sidebar: import('../utils/install').SFCWithInstall<{
+    new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
+        title: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        mode: {
+            type: import('vue').PropType<import('./types').SidebarMode>;
+            default: string;
+        };
+        collapse: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+        renderIcon: {
+            type: import('vue').PropType<import('./types').SidebarIconRender>;
+        };
+        linkComponent: {
+            type: import('vue').PropType<string | import('vue').Component>;
+            default: string;
+        };
+        activeMenu: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        logo: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        subtitle: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        portal: {
+            type: import('vue').PropType<import('./types').SidebarPortal>;
+            default: string;
+        };
+        menus: {
+            type: import('vue').PropType<import('./types').SidebarMenuItem[]>;
+            default: () => never[];
+        };
+        theme: {
+            type: import('vue').PropType<import('./types').SidebarTheme>;
+            default: string;
+        };
+        variables: {
+            type: import('vue').PropType<import('./types').SidebarVariables>;
+        };
+        showLogo: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+        logoTo: {
+            type: import('vue').PropType<import('./types').SidebarLinkTarget>;
+            default: string;
+        };
+    }>> & Readonly<{}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {
+        title: string;
+        mode: import('./types').SidebarMode;
+        collapse: boolean;
+        linkComponent: string | import('vue').Component;
+        activeMenu: string;
+        logo: string;
+        subtitle: string;
+        portal: import('./types').SidebarPortal;
+        menus: import('./types').SidebarMenuItem[];
+        theme: import('./types').SidebarTheme;
+        showLogo: boolean;
+        logoTo: import('./types').SidebarLinkTarget;
+    }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<import('vue').ExtractPropTypes<{
+        title: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        mode: {
+            type: import('vue').PropType<import('./types').SidebarMode>;
+            default: string;
+        };
+        collapse: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+        renderIcon: {
+            type: import('vue').PropType<import('./types').SidebarIconRender>;
+        };
+        linkComponent: {
+            type: import('vue').PropType<string | import('vue').Component>;
+            default: string;
+        };
+        activeMenu: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        logo: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        subtitle: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        portal: {
+            type: import('vue').PropType<import('./types').SidebarPortal>;
+            default: string;
+        };
+        menus: {
+            type: import('vue').PropType<import('./types').SidebarMenuItem[]>;
+            default: () => never[];
+        };
+        theme: {
+            type: import('vue').PropType<import('./types').SidebarTheme>;
+            default: string;
+        };
+        variables: {
+            type: import('vue').PropType<import('./types').SidebarVariables>;
+        };
+        showLogo: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+        logoTo: {
+            type: import('vue').PropType<import('./types').SidebarLinkTarget>;
+            default: string;
+        };
+    }>> & Readonly<{}>, {}, {}, {}, {}, {
+        title: string;
+        mode: import('./types').SidebarMode;
+        collapse: boolean;
+        linkComponent: string | import('vue').Component;
+        activeMenu: string;
+        logo: string;
+        subtitle: string;
+        portal: import('./types').SidebarPortal;
+        menus: import('./types').SidebarMenuItem[];
+        theme: import('./types').SidebarTheme;
+        showLogo: boolean;
+        logoTo: import('./types').SidebarLinkTarget;
+    }>;
+    __isFragment?: never;
+    __isTeleport?: never;
+    __isSuspense?: never;
+} & import('vue').ComponentOptionsBase<Readonly<import('vue').ExtractPropTypes<{
+    title: {
+        type: import('vue').PropType<string>;
+        default: string;
+    };
+    mode: {
+        type: import('vue').PropType<import('./types').SidebarMode>;
+        default: string;
+    };
+    collapse: {
+        type: import('vue').PropType<boolean>;
+        default: boolean;
+    };
+    renderIcon: {
+        type: import('vue').PropType<import('./types').SidebarIconRender>;
+    };
+    linkComponent: {
+        type: import('vue').PropType<string | import('vue').Component>;
+        default: string;
+    };
+    activeMenu: {
+        type: import('vue').PropType<string>;
+        default: string;
+    };
+    logo: {
+        type: import('vue').PropType<string>;
+        default: string;
+    };
+    subtitle: {
+        type: import('vue').PropType<string>;
+        default: string;
+    };
+    portal: {
+        type: import('vue').PropType<import('./types').SidebarPortal>;
+        default: string;
+    };
+    menus: {
+        type: import('vue').PropType<import('./types').SidebarMenuItem[]>;
+        default: () => never[];
+    };
+    theme: {
+        type: import('vue').PropType<import('./types').SidebarTheme>;
+        default: string;
+    };
+    variables: {
+        type: import('vue').PropType<import('./types').SidebarVariables>;
+    };
+    showLogo: {
+        type: import('vue').PropType<boolean>;
+        default: boolean;
+    };
+    logoTo: {
+        type: import('vue').PropType<import('./types').SidebarLinkTarget>;
+        default: string;
+    };
+}>> & Readonly<{}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, {
+    title: string;
+    mode: import('./types').SidebarMode;
+    collapse: boolean;
+    linkComponent: string | import('vue').Component;
+    activeMenu: string;
+    logo: string;
+    subtitle: string;
+    portal: import('./types').SidebarPortal;
+    menus: import('./types').SidebarMenuItem[];
+    theme: import('./types').SidebarTheme;
+    showLogo: boolean;
+    logoTo: import('./types').SidebarLinkTarget;
+}, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
+    $slots: {
+        logo?(_: {
+            collapse: boolean;
+            grouped: boolean;
+        }): any;
+    };
+})> & Record<string, unknown>;
+/** 经典 el-menu 树形导航的递归菜单项，可在自定义 el-menu 布局中复用 */
+export declare const SidebarItem: import('../utils/install').SFCWithInstall<import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    renderIcon: {
+        type: import('vue').PropType<import('./types').SidebarIconRender>;
+    };
+    linkComponent: {
+        type: import('vue').PropType<string | import('vue').Component>;
+        default: string;
+    };
+    item: {
+        type: import('vue').PropType<import('./types').SidebarMenuItem>;
+        required: true;
+    };
+    isNest: {
+        type: import('vue').PropType<boolean>;
+        default: boolean;
+    };
+    basePath: {
+        type: import('vue').PropType<string>;
+        default: string;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    renderIcon: {
+        type: import('vue').PropType<import('./types').SidebarIconRender>;
+    };
+    linkComponent: {
+        type: import('vue').PropType<string | import('vue').Component>;
+        default: string;
+    };
+    item: {
+        type: import('vue').PropType<import('./types').SidebarMenuItem>;
+        required: true;
+    };
+    isNest: {
+        type: import('vue').PropType<boolean>;
+        default: boolean;
+    };
+    basePath: {
+        type: import('vue').PropType<string>;
+        default: string;
+    };
+}>> & Readonly<{}>, {
+    linkComponent: string | import('vue').Component;
+    isNest: boolean;
+    basePath: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>> & Record<string, unknown>;
+/** 侧栏品牌区，可在顶部导航等自定义布局中复用 */
+export declare const SidebarLogo: import('../utils/install').SFCWithInstall<import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    title: {
+        type: import('vue').PropType<string>;
+        default: string;
+    };
+    grouped: {
+        type: import('vue').PropType<boolean>;
+        default: boolean;
+    };
+    collapse: {
+        type: import('vue').PropType<boolean>;
+        default: boolean;
+    };
+    to: {
+        type: import('vue').PropType<import('./types').SidebarLinkTarget>;
+        default: string;
+    };
+    linkComponent: {
+        type: import('vue').PropType<string | import('vue').Component>;
+        default: string;
+    };
+    logo: {
+        type: import('vue').PropType<string>;
+        default: string;
+    };
+    subtitle: {
+        type: import('vue').PropType<string>;
+        default: string;
+    };
+    portal: {
+        type: import('vue').PropType<import('./types').SidebarPortal>;
+        default: string;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    title: {
+        type: import('vue').PropType<string>;
+        default: string;
+    };
+    grouped: {
+        type: import('vue').PropType<boolean>;
+        default: boolean;
+    };
+    collapse: {
+        type: import('vue').PropType<boolean>;
+        default: boolean;
+    };
+    to: {
+        type: import('vue').PropType<import('./types').SidebarLinkTarget>;
+        default: string;
+    };
+    linkComponent: {
+        type: import('vue').PropType<string | import('vue').Component>;
+        default: string;
+    };
+    logo: {
+        type: import('vue').PropType<string>;
+        default: string;
+    };
+    subtitle: {
+        type: import('vue').PropType<string>;
+        default: string;
+    };
+    portal: {
+        type: import('vue').PropType<import('./types').SidebarPortal>;
+        default: string;
+    };
+}>> & Readonly<{}>, {
+    title: string;
+    grouped: boolean;
+    collapse: boolean;
+    to: import('./types').SidebarLinkTarget;
+    linkComponent: string | import('vue').Component;
+    logo: string;
+    subtitle: string;
+    portal: import('./types').SidebarPortal;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>> & Record<string, unknown>;
+export type { SidebarItemProps, SidebarLogoProps } from './types';
+export type { SidebarIconRender, SidebarLinkInfo, SidebarLinkTarget, SidebarMenuMeta, SidebarMenuItem, SidebarMode, SidebarPortal, SidebarProps, SidebarTheme, SidebarVariables, } from './types';
+export default Sidebar;

package/dist/Sidebar/index.vue.d.ts

@@ -0,0 +1,72 @@
+import { SidebarProps, SidebarTheme } from './types';
+
+declare function __VLS_template(): {
+    logo?(_: {
+        collapse: boolean;
+        grouped: boolean;
+    }): any;
+};
+declare const __VLS_component: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<SidebarProps>, {
+    menus: () => never[];
+    activeMenu: string;
+    collapse: boolean;
+    mode: string;
+    theme: string;
+    showLogo: boolean;
+    logo: string;
+    title: string;
+    subtitle: string;
+    portal: string;
+    logoTo: string;
+    linkComponent: string;
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<SidebarProps>, {
+    menus: () => never[];
+    activeMenu: string;
+    collapse: boolean;
+    mode: string;
+    theme: string;
+    showLogo: boolean;
+    logo: string;
+    title: string;
+    subtitle: string;
+    portal: string;
+    logoTo: string;
+    linkComponent: string;
+}>>> & Readonly<{}>, {
+    title: string;
+    mode: import('./types').SidebarMode;
+    collapse: boolean;
+    linkComponent: string | import('vue').Component;
+    activeMenu: string;
+    logo: string;
+    subtitle: string;
+    portal: import('./types').SidebarPortal;
+    menus: import('./types').SidebarMenuItem[];
+    theme: SidebarTheme;
+    showLogo: boolean;
+    logoTo: import('./types').SidebarLinkTarget;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, ReturnType<typeof __VLS_template>>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};