sakura-ui-plus 1.0.0

package/dist/types/components/show-modal/install.d.ts

@@ -0,0 +1,5 @@
+import { App } from 'vue';
+declare const _default: {
+    install(vm: App): void;
+};
+export default _default;

package/dist/types/components/show-modal/props.d.ts

@@ -0,0 +1,19 @@
+import { DialogProps } from '../dialog/props.ts';
+import { VNode } from 'vue';
+export type ShowModalProps = Pick<DialogProps, 'width' | 'showConfirmButton' | 'showCancelButton' | 'cancelButtonText' | 'confirmButtonText' | 'showClose' | 'title'> & {
+    content?: string | VNode | Function;
+    resolve?: Function;
+};
+/**
+ * 模态窗函数类型
+ */
+export type ShowModalFn = {
+    /**
+     * 模态窗
+     * @param content 内容
+     * @param title 标题
+     * @param showCancelButton 是否显示取消按钮
+     * @param params
+     */
+    (content: string | VNode | Function, title?: string, showCancelButton?: boolean, params?: Omit<ShowModalProps, 'title' | 'content' | 'showCancelButton'>): Promise<boolean>;
+};

package/dist/types/components/show-modal/show-modal.vue.d.ts

@@ -0,0 +1,14 @@
+import { ShowModalProps } from './props.ts';
+type __VLS_Props = ShowModalProps;
+declare const visible: import('vue').ModelRef<boolean, string, boolean, boolean>;
+type __VLS_PublicProps = {
+    'modelValue'?: typeof visible['value'];
+} & __VLS_Props;
+declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {
+    visibleShowModal: import('@vueuse/core').PromisifyFn<(content?: string, title?: string, showCancelButton?: any, params?: ShowModalProps) => Promise<boolean>>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:modelValue": (value: boolean) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/types/components/show-modal/utils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 验证标签字符串是否为合法 DOM 结构
+ * @param html 完整标签字符串
+ * @returns { boolean } 是否合法
+ */
+export declare const validateHtmlString: (html: string) => boolean;

package/dist/types/components/status/props.d.ts

@@ -0,0 +1,7 @@
+import { ComponentType } from '../../types';
+export type StatusProps = {
+    type?: ComponentType;
+    text?: string;
+    color?: string;
+    plain?: boolean;
+};

package/dist/types/components/status/status.vue.d.ts

@@ -0,0 +1,20 @@
+import { StatusProps } from './props';
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    rootEl: HTMLSpanElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<StatusProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<StatusProps> & Readonly<{}>, {
+    type: import('../..').ComponentType;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLSpanElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/types/components/tabs/props.d.ts

@@ -0,0 +1,7 @@
+import { OptionsItem } from '../../types';
+export type TabsProps = {
+    options: OptionsItem[];
+};
+export type TabsEmits = {
+    change: [value?: any];
+};

package/dist/types/components/tabs/tabs.vue.d.ts

@@ -0,0 +1,30 @@
+import { TabsProps } from './props.ts';
+type __VLS_Props = TabsProps;
+type __VLS_PublicProps = {
+    'modelValue'?: any;
+} & __VLS_Props;
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {
+            data: import('../../index.ts').OptionsItem;
+        }): any;
+    };
+    refs: {};
+    rootEl: HTMLDivElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    change: (value?: any) => any;
+    "update:modelValue": (value: any) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    onChange?: ((value?: any) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: any) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/types/components/tooltip-text/props.d.ts

@@ -0,0 +1,9 @@
+export type TooltipTextProps = {
+    truncated?: boolean;
+    fontSize?: number;
+    content: string;
+    fontWeight?: boolean;
+    color?: string;
+    width?: string | number;
+    effect?: 'dark' | 'light';
+};

package/dist/types/components/tooltip-text/tooltip-text.vue.d.ts

@@ -0,0 +1,11 @@
+import { TooltipTextProps } from './props.ts';
+declare const _default: import('vue').DefineComponent<TooltipTextProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<TooltipTextProps> & Readonly<{}>, {
+    width: string | number;
+    effect: "dark" | "light";
+    truncated: boolean;
+    fontSize: number;
+    fontWeight: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    tooltipTextRef: HTMLDivElement;
+}, HTMLDivElement>;
+export default _default;

package/dist/types/constants/event.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 事件名称
+ */
+export declare enum EVENT_NAME {
+    /**
+     * 改变
+     */
+    改变 = "change",
+    /**
+     * 发送
+     */
+    发送 = "send",
+    /**
+     * 点击
+     */
+    点击 = "tap",
+    /**
+     * 确认
+     */
+    确认 = "confirm",
+    /**
+     * 搜索
+     */
+    搜索 = "search",
+    /**
+     * 扫码
+     */
+    扫码 = "scan",
+    /**
+     * 保存
+     */
+    保存 = "save",
+    /**
+     * 下载
+     */
+    下载 = "download",
+    /**
+     * 返回
+     */
+    返回 = "back",
+    /**
+     * 预览
+     */
+    预览 = "preview",
+    /**
+     * 删除
+     */
+    删除 = "delete",
+    /**
+     * 重置
+     */
+    重置 = "reset",
+    /**
+     * 关闭
+     */
+    关闭 = "close",
+    /**
+     * 提交
+     */
+    提交 = "submit"
+}

