@opendesign-plus/composables 0.0.1-rc.5

package/dist/core/useClipboard.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 复制文本到剪贴板的工具函数
+ * 优先使用现代 Clipboard API， 在不支持的环境中自动降级到传统的 document.execCommand 方法。
+ *
+ * @param text - 需要复制到剪贴板的文本内容
+ * @returns Promise<boolean> - 复制操作是否成功
+ *
+ * @example
+ * ```typescript
+ * const success = await useClipboard('Hello World');
+ * if (success) {
+ *   console.log('文本复制成功');
+ * }
+ * ```
+ */
+export declare function useClipboard(text: string): Promise<boolean>;

package/dist/core/useLocale.d.ts

@@ -0,0 +1,28 @@
+import { WritableComputedRef, ComputedRef } from 'vue';
+import { Composer } from 'vue-i18n';
+export type LocaleT = 'zh' | 'en';
+export interface UseLocaleReturn {
+    t: Composer['t'];
+    $t: Composer['t'];
+    locale: WritableComputedRef<string>;
+    isZh: ComputedRef<boolean>;
+    isEn: ComputedRef<boolean>;
+    changeLocale: (lang?: LocaleT) => Promise<void>;
+}
+/**
+ * 国际化语言切换组合式函数
+ *
+ * @returns 包含语言相关状态和方法的对象
+ *
+ * @example
+ * ```ts
+ * const { t, locale, isZh, isEn, changeLocale } = useLocale(i18n);
+ *
+ * // 切换语言
+ * changeLocale('en');
+ *
+ * // 监听当前语言
+ * console.log(locale.value); // 'zh' or 'en'
+ * ```
+ */
+export declare const useLocale: () => UseLocaleReturn;

package/dist/core/useMdRender.d.ts

@@ -0,0 +1,23 @@
+import { MarkdownItAsyncOptions } from 'markdown-it-async';
+import { BundledLanguage, BundledTheme } from 'shiki';
+export type * from 'markdown-it-async';
+export type * from 'shiki';
+export interface UseMdOptions extends MarkdownItAsyncOptions {
+    anchor?: boolean;
+    anchorType?: 'vitepress' | 'github';
+    copy?: boolean;
+    wrapMarkdownBodyDiv?: boolean;
+    theme?: {
+        light?: BundledTheme;
+        dark?: BundledTheme;
+    };
+}
+/**
+ * 创建 markdown 渲染实例
+ * @param options - 配置选项
+ * @returns 返回一个对象可解构出 shiki 实例和 markdown-it 实例
+ */
+export declare function useMdRender(options?: UseMdOptions): Promise<{
+    shiki: import('shiki').HighlighterGeneric<BundledLanguage, BundledTheme>;
+    markdwon: import('markdown-it-async').MarkdownItAsync;
+}>;

package/dist/core/useScreen.d.ts

@@ -0,0 +1,44 @@
+export declare enum Size {
+    Phone = "phone",
+    PadV = "pad_v",
+    PadH = "pad_h",
+    Laptop = "laptop"
+}
+export type ScreenSizeT = typeof Size.Phone | Size.PadV | Size.PadH | Size.Laptop;
+export declare const ScreenConfig: {
+    phone: number;
+    pad_v: number;
+    pad_h: number;
+    laptop: number;
+};
+/**
+ * lt: less than, 小于 <
+ * le: less than or equal to, 小于等于 <=
+ * eq: equal to, 等于 =
+ * ne: never equal to, 不等于 !=
+ * ge: greater than or equal to, 大于等于 >=
+ * gt: greater than, 大于 >
+ */
+export type CompareT = 'lt' | 'le' | 'eq' | 'ne' | 'ge' | 'gt';
+export declare const useScreen: () => {
+    getSize: (width?: number) => Size;
+    current: import('vue').Ref<ScreenSizeT, ScreenSizeT>;
+    size: {
+        width: number;
+        height: number;
+    };
+    isPhone: import('vue').ComputedRef<boolean>;
+    gtPhone: import('vue').ComputedRef<boolean>;
+    isPad: import('vue').ComputedRef<boolean>;
+    lePad: import('vue').ComputedRef<boolean>;
+    gtPad: import('vue').ComputedRef<boolean>;
+    isPadV: import('vue').ComputedRef<boolean>;
+    lePadV: import('vue').ComputedRef<boolean>;
+    gtPadV: import('vue').ComputedRef<boolean>;
+    isPadH: import('vue').ComputedRef<boolean>;
+    isLaptop: import('vue').ComputedRef<boolean>;
+    leLaptop: import('vue').ComputedRef<boolean>;
+    gtLaptop: import('vue').ComputedRef<boolean>;
+    isPadToLaptop: import('vue').ComputedRef<boolean>;
+    isPadVToLaptop: import('vue').ComputedRef<boolean>;
+};

package/dist/core/useTheme.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 初始化主题，建议在 vue 应用初始化前调用
+ * @param storageKey - 用于存储主题偏好设置的键名
+ * @param cookieDomain - Cookie 的作用域域名
+ */
+export declare function initTheme(storageKey: string, cookieDomain: string): void;
+/**
+ * 主题切换组合式函数
+ * @param storageKey - 用于存储主题偏好设置的键名，若调用过 initTheme 可不传
+ * @param cookieDomain - Cookie 的作用域域名，若调用过 initTheme 可不传
+ * @returns 包含当前主题状态和操作方法的对象
+ */
+export declare function useTheme(storageKey?: string, cookieDomain?: string): {
+    theme: import('vue').ComputedRef<"light" | "dark">;
+    isLight: import('vue').ComputedRef<boolean>;
+    isDark: import('vue').ComputedRef<boolean>;
+    setTheme: (newTheme: "light" | "dark") => void;
+    toggleTheme: () => void;
+};

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './core/useMdRender';
+export * from './core/useScreen';
+export * from './core/useLocale';
+export * from './core/useTheme';
+export * from './core/useClipboard';