vsoft-ui 1.0.1

package/README.md

@@ -0,0 +1,126 @@
+# VS UI
+
+一个基于 Element Plus 的 Vue 3 组件库。
+
+## 特性
+
+- 🎨 基于 Element Plus，API 保持一致
+- ⚡️ Vue 3 Composition API
+- 📦 TypeScript 支持
+- 🎯 按需引入
+- 📱 响应式设计
+- 🔐 **全局权限管理系统** - 所有组件支持权限控制
+
+## 安装
+
+```bash
+# 使用 pnpm（推荐）
+pnpm add vsoft-ui
+
+# 使用 npm
+npm install vsoft-ui
+
+# 使用 yarn
+yarn add vsoft-ui
+```
+
+## 快速开始
+
+### 安装
+
+```bash
+# 使用 pnpm（推荐）
+pnpm add vsoft-ui
+
+# 使用 npm
+npm install vsoft-ui
+
+# 使用 yarn
+yarn add vsoft-ui
+```
+
+### 完整引入
+
+```javascript
+import { createApp } from 'vue'
+import App from './App.vue'
+import VsUI from 'vsoft-ui'
+import 'vsoft-ui/style.css'
+
+const app = createApp(App)
+
+// 初始化权限（可选）
+app.use(VsUI, {
+  permissions: ['user:view', 'user:edit', 'user:delete']
+})
+
+app.mount('#app')
+```
+
+### 按需引入
+
+```vue
+<template>
+  <vs-button type="primary">按钮</vs-button>
+</template>
+
+<script setup>
+import { VsButton } from 'vsoft-ui'
+</script>
+```
+
+> 📖 更多使用示例请查看 [USAGE.md](./USAGE.md)
+
+## 开发
+
+```bash
+# 安装依赖
+pnpm install
+
+# 启动开发服务器
+pnpm dev
+
+# 构建组件库
+pnpm build
+
+# 启动文档开发服务器
+pnpm dev:docs
+
+# 构建文档
+pnpm build:docs
+```
+
+## 项目结构
+
+```
+vs-ui/
+├── src/                    # 组件库源码
+│   ├── components/         # 组件目录
+│   ├── install.ts         # 安装函数
+│   └── index.ts           # 入口文件
+├── docs/                   # VitePress 文档
+│   ├── .vitepress/        # VitePress 配置
+│   ├── guide/             # 指南文档
+│   └── components/        # 组件文档
+├── dist/                   # 构建输出目录
+├── vite.config.ts         # Vite 配置
+├── tsconfig.json          # TypeScript 配置
+└── package.json           # 项目配置
+```
+
+## 组件列表
+
+- Button 按钮
+- Card 卡片
+- Table 表格（支持后端控制列显示/隐藏、排序和权限控制）
+
+更多组件正在开发中...
+
+## 浏览器支持
+
+现代浏览器和 IE11+（需要 polyfills）
+
+## 许可证
+
+MIT
+

package/dist/components/button/index.vue.d.ts