package/dist/types/constants/index.d.ts

@@ -0,0 +1 @@
+export * from './event.ts';

package/dist/types/hooks/index.d.ts

@@ -0,0 +1,7 @@
+export * from './use-namespace';
+export * from './use-callback-trigger';
+export * from './use-show-modal';
+export * from './use-loading';
+export * from './use-message';
+export * from './use-message-box';
+export * from './use-notification';

package/dist/types/hooks/use-callback-trigger/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 回调触发
+ */
+export declare const useCallbackTrigger: <T = any>() => {
+    callbackSet: Set<Function>;
+    track: (fn?: Function) => void;
+    trigger: (...args: T[]) => void;
+    clear: () => void;
+    delete: (fn: Function) => void;
+};

package/dist/types/hooks/use-loading/index.d.ts

@@ -0,0 +1,10 @@
+import { LoadingOptionsResolved } from 'element-plus';
+/**
+ * 二次封装饿了么loading弹窗
+ * @param background 背景颜色
+ * @param lock 是否锁定
+ */
+export declare const useLoading: (background?: string, lock?: boolean) => {
+    show: (text?: string, params?: LoadingOptionsResolved) => void;
+    hide: () => void;
+};

package/dist/types/hooks/use-message/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 提示窗
+ */
+export declare const useMessage: () => import('element-plus/es/utils/index.mjs').SFCInstallWithContext<import('element-plus').Message>;

package/dist/types/hooks/use-message-box/index.d.ts

@@ -0,0 +1,8 @@
+import { ElMessageBoxOptions } from 'element-plus/es/components/message-box/src/message-box.type';
+import { VNode } from 'vue';
+/**
+ * 二次封装消息弹出框
+ * @param _closeOnClickModal 是否可通过点击遮罩层关闭 MessageBox 默认true
+ * @param _closeOnPressEscape 是否可通过按下 ESC 键关闭 MessageBox 默认true
+ */
+export declare const useMessageBox: (_closeOnClickModal?: boolean, _closeOnPressEscape?: boolean) => (message: string | VNode | (() => VNode), title?: string, showCancelButton?: boolean, params?: ElMessageBoxOptions) => Promise<boolean>;

package/dist/types/hooks/use-namespace/index.d.ts

@@ -0,0 +1,26 @@
+import { Ref } from 'vue';
+/**
+ * 默认的命名空间前缀
+ */
+export declare const defaultNamespace = "sakura";
+/**
+ * 创建组件的命名空间
+ * @param block 组件名称
+ * @param namespaceOverrides 传递了的话就会重写命名空间不传则”s“
+ */
+export declare const useNamespace: (block: string, namespaceOverrides?: Ref<string | undefined> | string) => {
+    b: (blockSuffix?: string) => string;
+    e: (element?: string) => string;
+    m: (modifier?: string) => string;
+    be: (blockSuffix?: string, element?: string) => string;
+    em: (element?: string, modifier?: string) => string;
+    bm: (blockSuffix?: string, modifier?: string) => string;
+    bem: (blockSuffix?: string, element?: string, modifier?: string) => string;
+    is: (name: string, ...args: any[]) => string;
+    cssVar: (object: Record<string, any>) => Record<string, any>;
+    cssBlockVar: (block: string, object: Record<string, any>) => Record<string, any>;
+    cssVarName: (name: string) => string;
+    cssBlockVarName: (block: string, name: string) => string;
+    cssVarNameValue: (name: string) => string;
+    cssBlockVarNameValue: (block: string, name: string) => string;
+};

package/dist/types/hooks/use-notification/index.d.ts

@@ -0,0 +1,8 @@
+import { Notification, PositionType } from './type.ts';
+/**
+ * 通知管理
+ * @param duration 显示时间, 单位为毫秒。 值为 0 则不会自动关闭 默认8000
+ * @param showClose 是否显示关闭按钮 默认显示
+ * @param position 自定义弹出位置 默认 to-right
+ */
+export declare const useNotification: (duration?: number, showClose?: boolean, position?: PositionType) => Notification;

package/dist/types/hooks/use-notification/type.d.ts

