rtcpts 0.0.55 → 0.0.56

package/dist/components/j-q-dialog/file.d.ts

@@ -2,4 +2,8 @@ export type IEnterFileType = {
     size: number;
     accept: string[];
 };
+/**
+ * 文件进入对话框前的校验：校验首个文件的大小与扩展名是否在允许范围内。
+ * 不通过时弹出错误提示并返回 undefined；通过则返回原 files 数组。
+ */
 export declare function beforeFileEnter(files: File[], config?: IEnterFileType): File[] | undefined;

package/dist/components/j-q-dialog/index.d.ts

@@ -87,25 +87,52 @@ export interface SelectInputConfig {
     /** 额外的选择框属性 */
     selectProps?: Record<string, any>;
 }
+/**
+ * `DialogProvider.register(props)` 的入参：与模板中 `JQDialog` 的 Props 大部分相同，并扩展命令式弹窗与 Prompt 模式字段。
+ *
+ * 行为概要：`dialogId` 由内部生成并注入，无需传入。`dialogType` 为 `text` / `textarea` / `select` 时进入 Prompt 模式，会强制使用内置 `prompt-content` 组件，并需传入对应的 `text` / `textarea` / `select` 配置；此时 `register` 返回 `Promise`（用户确认 resolve 值、关闭等逻辑见 `prompt-content`）。其它或未设 `dialogType` 时按普通对话框处理，传入的 `component` / `content` 等与模板中 `JQDialog` 一致，`register` 返回挂载后的实例，可在 `nextTick` 后调用 `open`、`close`、`setLoading`、`setConfirmVisible` 等（与 `index.vue` 的 `expose` 一致）。
+ */
 export interface JQDialogRegisterProps {
+    /** 是否允许焦点落到对话框外；同 `JQDialog` `allowFocusOutside`。 */
     allowFocusOutside?: boolean;
+    /** 是否显示底部按钮栏。 */
     showFooter?: boolean;
+    /** 是否显示确认按钮。 */
     showConfirm?: boolean;
+    /** 普通模式：主体动态组件（与 `content` 二选一）。Prompt 模式下由内部覆盖，无需传。 */
     component?: any;
+    /** 普通模式：无 `component` 时的备用动态组件。 */
     content?: any;
+    /** 传给动态组件的 `v-bind`；Prompt 模式下会与内置 `componentBind` 合并（含 `dialogInstance` 等）。 */
     componentBind?: Record<string, any>;
+    /** 传给动态组件的 `v-on`。Prompt 模式下可提供空对象避免告警。 */
     componentOn?: Record<string, any>;
+    /** 是否允许 ESC 关闭。 */
     closeOnEsc?: boolean;
+    /** 是否允许点击遮罩关闭。 */
     closeOnMask?: boolean;
+    /** 对话框位置；`right` 时为侧栏全高样式。 */
     position?: DialogPosition;
+    /** 是否显示标题栏。 */
     showHeader?: boolean;
+    /** 标题文案。 */
     title?: string;
+    /** 最大宽度；Prompt 模式未传时内部会按视口给默认（如 `30vw` / `25vw`）。 */
     maxWidth?: string | number;
+    /** 内容区最小高度；Prompt 模式未传时可能为 `'auto'`。 */
     minHeight?: string | number;
+    /** 追加在根 `q-dialog` 上的 class。 */
     dialogClass?: string | string[] | Record<string, boolean>;
+    /**
+     * `'dialog'` 或未设：普通对话框，用 `component` / `content`。
+     * `'text'` | `'textarea'` | `'select'`：Prompt 弹窗，必须配合对应配置对象。
+     */
     dialogType?: DialogType;
+    /** `dialogType === 'text'` 时的单行输入配置。 */
     text?: TextInputConfig;
+    /** `dialogType === 'textarea'` 时的多行输入配置。 */
     textarea?: TextareaInputConfig;
+    /** `dialogType === 'select'` 时的下拉配置（须含 `options`）。 */
     select?: SelectInputConfig;
 }
 export interface JQDialogExposed {
@@ -121,10 +148,29 @@ export interface JQDialogExposed {
         value: boolean;
     }) => void;
 }
+/**
+ * 命令式弹窗入口：`DialogProvider` 单例的类型描述。
+ *
+ * 使用前可调用 {@link DialogProviderType.configure | configure} 注入路由、状态、国际化等；再通过 {@link DialogProviderType.register | register} 挂载对话框。
+ */
 export interface DialogProviderType {
+    /**
+     * 设置后续 `register` 创建子应用时复用的全局依赖（router、store、i18n、额外插件、图标映射、权限 provide 等）。
+     * 通常在应用启动时调用一次即可。
+     */
     configure(options: DialogProviderOptions): void;
+    /**
+     * 创建并挂载对话框；Prompt 模式返回 `Promise`，普通模式返回挂载实例。详见 `DialogProvider.register` 实现上的 JSDoc。
+     * @param props 见 {@link JQDialogRegisterProps}
+     */
     register(props: JQDialogRegisterProps): Promise<any>;
+    /**
+     * 按 `register` 注入的 `dialogId` 卸载对应子应用并从 DOM 移除容器；`id` 不存在时静默返回。
+     */
     destroy(dialogId: string): void;
+    /**
+     * 卸载并清理当前已登记的全部命令式对话框（内部 Map 清空）。
+     */
     destroyAll(): void;
 }
 export declare const DialogProvider: DialogProviderType;

