@hlw-uni-mp/use 1.0.0 → 1.0.1

package/dist/index.js

@@ -26,6 +26,7 @@ __export(index_exports, {
   fontFamilyPresets: () => fontFamilyPresets,
   fontSizePresets: () => fontSizePresets,
   getTheme: () => getTheme,
+  hlw: () => hlw,
   initTheme: () => initTheme,
   showShareMenu: () => showShareMenu,
   useMsg: () => useMsg,
@@ -132,6 +133,13 @@ function useMsg() {
     setLoadingBar
   };
 }
+var _msg = null;
+var hlw = {
+  /** 统一提示门面 */
+  get $msg() {
+    return _msg ?? (_msg = useMsg());
+  }
+};
 
 // src/theme/index.ts
 var import_vue = require("vue");
@@ -341,6 +349,7 @@ function useRefs() {
   fontFamilyPresets,
   fontSizePresets,
   getTheme,
+  hlw,
   initTheme,
   showShareMenu,
   useMsg,

package/dist/index.mjs

@@ -94,6 +94,13 @@ function useMsg() {
     setLoadingBar
   };
 }
+var _msg = null;
+var hlw = {
+  /** 统一提示门面 */
+  get $msg() {
+    return _msg ?? (_msg = useMsg());
+  }
+};
 
 // src/theme/index.ts
 import { computed, toRef } from "vue";
@@ -302,6 +309,7 @@ export {
   fontFamilyPresets,
   fontSizePresets,
   getTheme,
+  hlw,
   initTheme,
   showShareMenu,
   useMsg,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hlw-uni-mp/use",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Universal Uni-App Vue 3 stateful composables library",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/dist/index.d.mts

@@ -1,233 +0,0 @@
-import { ApiRes } from '@hlw-uni-mp/request';
-import * as pinia from 'pinia';
-import { App, Ref, ComputedRef } from 'vue';
-
-/**
- * 提示回调函数类型 (confirm 为 true 表示确定，false 为取消)
- */
-type ToastCallback = (confirm: boolean) => void;
-
-/**
- * 消息门面体
- */
-interface HlwMsg {
-    /** 显示轻提示或模态确认框 (支持回调与 Promise) */
-    toast<T = unknown>(opts: UniApp.ShowToastOptions | ApiRes<T> | string, callback?: ToastCallback): Promise<boolean>;
-    /** 成功提示框 */
-    success(msg: string): void;
-    /** 失败提示框 */
-    error(msg: string): void;
-    /** 显全局加载 */
-    showLoading(msg?: string): void;
-    /** 隐全局加载 */
-    hideLoading(): void;
-    /** 弹出确认框 */
-    modal(opts?: UniApp.ShowModalOptions): Promise<boolean>;
-    /** 标题进度条 */
-    setLoadingBar(progress: number): void;
-}
-
-/**
- * 统一的消息提示与弹窗能力 hook。
- *
- * @example
- * ```ts
- * const msg = useMsg();
- * msg.toast('操作成功');
- * msg.toast(res, (confirm) => {
- *     if (confirm) console.log('点击确定');
- *     else console.log('点击取消');
- * });
- * const ok = await msg.modal({ content: '确定删除吗？' });
- * ```
- */
-declare function useMsg(): HlwMsg;
-
-/**
- * 外观模式型
- */
-type ThemeMode = "light" | "dark" | "system";
-
-/**
- * 字体大小型
- */
-type FontSize = "small" | "standard" | "large" | "extra-large";
-
-/**
- * 字体样式型
- */
-type FontFamily = "system" | "sans" | "serif" | "kaiti";
-
-/**
- * 主题色彩项
- */
-interface ThemeColor {
-    name: string;
-    value: string;
-}
-
-/**
- * 主题状态表
- */
-interface ThemeState {
-    mode: ThemeMode;
-    color: string;
-    fontSize: FontSize;
-    fontFamily: FontFamily;
-}
-
-/**
- * 初始配置项
- */
-interface InitThemeOptions {
-    sync?: boolean;
-    defaultTheme?: Partial<ThemeState>;
-}
-
-/**
- * 字体大小项
- */
-interface FontSizePreset {
-    id: string;
-    name: string;
-    class: string;
-}
-
-/**
- * 字体样式项
- */
-interface FontFamilyPreset {
-    id: string;
-    name: string;
-    class: string;
-}
-
-/**
- * 字体大小表
- */
-declare const fontSizePresets: FontSizePreset[];
-/**
- * 字体样式表
- */
-declare const fontFamilyPresets: FontFamilyPreset[];
-/**
- * 主题状态库
- */
-declare const useThemeStore: pinia.StoreDefinition<"theme", {
-    mode: string;
-    color: string;
-    fontSize: string;
-    fontFamily: string;
-}, {}, {}>;
-
-/**
- * 默认主题配置
- */
-declare const DEFAULT_THEME: ThemeState;
-/**
- * 预设色彩库
- */
-declare const THEME_COLORS: ThemeColor[];
-/**
- * 获取存储配置
- */
-declare function getTheme(): ThemeState;
-/**
- * 应用主题状态
- */
-declare function applyTheme(themeState: Partial<ThemeState>): void;
-/**
- * 注册主题器
- */
-declare function initTheme(app: App, options?: InitThemeOptions): void;
-/**
- * 主题组合钩子
- */
-declare function useTheme(): {
-    mode: Ref<ThemeMode, ThemeMode>;
-    color: Ref<string, string>;
-    fontSize: Ref<string, string>;
-    fontSizeClass: ComputedRef<string>;
-    fontFamily: Ref<string, string>;
-    fontFamilyClass: ComputedRef<string>;
-    colors: ThemeColor[];
-    fontSizePresets: FontSizePreset[];
-    fontFamilyPresets: FontFamilyPreset[];
-    setMode: (targetMode: ThemeMode) => void;
-    setColor: (hexColor: string) => void;
-    setFontSize: (targetSize: string) => void;
-    setFontFamily: (targetFont: string) => void;
-    resetTheme: () => void;
-    applyTheme: typeof applyTheme;
-    getTheme: typeof getTheme;
-    initTheme: typeof initTheme;
-    store: pinia.Store<"theme", {
-        mode: string;
-        color: string;
-        fontSize: string;
-        fontFamily: string;
-    }, {}, {}>;
-};
-
-/**
- * 分享卡片配置项
- */
-interface ShareConfig {
-    /** 分享标题 */
-    title?: string;
-    /** 分享页面路径 */
-    path?: string;
-    /** 分享卡片封面图 */
-    imageUrl?: string;
-}
-
-/**
- * 分享操作句柄
- */
-interface ShareHandlers {
-    /** 显式调起分享菜单 */
-    showShareMenu: () => void;
-}
-
-/**
- * 显式调起分享菜单
- */
-declare function showShareMenu(): void;
-/**
- * 分享组合式函数
- */
-declare function useShare(config?: ShareConfig): ShareHandlers;
-
-/**
- * useRefs - 模板 Ref 批量管理
- *
- * 主要用于在 v-for 循环场景下，动态收集一组子元素或子组件的引用实例。
- * 规避了 Vue3 在 v-for 中绑定 ref 时需要手动处理数组收集和清理的冗余逻辑。
- */
-
-interface UseRefsReturn<T = unknown> {
-    /** 存放动态收集到的所有组件或 DOM 实例的 Key-Value 映射对象 */
-    refs: Ref<Record<string, T>>;
-    /** 按 key 生成一个 ref 绑定回调函数 */
-    setRefs: (key: string) => (element: T | null) => void;
-}
-/**
- * 管理动态 ref 集合的 hook，尤其适合 v-for 列表场景。
- *
- * @example
- * ```vue
- * <template>
- *   <view v-for="item in list" :key="item.id" :ref="setRefs(item.id)">
- *     {{ item.name }}
- *   </view>
- * </template>
- *
- * <script setup>
- * const { refs, setRefs } = useRefs();
- * // 访问特定子项的 DOM/实例: refs.value[itemId]
- * </script>
- * ```
- */
-declare function useRefs<T = unknown>(): UseRefsReturn<T>;
-
-export { DEFAULT_THEME, type FontFamily, type FontFamilyPreset, type FontSize, type FontSizePreset, type HlwMsg, type InitThemeOptions, type ShareConfig, type ShareHandlers, THEME_COLORS, type ThemeColor, type ThemeMode, type ThemeState, type ToastCallback, type UseRefsReturn, applyTheme, fontFamilyPresets, fontSizePresets, getTheme, initTheme, showShareMenu, useMsg, useRefs, useShare, useTheme, useThemeStore };

package/dist/index.d.ts

@@ -1,233 +0,0 @@
-import { ApiRes } from '@hlw-uni-mp/request';
-import * as pinia from 'pinia';
-import { App, Ref, ComputedRef } from 'vue';
-
-/**
- * 提示回调函数类型 (confirm 为 true 表示确定，false 为取消)
- */
-type ToastCallback = (confirm: boolean) => void;
-
-/**
- * 消息门面体
- */
-interface HlwMsg {
-    /** 显示轻提示或模态确认框 (支持回调与 Promise) */
-    toast<T = unknown>(opts: UniApp.ShowToastOptions | ApiRes<T> | string, callback?: ToastCallback): Promise<boolean>;
-    /** 成功提示框 */
-    success(msg: string): void;
-    /** 失败提示框 */
-    error(msg: string): void;
-    /** 显全局加载 */
-    showLoading(msg?: string): void;
-    /** 隐全局加载 */
-    hideLoading(): void;
-    /** 弹出确认框 */
-    modal(opts?: UniApp.ShowModalOptions): Promise<boolean>;
-    /** 标题进度条 */
-    setLoadingBar(progress: number): void;
-}
-
-/**
- * 统一的消息提示与弹窗能力 hook。
- *
- * @example
- * ```ts
- * const msg = useMsg();
- * msg.toast('操作成功');
- * msg.toast(res, (confirm) => {
- *     if (confirm) console.log('点击确定');
- *     else console.log('点击取消');
- * });
- * const ok = await msg.modal({ content: '确定删除吗？' });
- * ```
- */
-declare function useMsg(): HlwMsg;
-
-/**
- * 外观模式型
- */
-type ThemeMode = "light" | "dark" | "system";
-
-/**
- * 字体大小型
- */
-type FontSize = "small" | "standard" | "large" | "extra-large";
-
-/**
- * 字体样式型
- */
-type FontFamily = "system" | "sans" | "serif" | "kaiti";
-
-/**
- * 主题色彩项
- */
-interface ThemeColor {
-    name: string;
-    value: string;
-}
-
-/**
- * 主题状态表
- */
-interface ThemeState {
-    mode: ThemeMode;
-    color: string;
-    fontSize: FontSize;
-    fontFamily: FontFamily;
-}
-
-/**
- * 初始配置项
- */
-interface InitThemeOptions {
-    sync?: boolean;
-    defaultTheme?: Partial<ThemeState>;
-}
-
-/**
- * 字体大小项
- */
-interface FontSizePreset {
-    id: string;
-    name: string;
-    class: string;
-}
-
-/**
- * 字体样式项
- */
-interface FontFamilyPreset {
-    id: string;
-    name: string;
-    class: string;
-}
-
-/**
- * 字体大小表
- */
-declare const fontSizePresets: FontSizePreset[];
-/**
- * 字体样式表
- */
-declare const fontFamilyPresets: FontFamilyPreset[];
-/**
- * 主题状态库
- */
-declare const useThemeStore: pinia.StoreDefinition<"theme", {
-    mode: string;
-    color: string;
-    fontSize: string;
-    fontFamily: string;
-}, {}, {}>;
-
-/**
- * 默认主题配置
- */
-declare const DEFAULT_THEME: ThemeState;
-/**
- * 预设色彩库
- */
-declare const THEME_COLORS: ThemeColor[];
-/**
- * 获取存储配置
- */
-declare function getTheme(): ThemeState;
-/**
- * 应用主题状态
- */
-declare function applyTheme(themeState: Partial<ThemeState>): void;
-/**
- * 注册主题器
- */
-declare function initTheme(app: App, options?: InitThemeOptions): void;
-/**
- * 主题组合钩子
- */
-declare function useTheme(): {
-    mode: Ref<ThemeMode, ThemeMode>;
-    color: Ref<string, string>;
-    fontSize: Ref<string, string>;
-    fontSizeClass: ComputedRef<string>;
-    fontFamily: Ref<string, string>;
-    fontFamilyClass: ComputedRef<string>;
-    colors: ThemeColor[];
-    fontSizePresets: FontSizePreset[];
-    fontFamilyPresets: FontFamilyPreset[];
-    setMode: (targetMode: ThemeMode) => void;
-    setColor: (hexColor: string) => void;
-    setFontSize: (targetSize: string) => void;
-    setFontFamily: (targetFont: string) => void;
-    resetTheme: () => void;
-    applyTheme: typeof applyTheme;
-    getTheme: typeof getTheme;
-    initTheme: typeof initTheme;
-    store: pinia.Store<"theme", {
-        mode: string;
-        color: string;
-        fontSize: string;
-        fontFamily: string;
-    }, {}, {}>;
-};
-
-/**
- * 分享卡片配置项
- */
-interface ShareConfig {
-    /** 分享标题 */
-    title?: string;
-    /** 分享页面路径 */
-    path?: string;
-    /** 分享卡片封面图 */
-    imageUrl?: string;
-}
-
-/**
- * 分享操作句柄
- */
-interface ShareHandlers {
-    /** 显式调起分享菜单 */
-    showShareMenu: () => void;
-}
-
-/**
- * 显式调起分享菜单
- */
-declare function showShareMenu(): void;
-/**
- * 分享组合式函数
- */
-declare function useShare(config?: ShareConfig): ShareHandlers;
-
-/**
- * useRefs - 模板 Ref 批量管理
- *
- * 主要用于在 v-for 循环场景下，动态收集一组子元素或子组件的引用实例。
- * 规避了 Vue3 在 v-for 中绑定 ref 时需要手动处理数组收集和清理的冗余逻辑。
- */
-
-interface UseRefsReturn<T = unknown> {
-    /** 存放动态收集到的所有组件或 DOM 实例的 Key-Value 映射对象 */
-    refs: Ref<Record<string, T>>;
-    /** 按 key 生成一个 ref 绑定回调函数 */
-    setRefs: (key: string) => (element: T | null) => void;
-}
-/**
- * 管理动态 ref 集合的 hook，尤其适合 v-for 列表场景。
- *
- * @example
- * ```vue
- * <template>
- *   <view v-for="item in list" :key="item.id" :ref="setRefs(item.id)">
- *     {{ item.name }}
- *   </view>
- * </template>
- *
- * <script setup>
- * const { refs, setRefs } = useRefs();
- * // 访问特定子项的 DOM/实例: refs.value[itemId]
- * </script>
- * ```
- */
-declare function useRefs<T = unknown>(): UseRefsReturn<T>;
-
-export { DEFAULT_THEME, type FontFamily, type FontFamilyPreset, type FontSize, type FontSizePreset, type HlwMsg, type InitThemeOptions, type ShareConfig, type ShareHandlers, THEME_COLORS, type ThemeColor, type ThemeMode, type ThemeState, type ToastCallback, type UseRefsReturn, applyTheme, fontFamilyPresets, fontSizePresets, getTheme, initTheme, showShareMenu, useMsg, useRefs, useShare, useTheme, useThemeStore };