@@ -0,0 +1,65 @@
+import { NotificationOptions } from 'element-plus/es/components/notification/src/notification';
+import { VNode } from 'vue';
+/**
+ * 通知类型
+ * - success 成功 绿色
+ * - error 失败 红色
+ * - warning 警告 黄色
+ * - info 内容 灰色
+ * - tips 蓝色
+ */
+export type NotificationTypes = 'success' | 'warning' | 'error' | 'info' | 'tips' | '';
+/**
+ * 通知函数返回内容
+ */
+type NotificationHandler = {
+    close: () => void;
+};
+/**
+ * 选项
+ */
+export type NotificationParams = Partial<NotificationOptions> & {
+    type?: NotificationTypes;
+};
+/**
+ * 函数类型
+ */
+export type NotificationFn = {
+    (message: string | VNode, title: string, options?: NotificationParams): NotificationHandler;
+};
+/**
+ * 类型函数类型
+ */
+export type NotificationTypeFn = {
+    (message: string | VNode, title?: string, options?: NotificationParams): NotificationHandler;
+};
+/**
+ * 位置类型
+ */
+export type PositionType = 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left';
+/**
+ * 通知实例
+ */
+export interface Notification extends NotificationFn {
+    /**
+     * 成功
+     */
+    success: NotificationTypeFn;
+    /**
+     * 失败
+     */
+    error: NotificationTypeFn;
+    /**
+     * 信息
+     */
+    info: NotificationTypeFn;
+    /**
+     * 提示-黄色
+     */
+    warning: NotificationTypeFn;
+    /**
+     * 提示-蓝色
+     */
+    tips: NotificationTypeFn;
+}
+export {};

package/dist/types/hooks/use-show-modal/index.d.ts

@@ -0,0 +1,2 @@
+import { ShowModalFn } from '../../components/show-modal/props.ts';
+export declare const useShowModal: () => ShowModalFn;

package/dist/types/index.d.ts

@@ -0,0 +1,10 @@
+import { default as install } from './components/register-components.ts';
+export * from './hooks';
+export * from './types';
+export * from './utils';
+export * from './constants';
+export * from './components';
+declare const SakuraUiPlus: {
+    install: typeof install;
+};
+export default SakuraUiPlus;

package/dist/types/types/index.d.ts

@@ -0,0 +1,28 @@
+import { FILE_TYPE } from 'sakura-utils';
+/**
+ * 类型
+ */
+export type ComponentType = 'primary' | 'success' | 'danger' | 'warning' | 'info' | 'error' | '' | 'default';
+/**
+ * 尺寸
+ */
+export type ComponentSize = 'small' | 'large' | 'default' | '';
+/**
+ * 选项
+ */
+export type OptionsItem<T = string, M = object> = {
+    label: string;
+    value: T;
+    disabled?: boolean;
+} & Partial<M>;
+/**
+ * 文件信息
+ */
+export type FileInfo = {
+    fileId: string;
+    fileUrl: string;
+    fileName: string;
+    fileSuffix?: string;
+    fileSize?: number;
+    fileType: FILE_TYPE;
+};

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

@@ -0,0 +1,6 @@
+/**
+ * 检查标签是否存在，如不存在则直接创建并且塞入容器
+ * @param id id
+ * @param container id / class / tag
+ */
+export declare const checkElementIsExist: (id: string, container?: string) => boolean;

package/package.json

@@ -0,0 +1,79 @@
+{
+    "name": "sakura-ui-plus",
+    "version": "1.0.0",
+    "description": "开发常用组件",
+    "type": "module",
+    "sideEffects": [
+        "*.scss",
+        "*.css"
+    ],
+    "private": false,
+    "main": "./dist/lib/index.js",
+    "module": "./dist/es/index.js",
+    "types": "./dist/types/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/types/index.d.ts",
+            "import": "./dist/es/index.js",
+            "require": "./dist/lib/index.js"
+        },
+        "./es": {
+            "import": "./dist/es/index.js"
+        },
+        "./lib": {
+            "require": "./dist/lib/index.js"
+        },
+        "./style": {
+            "import": "./dist/style.css",
+            "require": "./dist/style.css"
+        },
+        "./dist/style.css": {
+            "import": "./dist/style.css",
+            "require": "./dist/style.css"
+        },
+        "./style.css": {
+            "import": "./dist/style.css",
+            "require": "./dist/style.css"
+        }
+    },
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "dev": "vite",
+        "build": "vite build",
+        "build:types": "npx vue-tsc --declaration --emitDeclarationOnly --outDir dist/types",
+        "type-check": "npx vue-tsc --noEmit",
+        "test": "vitest",
+        "test:ui": "vitest --ui",
+        "test:coverage": "vitest run --coverage",
+        "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix",
+        "prepublishOnly": "npm run build"
+    },
+    "peerDependencies": {
+        "element-plus": "^2.13.0",
+        "@vueuse/core": "^12.3.0",
+        "sakura-utils": "^1.0.7",
+        "vue": "^3.3.0",
+        "@ctrl/tinycolor": "^3.6.0",
+        "@element-plus/icons-vue": "^2.3.1",
+        "dompurify": "^3.2.6"
+    },
+    "devDependencies": {
+        "@types/node": "^20.0.0",
+        "@vitejs/plugin-vue": "^4.0.0",
+        "@vitest/ui": "^0.34.0",
+        "@vue/test-utils": "^2.4.0",
+        "@vue/tsconfig": "^0.4.0",
+        "happy-dom": "^9.0.0",
+        "sass": "^1.97.0",
+        "typescript": "^5.0.0",
+        "unplugin-auto-import": "^0.19.0",
+        "unplugin-vue-components": "^0.28.0",
+        "vite": "^4.0.0",
+        "vite-plugin-dts": "^4.5.4",
+        "vitest": "^0.34.0",
+        "vue-tsc": "^3.2.1"
+    },
+    "dependencies": {}
+}