package/dist/components/j-q-dialog/types.d.ts

@@ -1,4 +1,6 @@
 import { DefineComponent, SlotsType } from 'vue';
+import { IEnterFileType } from './file';
+import { formRules } from './form-rules';
 /** 对话框位置类型 */
 export declare const DialogPosition: {
     readonly STANDARD: "standard";
@@ -9,84 +11,88 @@ export declare const DialogPosition: {
 };
 /** 对话框位置类型 */
 export type DialogPositionType = (typeof DialogPosition)[keyof typeof DialogPosition];
-/** JQDialog Props 接口 */
+/**
+ * JQDialog 组件 Props（与 `index.vue` 中 `props` 一致）。
+ *
+ * 使用方式：模板内挂载后通过 `ref` 调用 `open` / `close` 等（见 `JQDialogExpose`）；命令式创建请用 `DialogProvider.register`（见 `index.ts` 的 `JQDialogRegisterProps`）。
+ */
 export interface JQDialogProps {
     /**
-     * 是否允许点击外部区域
+     * 是否允许焦点落到对话框外（对应 Quasar `QDialog` 的 `allow-focus-outside`）。
      * @default true
      */
     allowFocusOutside?: boolean;
     /**
-     * 是否显示底部
+     * 是否显示底部按钮栏（取消 / 确认）。
      * @default true
      */
     showFooter?: boolean;
     /**
-     * 是否显示确认按钮
+     * 是否显示确认按钮；也可在打开后通过 `setConfirmVisible` 再改。
      * @default true
      */
     showConfirm?: boolean;
     /**
-     * 动态组件
+     * 主体区域渲染的动态组件（`:is="component"`），与 `content` 二选一；会合并 `componentBind` / `componentOn`，并向子组件注入 `dialogInstance`（见实现）。
      */
     component?: any;
     /**
-     * 内容组件
+     * 无 `component` 时使用的备用动态组件（仅 `v-bind` 无额外注入）。
      */
     content?: any;
     /**
-     * 组件绑定属性
+     * 传给动态组件的 `v-bind`；实现中会合并 `dialogInstance`（含 `open`、`close`、`rules`、`beforeFile` 等）。
      */
     componentBind?: Record<string, any>;
     /**
-     * 组件事件监听
+     * 传给动态组件的 `v-on`（事件名到处理函数）。
      */
-    componentOn?: Record<string, Function>;
+    componentOn?: Record<string, (...args: unknown[]) => unknown>;
     /**
-     * 是否允许按 ESC 关闭
+     * 是否允许按 ESC 关闭（对应 `no-esc-dismiss` 的反义）。
      * @default true
      */
     closeOnEsc?: boolean;
     /**
-     * 是否允许点击遮罩关闭
+     * 是否允许点击遮罩关闭（对应 `no-backdrop-dismiss` 的反义）。
      * @default true
      */
     closeOnMask?: boolean;
     /**
-     * 对话框唯一标识
+     * 供 `DialogProvider` 注册实例使用；关闭时若存在则会 `DialogProvider.destroy(dialogId)`。
      */
     dialogId?: string;
     /**
-     * 对话框位置
+     * 对话框位置；`right` 时启用全高与侧滑过渡。
      * @default 'standard'
      */
     position?: DialogPositionType;
     /**
-     * 是否显示头部
+     * 是否显示标题栏与关闭图标。
      * @default true
      */
     showHeader?: boolean;
     /**
-     * 对话框标题
+     * 默认标题文案；可用 `#title` 插槽覆盖。
      */
     title?: string;
     /**
-     * 最大宽度
+     * 最大宽度；仅在 `position === 'standard'` 时作用于卡片宽度样式。
      */
     maxWidth?: string | number;
     /**
-     * 最小高度
+     * 内容区最小高度（数字视为 px）。
      * @default 320
      */
     minHeight?: string | number;
     /**
-     * 追加在对话框根节点（q-dialog）上的 class
+     * 追加在根节点 `q-dialog` 上的 class（与内部 `j-q-dialog` 等并列）。
      */
     dialogClass?: string | string[] | Record<string, boolean>;
 }
-/** JQDialog Emits 接口 */
+/** 组件未声明 `emit`；交互通过 `expose`（`JQDialogExpose`）与 `ref` 完成。 */
 export interface JQDialogEmits {
-    [key: string]: any;
+    [key: string]: never;
 }
 /** JQDialog Slots 接口 */
 export interface JQDialogSlots {
@@ -127,9 +133,14 @@ export interface JQDialogExpose {
      */
     changeConfirmText: (text: string) => void;
     /**
-     * 表单验证规则
+     * 与 `formRules(i18n)` 返回值一致，供子表单与 `componentBind.dialogInstance` 使用。
+     */
+    rules: ReturnType<typeof formRules>;
+    /**
+     * 与 `./file` 中 `beforeFileEnter` 相同：校验首个文件大小与扩展名；不通过时提示并返回 `undefined`，通过则返回原 `files`。
+     * 默认配置为 5MB、`xls`/`xlsx`。经 `componentBind.dialogInstance` 注入子组件；也可通过模板 `ref` 调用。
      */
-    rules: any;
+    beforeFile: (files: File[], config?: IEnterFileType) => File[] | undefined;
 }
 /** JQDialog 组件类型定义 */
 export type JQDialogComponent = DefineComponent<JQDialogProps, JQDialogExpose, {}, {}, {}, {}, SlotsType<JQDialogSlots>, {}>;