@@ -0,0 +1,56 @@
+export interface ButtonProps {
+    type?: 'default' | 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'text';
+    size?: 'large' | 'default' | 'small';
+    disabled?: boolean;
+    loading?: boolean;
+    /** 权限标识 */
+    permission?: string | string[];
+}
+declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ButtonProps>, {
+    type: string;
+    size: string;
+    disabled: boolean;
+    loading: boolean;
+    permission: undefined;
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    click: (event: MouseEvent) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ButtonProps>, {
+    type: string;
+    size: string;
+    disabled: boolean;
+    loading: boolean;
+    permission: undefined;
+}>>> & Readonly<{
+    onClick?: ((event: MouseEvent) => any) | undefined;
+}>, {
+    permission: string | string[];
+    size: "large" | "default" | "small";
+    type: "default" | "primary" | "success" | "warning" | "danger" | "info" | "text";
+    disabled: boolean;
+    loading: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>, {
+    default?(_: {}): 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];
+} & {};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/card/index.vue.d.ts

@@ -0,0 +1,45 @@
+import { CSSProperties } from 'vue';
+
+export interface CardProps {
+    header?: string;
+    shadow?: 'always' | 'hover' | 'never';
+    bodyStyle?: CSSProperties;
+    /** 权限标识 */
+    permission?: string | string[];
+}
+declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<CardProps>, {
+    shadow: string;
+    permission: undefined;
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<CardProps>, {
+    shadow: string;
+    permission: undefined;
+}>>> & Readonly<{}>, {
+    permission: string | string[];
+    shadow: "always" | "hover" | "never";
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>, {
+    header?(_: {}): any;
+    default?(_: {}): 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];
+} & {};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/index.d.ts

@@ -0,0 +1,436 @@
+import { default as VsButton } from './button/index.vue';
+import { default as VsCard } from './card/index.vue';
+import { default as VsTable } from './table/index.vue';
+import { default as VsPagination } from './pagination/index.vue';
+
+export { VsButton, VsCard, VsTable, VsPagination };
+export type { BackendColumnConfig, TableProps, TableEmits, PermissionChecker } from './table/types';
+export { usePermission, PermissionService, createPermissionService } from '../permission';
+export type { InstallOptions } from '../install';
+declare const _default: {
+    VsButton: {
+        new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
+            permission: {
+                type: import('vue').PropType<string | string[]>;
+                default: undefined;
+            };
+            size: {
+                type: import('vue').PropType<"default" | "large" | "small">;
+                default: string;
+            };
+            type: {
+                type: import('vue').PropType<"default" | "primary" | "success" | "warning" | "danger" | "info" | "text">;
+                default: string;
+            };
+            disabled: {
+                type: import('vue').PropType<boolean>;
+                default: boolean;
+            };
+            loading: {
+                type: import('vue').PropType<boolean>;
+                default: boolean;
+            };
+        }>> & Readonly<{
+            onClick?: ((event: MouseEvent) => any) | undefined;
+        }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+            click: (event: MouseEvent) => void;
+        }, import('vue').PublicProps, {
+            permission: string | string[];
+            size: "large" | "default" | "small";
+            type: "default" | "primary" | "success" | "warning" | "danger" | "info" | "text";
+            disabled: boolean;
+            loading: boolean;
+        }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import('vue').ExtractPropTypes<{
+            permission: {
+                type: import('vue').PropType<string | string[]>;
+                default: undefined;
+            };
+            size: {
+                type: import('vue').PropType<"default" | "large" | "small">;
+                default: string;
+            };
+            type: {
+                type: import('vue').PropType<"default" | "primary" | "success" | "warning" | "danger" | "info" | "text">;
+                default: string;
+            };
+            disabled: {
+                type: import('vue').PropType<boolean>;
+                default: boolean;
+            };
+            loading: {
+                type: import('vue').PropType<boolean>;
+                default: boolean;
+            };
+        }>> & Readonly<{
+            onClick?: ((event: MouseEvent) => any) | undefined;
+        }>, {}, {}, {}, {}, {
+            permission: string | string[];
+            size: "large" | "default" | "small";
+            type: "default" | "primary" | "success" | "warning" | "danger" | "info" | "text";
+            disabled: boolean;
+            loading: boolean;
+        }>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import('vue').ComponentOptionsBase<Readonly<import('vue').ExtractPropTypes<{
+        permission: {
+            type: import('vue').PropType<string | string[]>;
+            default: undefined;
+        };
+        size: {
+            type: import('vue').PropType<"default" | "large" | "small">;
+            default: string;
+        };
+        type: {
+            type: import('vue').PropType<"default" | "primary" | "success" | "warning" | "danger" | "info" | "text">;
+            default: string;
+        };
+        disabled: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+        loading: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+    }>> & Readonly<{
+        onClick?: ((event: MouseEvent) => any) | undefined;
+    }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        click: (event: MouseEvent) => void;
+    }, string, {
+        permission: string | string[];
+        size: "large" | "default" | "small";
+        type: "default" | "primary" | "success" | "warning" | "danger" | "info" | "text";
+        disabled: boolean;
+        loading: boolean;
+    }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
+        $slots: {
+            default?(_: {}): any;
+        };
+    });
+    VsCard: {
+        new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
+            permission: {
+                type: import('vue').PropType<string | string[]>;
+                default: undefined;
+            };
+            header: {
+                type: import('vue').PropType<string>;
+            };
+            shadow: {
+                type: import('vue').PropType<"always" | "hover" | "never">;
+                default: string;
+            };
+            bodyStyle: {
+                type: import('vue').PropType<import('vue').CSSProperties>;
+            };
+        }>> & Readonly<{}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {
+            permission: string | string[];
+            shadow: "always" | "hover" | "never";
+        }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import('vue').ExtractPropTypes<{
+            permission: {
+                type: import('vue').PropType<string | string[]>;
+                default: undefined;
+            };
+            header: {
+                type: import('vue').PropType<string>;
+            };
+            shadow: {
+                type: import('vue').PropType<"always" | "hover" | "never">;
+                default: string;
+            };
+            bodyStyle: {
+                type: import('vue').PropType<import('vue').CSSProperties>;
+            };
+        }>> & Readonly<{}>, {}, {}, {}, {}, {
+            permission: string | string[];
+            shadow: "always" | "hover" | "never";
+        }>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import('vue').ComponentOptionsBase<Readonly<import('vue').ExtractPropTypes<{
+        permission: {
+            type: import('vue').PropType<string | string[]>;
+            default: undefined;
+        };
+        header: {
+            type: import('vue').PropType<string>;
+        };
+        shadow: {
+            type: import('vue').PropType<"always" | "hover" | "never">;
+            default: string;
+        };
+        bodyStyle: {
+            type: import('vue').PropType<import('vue').CSSProperties>;
+        };
+    }>> & Readonly<{}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, {
+        permission: string | string[];
+        shadow: "always" | "hover" | "never";
+    }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
+        $slots: {
+            header?(_: {}): any;
+            default?(_: {}): any;
+        };
+    });
+    VsTable: {
+        new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
+            [x: string]: {
+                type: import('vue').PropType<any>;
+            };
+            [x: number]: {
+                type: import('vue').PropType<any>;
+            };
+        }>> & Readonly<{}>, {
+            tableRef: import('vue').Ref<import('element-plus').TableInstance | undefined, import('element-plus').TableInstance | undefined>;
+            clearSort: () => void | undefined;
+            clearFilter: (columnKeys?: string[]) => void | undefined;
+            doLayout: () => void | undefined;
+            scrollTo: (options: ScrollToOptions | number, yCoord?: number) => void | undefined;
+            setScrollTop: (top: number) => void | undefined;
+            setScrollLeft: (left: number) => void | undefined;
+        }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {}, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import('vue').ExtractPropTypes<{
+            [x: string]: {
+                type: import('vue').PropType<any>;
+            };
+            [x: number]: {
+                type: import('vue').PropType<any>;
+            };
+        }>> & Readonly<{}>, {
+            tableRef: import('vue').Ref<import('element-plus').TableInstance | undefined, import('element-plus').TableInstance | undefined>;
+            clearSort: () => void | undefined;
+            clearFilter: (columnKeys?: string[]) => void | undefined;
+            doLayout: () => void | undefined;
+            scrollTo: (options: ScrollToOptions | number, yCoord?: number) => void | undefined;
+            setScrollTop: (top: number) => void | undefined;
+            setScrollLeft: (left: number) => void | undefined;
+        }, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import('vue').ComponentOptionsBase<Readonly<import('vue').ExtractPropTypes<{
+        [x: string]: {
+            type: import('vue').PropType<any>;
+        };
+        [x: number]: {
+            type: import('vue').PropType<any>;
+        };
+    }>> & Readonly<{}>, {
+        tableRef: import('vue').Ref<import('element-plus').TableInstance | undefined, import('element-plus').TableInstance | undefined>;
+        clearSort: () => void | undefined;
+        clearFilter: (columnKeys?: string[]) => void | undefined;
+        doLayout: () => void | undefined;
+        scrollTo: (options: ScrollToOptions | number, yCoord?: number) => void | undefined;
+        setScrollTop: (top: number) => void | undefined;
+        setScrollLeft: (left: number) => void | undefined;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, {}, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
+        $slots: Partial<Record<any, (_: {
+            column: any;
+            index: any;
+        }) => any>> & Partial<Record<any, (_: {
+            row: any;
+            column: any;
+            index: any;
+        }) => any>> & {
+            default?(_: {
+                row: any;
+                column: any;
+                index: any;
+            }): any;
+        };
+    });
+    VsPagination: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        permission: {
+            type: import('vue').PropType<string | string[]>;
+            default: undefined;
+        };
+        size: {
+            type: import('vue').PropType<"default" | "large" | "small">;
+            default: string;
+        };
+        disabled: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+        currentPage: {
+            type: import('vue').PropType<number>;
+            default: number;
+        };
+        pageSize: {
+            type: import('vue').PropType<number>;
+            default: number;
+        };
+        total: {
+            type: import('vue').PropType<number>;
+            default: number;
+        };
+        pageCount: {
+            type: import('vue').PropType<number>;
+            default: undefined;
+        };
+        pageSizes: {
+            type: import('vue').PropType<number[]>;
+            default: () => number[];
+        };
+        layout: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        pagerCount: {
+            type: import('vue').PropType<number>;
+            default: number;
+        };
+        background: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+        hideOnSinglePage: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+        prevText: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        prevIcon: {
+            type: import('vue').PropType<string | import('vue').Component>;
+            default: undefined;
+        };
+        nextText: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        nextIcon: {
+            type: import('vue').PropType<string | import('vue').Component>;
+            default: undefined;
+        };
+        teleported: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+    }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        "update:currentPage": (page: number) => void;
+        "update:pageSize": (size: number) => void;
+        "current-change": (page: number) => void;
+        "size-change": (size: number) => void;
+        "prev-click": (page: number) => void;
+        "next-click": (page: number) => void;
+    }, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        permission: {
+            type: import('vue').PropType<string | string[]>;
+            default: undefined;
+        };
+        size: {
+            type: import('vue').PropType<"default" | "large" | "small">;
+            default: string;
+        };
+        disabled: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+        currentPage: {
+            type: import('vue').PropType<number>;
+            default: number;
+        };
+        pageSize: {
+            type: import('vue').PropType<number>;
+            default: number;
+        };
+        total: {
+            type: import('vue').PropType<number>;
+            default: number;
+        };
+        pageCount: {
+            type: import('vue').PropType<number>;
+            default: undefined;
+        };
+        pageSizes: {
+            type: import('vue').PropType<number[]>;
+            default: () => number[];
+        };
+        layout: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        pagerCount: {
+            type: import('vue').PropType<number>;
+            default: number;
+        };
+        background: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+        hideOnSinglePage: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+        prevText: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        prevIcon: {
+            type: import('vue').PropType<string | import('vue').Component>;
+            default: undefined;
+        };
+        nextText: {
+            type: import('vue').PropType<string>;
+            default: string;
+        };
+        nextIcon: {
+            type: import('vue').PropType<string | import('vue').Component>;
+            default: undefined;
+        };
+        teleported: {
+            type: import('vue').PropType<boolean>;
+            default: boolean;
+        };
+    }>> & Readonly<{
+        "onUpdate:currentPage"?: ((page: number) => any) | undefined;
+        "onUpdate:pageSize"?: ((size: number) => any) | undefined;
+        "onCurrent-change"?: ((page: number) => any) | undefined;
+        "onSize-change"?: ((size: number) => any) | undefined;
+        "onPrev-click"?: ((page: number) => any) | undefined;
+        "onNext-click"?: ((page: number) => any) | undefined;
+    }>, {
+        permission: string | string[];
+        size: "large" | "default" | "small";
+        disabled: boolean;
+        currentPage: number;
+        pageSize: number;
+        total: number;
+        pageCount: number;
+        pageSizes: number[];
+        layout: string;
+        pagerCount: number;
+        background: boolean;
+        hideOnSinglePage: boolean;
+        prevText: string;
+        prevIcon: string | import('vue').Component;
+        nextText: string;
+        nextIcon: string | import('vue').Component;
+        teleported: boolean;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+};
+export default _default;