@yeepay/yee-boss-ui 0.1.13 → 0.1.15

package/dist/components/file-upload/types.d.ts

@@ -1,26 +1,77 @@
 import { UploadProps } from 'ant-design-vue';
+/** 文件列表中的单个文件，沿用 Ant Design Vue UploadFile。 */
 export type YeeUploadFile = NonNullable<NonNullable<UploadProps['fileList']>[number]>;
+/** 上传完成后写回文件列表的结果。 */
 export interface YeeUploadResult {
+    /** 服务端返回的文件名。 */
     name?: string;
+    /** 文件可访问地址。 */
     url?: string;
 }
+/** 自动上传回调接收的参数。 */
 export interface YeeUploadRequestOptions {
+    /** 当前待上传文件。 */
     file: File;
+    /** 将上传标记为失败。 */
     onError: (error: Error) => void;
+    /** 更新上传进度，取值范围为 0 到 100。 */
     onProgress: (percent: number) => void;
+    /** 将上传标记为成功并写回文件信息。 */
     onSuccess: (result?: YeeUploadResult) => void;
+    /** 当前文件在上传列表中的唯一标识。 */
     uid: string;
 }
+/** 手动模式选择文件时发送的事件参数。 */
+export interface YeeFileSelectPayload {
+    /** 当前选择的原始文件。 */
+    file: File;
+    /** 当前文件在上传列表中的唯一标识。 */
+    uid: string;
+}
+/** YeeFileUpload 的公开属性。 */
 export interface YeeFileUploadProps {
+    /** 原生文件选择器 accept 配置。 */
     accept?: string;
+    /** 自动上传实现，由业务侧接入统一请求层。 */
     customRequest?: (options: YeeUploadRequestOptions) => Promise<void> | void;
+    /** 当前文件列表，支持 v-model:file-list。 */
     fileList?: YeeUploadFile[];
+    /** 上传触发块高度，数字按 px 处理。 */
     height?: number | string;
+    /** 是否启用手动上传模式。 */
     manual?: boolean;
+    /** 最多允许展示的文件数量。 */
     maxCount?: number;
+    /** 单个文件大小上限，单位 MB。 */
     maxSize?: number;
+    /** 是否允许一次选择多个文件。 */
     multiple?: boolean;
+    /** 是否只读展示文件列表。 */
     readonly?: boolean;
+    /** 上传触发块文案。 */
     uploadText?: string;
+    /** 上传触发块宽度，数字按 px 处理。 */
     width?: number | string;
 }
+/** YeeFileUpload 的公开事件。 */
+export interface YeeFileUploadEmits {
+    /** 文件从列表中移除时触发。 */
+    fileRemoved: [file: YeeUploadFile];
+    /** 手动模式选中文件时触发。 */
+    fileSelect: [payload: YeeFileSelectPayload];
+    /** 文件列表变化时触发。 */
+    'update:fileList': [fileList: YeeUploadFile[]];
+    /** 任意文件上传成功后触发。 */
+    uploadSuccess: [];
+    /** 整体上传状态变化时触发。 */
+    uploadingChange: [isUploading: boolean];
+}
+/** 通过组件 ref 调用的手动上传方法。 */
+export interface YeeFileUploadExpose {
+    /** 将指定文件标记为失败。 */
+    addError: (uid: string) => void;
+    /** 将指定文件标记为成功并写回地址。 */
+    addResult: (uid: string, result: Required<Pick<YeeUploadResult, 'url'>> & YeeUploadResult) => void;
+    /** 获取当前列表中的原始 File 对象。 */
+    getFiles: () => File[];
+}

package/dist/components/form/YeeForm.vue.d.ts

@@ -1,9 +1,9 @@
-import { YeeFormValues, YeeFormProps } from './types';
+import { YeeFormSlots, YeeFormValues, YeeFormProps } from './types';
 declare const _default: <TValues extends object = YeeFormValues>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
     props: __VLS_PrettifyLocal<Pick<Partial<{}> & Omit<{} & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>, never> & YeeFormProps<TValues> & Partial<{}>> & import('vue').PublicProps;
     expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;
     attrs: any;
-    slots: {};
+    slots: Readonly<YeeFormSlots<TValues>> & YeeFormSlots<TValues>;
     emit: {};
 }>) => import('vue').VNode & {
     __ctx?: Awaited<typeof __VLS_setup>;

package/dist/components/form/component-map.d.ts

@@ -0,0 +1,9 @@
+import { Component } from 'vue';
+import { YeeFormBuiltInComponent } from './types';
+export declare const yeeFormComponentMap: Record<YeeFormBuiltInComponent, Component>;
+export declare const yeeFormModelPropMap: {
+    readonly Checkbox: "checked";
+    readonly Radio: "checked";
+    readonly Switch: "checked";
+    readonly Upload: "fileList";
+};

package/dist/components/form/form-api.d.ts

@@ -1,14 +1,20 @@
 import { ShallowRef } from 'vue';
-import { YeeFormOptions, YeeFormSchema, YeeFormSchemaUpdate, YeeFormValues } from './types';
+import { YeeFormSchema, YeeFormSchemaUpdate, YeeFormValues } from './types';
 export declare class YeeFormApi<TValues extends object = YeeFormValues> {
+    /** 当前表单 Schema，由组件初始化，可通过 updateSchema 动态更新。 */
     readonly schema: ShallowRef<readonly YeeFormSchema<TValues>[]>;
     private initialValues;
     private readonly values;
-    configure(options: YeeFormOptions<TValues>): void;
-    getFieldValue(fieldName: keyof TValues & string): unknown;
+    /** 获取指定字段值，并保留 TValues 中声明的字段类型。 */
+    getFieldValue<TKey extends keyof TValues & string>(fieldName: TKey): TValues[TKey] | undefined;
+    /** 获取当前全部字段值的浅拷贝。 */
     getValues(): TValues;
+    /** 将字段值恢复为 initialValues。 */
     resetForm(): void;
-    setFieldValue(fieldName: keyof TValues & string, value: unknown): void;
+    /** 设置指定字段值，字段名和值必须与 TValues 保持一致。 */
+    setFieldValue<TKey extends keyof TValues & string>(fieldName: TKey, value: TValues[TKey]): void;
+    /** 批量更新已声明字段的值。 */
     setValues(values: Partial<TValues>): void;
+    /** 按字段名动态更新 Schema。 */
     updateSchema(updates: readonly YeeFormSchemaUpdate<TValues>[]): void;
 }

package/dist/components/form/index.d.ts

@@ -1,3 +1,3 @@
 export { default as YeeForm } from './YeeForm.vue';
 export { YeeFormApi } from './form-api';
-export type { YeeFormComponent, YeeFormOptions, YeeFormSchema, YeeFormSchemaUpdate, YeeFormValues, YeeFormProps, } from './types';
+export type { YeeFormBuiltInComponent, YeeFormComponent, YeeFormComponentPropsMap, YeeFormOptions, YeeFormSchema, YeeFormSchemaUpdate, YeeFormSlotProps, YeeFormSlots, YeeFormValues, YeeFormProps, } from './types';

package/dist/components/form/types.d.ts

@@ -1,28 +1,137 @@
-export type YeeFormComponent = 'Input' | 'RangePicker' | 'Select';
+import { AutoCompleteProps, CascaderProps, CheckboxGroupProps, CheckboxProps, DatePickerProps, InputNumberProps, InputProps, MentionsProps, RadioGroupProps, RadioProps, RateProps, SegmentedProps, SelectProps, SliderProps, SwitchProps, TextAreaProps, TimePickerProps, TimeRangePickerProps, TreeSelectProps } from 'ant-design-vue';
+import { RangePickerProps } from 'ant-design-vue/es/date-picker';
+import { VNodeChild } from 'vue';
+import { YeeFileUploadProps } from '../file-upload/types';
+/** Input.Password 在 Ant Design Vue 的 InputProps 之外提供的属性。 */
+interface YeeFormInputPasswordProps extends InputProps {
+    /** 点击图标时触发的默认动作。 */
+    action?: string;
+    /** 自定义密码显隐图标。 */
+    iconRender?: (visible: boolean) => VNodeChild;
+    /** 受控的密码可见状态。 */
+    visible?: boolean;
+    /** 是否显示密码切换按钮。 */
+    visibilityToggle?: boolean;
+    /** 密码可见状态变化事件。 */
+    'onUpdate:visible'?: (visible: boolean) => void;
+}
+/** YeeForm 当前支持的表单组件及其原生属性。 */
+export interface YeeFormComponentPropsMap {
+    AutoComplete: AutoCompleteProps;
+    Cascader: CascaderProps;
+    Checkbox: CheckboxProps;
+    CheckboxGroup: CheckboxGroupProps;
+    Custom: Record<string, unknown>;
+    DatePicker: DatePickerProps;
+    Input: InputProps;
+    InputNumber: InputNumberProps;
+    InputPassword: YeeFormInputPasswordProps;
+    Mentions: MentionsProps;
+    Radio: RadioProps;
+    RadioGroup: RadioGroupProps;
+    RangePicker: RangePickerProps;
+    Rate: RateProps;
+    Segmented: SegmentedProps;
+    Select: SelectProps;
+    Slider: SliderProps;
+    Switch: SwitchProps;
+    Textarea: TextAreaProps;
+    TimePicker: TimePickerProps;
+    TimeRangePicker: TimeRangePickerProps;
+    TreeSelect: TreeSelectProps;
+    Upload: YeeFileUploadProps;
+}
+/** YeeForm 当前支持的 Schema 组件名。 */
+export type YeeFormComponent = keyof YeeFormComponentPropsMap;
+/** YeeForm 内置渲染的组件名；Custom 由字段同名插槽渲染。 */
+export type YeeFormBuiltInComponent = Exclude<YeeFormComponent, 'Custom'>;
+/** YeeForm 默认的字段值结构；建议业务侧传入更具体的泛型。 */
 export type YeeFormValues = Record<string, unknown>;
-export interface YeeFormSchema<TValues extends object = YeeFormValues> {
-    component: YeeFormComponent;
-    componentProps?: Record<string, unknown>;
+interface YeeFormSchemaBase<TValues extends object = YeeFormValues> {
+    /** 字段名，只允许使用 TValues 中已声明的键。 */
     fieldName: keyof TValues & string;
+    /** 是否隐藏当前字段。 */
     hide?: boolean;
+    /** 字段标题。 */
     label: string;
 }
-export interface YeeFormSchemaUpdate<TValues extends object = YeeFormValues> extends Partial<Omit<YeeFormSchema<TValues>, 'fieldName'>> {
+/** 单个 Schema 字段；componentProps 会根据 component 自动提示。 */
+export type YeeFormSchema<TValues extends object = YeeFormValues> = {
+    [TComponent in YeeFormComponent]: YeeFormSchemaBase<TValues> & {
+        /** 渲染使用的表单组件。 */
+        component: TComponent;
+        /** 对应 Ant Design Vue 组件的原生属性。 */
+        componentProps?: YeeFormComponentPropsMap[TComponent];
+    };
+}[YeeFormComponent];
+interface YeeFormSchemaUpdateBase<TValues extends object = YeeFormValues> {
+    /** 需要更新的字段名。 */
     fieldName: keyof TValues & string;
+    /** 是否隐藏当前字段。 */
+    hide?: boolean;
+    /** 新的字段标题。 */
+    label?: string;
 }
+/**
+ * 动态更新 Schema 时使用的字段配置。
+ * 传入 component 时，componentProps 会自动收窄为对应组件的原生属性。
+ */
+export type YeeFormSchemaUpdate<TValues extends object = YeeFormValues> = YeeFormSchemaUpdateBase<TValues> & {
+    /** 不切换组件，只更新当前组件属性。 */
+    component?: never;
+    /** 当前组件的属性；组件类型由已有 Schema 决定。 */
+    componentProps?: YeeFormComponentPropsMap[YeeFormComponent];
+} | {
+    [TComponent in YeeFormComponent]: YeeFormSchemaUpdateBase<TValues> & {
+        /** 需要切换到的表单组件。 */
+        component: TComponent;
+        /** 对应组件的原生属性。 */
+        componentProps?: YeeFormComponentPropsMap[TComponent];
+    };
+}[YeeFormComponent];
+/** YeeForm 的运行配置。 */
 export interface YeeFormOptions<TValues extends object = YeeFormValues> {
+    /** 初始是否折叠。 */
     collapsed?: boolean;
+    /** 折叠状态下展示的行数。 */
     collapsedRows?: number;
+    /** 折叠状态变化回调。 */
     handleCollapsedChange?: (collapsed: boolean) => void;
+    /** 表单初始值。 */
     initialValues?: Partial<TValues>;
+    /** 表单字段 Schema。 */
     schema: readonly YeeFormSchema<TValues>[];
+    /** 是否显示展开/收起按钮。 */
     showCollapseButton?: boolean;
+    /** 字段变化后是否立即查询。 */
     submitOnChange?: boolean;
+    /** 是否允许按 Enter 查询。 */
     submitOnEnter?: boolean;
 }
+/** YeeForm 的公开属性。 */
 export interface YeeFormProps<TValues extends object = YeeFormValues> {
+    /** 管理字段值和 Schema 的表单 API。 */
     api: import('./form-api').YeeFormApi<TValues>;
+    /** 点击重置后的回调。 */
     onReset?: () => Promise<void> | void;
+    /** 点击查询后的回调。 */
     onSubmit?: (values: TValues) => Promise<void> | void;
+    /** 表单运行配置。 */
     options: YeeFormOptions<TValues>;
 }
+/** YeeForm 字段插槽接收的参数。 */
+export interface YeeFormSlotProps<TValues extends object = YeeFormValues, TFieldName extends keyof TValues & string = keyof TValues & string> {
+    /** 当前字段的 Schema。 */
+    field: YeeFormSchema<TValues>;
+    /** 将当前字段写回 YeeFormApi。 */
+    setValue: (value: TValues[TFieldName]) => void;
+    /** 当前字段值。 */
+    value: TValues[TFieldName] | undefined;
+    /** 当前表单全部字段值的浅拷贝。 */
+    values: TValues;
+}
+/** YeeForm 的字段同名作用域插槽。 */
+export type YeeFormSlots<TValues extends object = YeeFormValues> = {
+    [TFieldName in keyof TValues & string]?: (props: YeeFormSlotProps<TValues, TFieldName>) => unknown;
+};
+export {};

package/dist/components/grid/YeeGrid.vue.d.ts

@@ -1,115 +1,9 @@
 import { VxeGridProps } from 'vxe-table';
-import { YeeGridInternalProps } from './types';
+import { YeeGridInternalProps, YeeGridSlots } from './types';
+type __VLS_Props = YeeGridInternalProps;
 declare function __VLS_template(): {
     attrs: Partial<{}>;
-    slots: Partial<Record<string, (_: {
-        [key: string]: any;
-        $table: import('vxe-table').VxeTableConstructor<any>;
-        $grid: import('vxe-table').VxeGridConstructor<any> | null | undefined;
-        $gantt: import('vxe-pc-ui').VxeGanttConstructor<any> | null | undefined;
-        rowid: string;
-        row: any;
-        rowIndex: number;
-        $rowIndex: number;
-        _rowIndex: number;
-        column: import("vxe-table").VxeTableDefines.ColumnInfo<any>;
-        columnIndex: number;
-        $columnIndex: number;
-        _columnIndex: number;
-        option: import("vxe-table").VxeColumnPropTypes.FilterItem;
-        type: string;
-        fixed: import("vxe-table").VxeColumnPropTypes.Fixed;
-        checked: boolean;
-        indeterminate: boolean;
-        seq: string | number;
-        level: number;
-        isEdit: boolean;
-        isHidden: boolean;
-        field: string;
-        item: any;
-        data: any;
-        tooltipContent: string;
-        groupContent: string;
-        groupField: string;
-        childCount: number;
-        groupValues: number;
-        aggValue: number;
-        visibleData: any[];
-        items: any[];
-    }) => any>> & {
-        'table-title'?(_: {}): any;
-        'toolbar-actions'?(_: {
-            [key: string]: any;
-            $table: import('vxe-table').VxeTableConstructor<any>;
-            $grid: import('vxe-table').VxeGridConstructor<any> | null | undefined;
-            $gantt: import('vxe-pc-ui').VxeGanttConstructor<any> | null | undefined;
-            rowid: string;
-            row: any;
-            rowIndex: number;
-            $rowIndex: number;
-            _rowIndex: number;
-            column: import("vxe-table").VxeTableDefines.ColumnInfo<any>;
-            columnIndex: number;
-            $columnIndex: number;
-            _columnIndex: number;
-            option: import("vxe-table").VxeColumnPropTypes.FilterItem;
-            type: string;
-            fixed: import("vxe-table").VxeColumnPropTypes.Fixed;
-            checked: boolean;
-            indeterminate: boolean;
-            seq: string | number;
-            level: number;
-            isEdit: boolean;
-            isHidden: boolean;
-            field: string;
-            item: any;
-            data: any;
-            tooltipContent: string;
-            groupContent: string;
-            groupField: string;
-            childCount: number;
-            groupValues: number;
-            aggValue: number;
-            visibleData: any[];
-            items: any[];
-        }): any;
-        'toolbar-tools'?(_: {
-            [key: string]: any;
-            $table: import('vxe-table').VxeTableConstructor<any>;
-            $grid: import('vxe-table').VxeGridConstructor<any> | null | undefined;
-            $gantt: import('vxe-pc-ui').VxeGanttConstructor<any> | null | undefined;
-            rowid: string;
-            row: any;
-            rowIndex: number;
-            $rowIndex: number;
-            _rowIndex: number;
-            column: import("vxe-table").VxeTableDefines.ColumnInfo<any>;
-            columnIndex: number;
-            $columnIndex: number;
-            _columnIndex: number;
-            option: import("vxe-table").VxeColumnPropTypes.FilterItem;
-            type: string;
-            fixed: import("vxe-table").VxeColumnPropTypes.Fixed;
-            checked: boolean;
-            indeterminate: boolean;
-            seq: string | number;
-            level: number;
-            isEdit: boolean;
-            isHidden: boolean;
-            field: string;
-            item: any;
-            data: any;
-            tooltipContent: string;
-            groupContent: string;
-            groupField: string;
-            childCount: number;
-            groupValues: number;
-            aggValue: number;
-            visibleData: any[];
-            items: any[];
-        }): any;
-        empty?(_: {}): any;
-    };
+    slots: Readonly<YeeGridSlots<Record<string, unknown>>> & YeeGridSlots<Record<string, unknown>>;
     refs: {
         gridRef: (import('vxe-table').VxeGridMethods<any> & {
             $props: VxeGridProps<any> & import('vxe-table').VxeGridEventProps<any>;
@@ -119,7 +13,7 @@ declare function __VLS_template(): {
     rootEl: HTMLElement;
 };
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<YeeGridInternalProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<YeeGridInternalProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
     gridRef: (import('vxe-table').VxeGridMethods<any> & {
         $props: VxeGridProps<any> & import('vxe-table').VxeGridEventProps<any>;
         $slots: import('vxe-table').VxeGridSlots<any>;

package/dist/components/grid/index.d.ts

@@ -1,4 +1,4 @@
 export { YeeGridApi } from './yee-grid-api';
 export { useYeeGrid } from './use-yee-grid';
-export type { YeeGridPage, YeeGridQuery, YeeGridQueryParams, YeeGridToolbarConfig, YeeGridOptions, UseYeeGridOptions, } from './types';
-export type { VxeGridDefines, VxeGridListeners, VxeGridPropTypes, VxeTableDefines, } from 'vxe-table';
+export type { YeeGridComponent, YeeGridPage, YeeGridQuery, YeeGridQueryParams, YeeGridToolbarConfig, YeeGridOptions, YeeGridRuntimeProps, YeeGridSlots, UseYeeGridOptions, } from './types';
+export type { VxeGridDefines, VxeGridListeners, VxeGridPropTypes, VxeGridSlotTypes, VxeTableDefines, } from 'vxe-table';

package/dist/components/grid/types.d.ts

@@ -1,14 +1,20 @@
-import { VxeGridInstance, VxeGridListeners, VxeGridProps as NativeVxeGridProps } from 'vxe-table';
+import { VxeGridSlots, VxeGridInstance, VxeGridListeners, VxeGridProps as NativeVxeGridProps, VxeGridSlotTypes } from 'vxe-table';
+import { DefineComponent, VNodeChild } from 'vue';
 import { YeeFormOptions, YeeFormValues } from '../form';
 import { YeeGridApi } from './yee-grid-api';
 type NativeProxyConfig<T> = NonNullable<NativeVxeGridProps<T>['proxyConfig']>;
 type NativeProxyAjax<T> = NonNullable<NativeProxyConfig<T>['ajax']>;
 type NativeProxyQuery<T> = NonNullable<NativeProxyAjax<T>['query']>;
+/** VXE Grid 发起代理查询时传入的分页、排序等参数。 */
 export type YeeGridQueryParams<T> = Parameters<NativeProxyQuery<T>>[0];
+/** YeeGrid 分页查询统一返回结构。 */
 export interface YeeGridPage<T> {
+    /** 当前页数据。 */
     items: readonly T[];
+    /** 符合查询条件的数据总数。 */
     total: number;
 }
+/** YeeGrid 代理查询函数。 */
 export type YeeGridQuery<T, TFormValues extends object = YeeFormValues> = (params: YeeGridQueryParams<T>, formValues: TFormValues) => Promise<YeeGridPage<T>>;
 type YeeGridProxyAjax<T, TFormValues extends object> = Omit<NativeProxyAjax<T>, 'query'> & {
     query?: YeeGridQuery<T, TFormValues>;
@@ -17,26 +23,57 @@ type YeeGridProxyConfig<T, TFormValues extends object> = Omit<NativeProxyConfig<
     ajax?: YeeGridProxyAjax<T, TFormValues>;
 };
 type NativeToolbarConfig<T> = NonNullable<NativeVxeGridProps<T>['toolbarConfig']>;
+/** YeeGrid 工具栏配置，继承 VXE Grid ToolbarConfig。 */
 export type YeeGridToolbarConfig<T> = NativeToolbarConfig<T> & {
+    /** 是否在工具栏预留查询表单控制能力。 */
     search?: boolean;
 };
+/** YeeGrid 表格配置，完整继承 VXE Grid 并收紧查询返回值。 */
 export type YeeGridOptions<T = Record<string, unknown>, TFormValues extends object = YeeFormValues> = Omit<NativeVxeGridProps<T>, 'proxyConfig' | 'toolbarConfig'> & {
     proxyConfig?: YeeGridProxyConfig<T, TFormValues>;
     toolbarConfig?: YeeGridToolbarConfig<T>;
 };
+/** useYeeGrid 的初始化配置。 */
 export interface UseYeeGridOptions<T = Record<string, unknown>, TFormValues extends object = YeeFormValues> {
+    /** 可选的查询表单配置。 */
     formOptions?: YeeFormOptions<TFormValues>;
+    /** VXE Grid 原生事件。 */
     gridEvents?: VxeGridListeners<T>;
+    /** VXE Grid 表格配置。 */
     gridOptions: YeeGridOptions<T, TFormValues>;
+    /** 是否在查询表单和表格之间展示分隔带。 */
     separator?: boolean;
+    /** 查询表单初始是否可见。 */
     showSearchForm?: boolean;
 }
+/** useYeeGrid 返回组件可直接传入的属性。 */
 export interface YeeGridRuntimeProps {
+    /** 表格标题。 */
     tableTitle?: string;
+    /** 表格标题旁的帮助提示。 */
     tableTitleHelp?: string;
 }
-export interface YeeGridInternalProps extends YeeGridRuntimeProps {
-    api: YeeGridApi;
+/** useYeeGrid 返回组件的公开插槽。 */
+export interface YeeGridSlots<T = Record<string, unknown>> extends VxeGridSlots<T> {
+    /** 空数据状态；YeeGrid 已提供默认空态。 */
+    empty?: () => VNodeChild;
+    /** 自定义表格标题。 */
+    'table-title'?: () => VNodeChild;
+    /** 工具栏左侧操作区。 */
+    'toolbar-actions'?: (props: VxeGridSlotTypes.DefaultSlotParams<T>) => VNodeChild;
+    /** 工具栏右侧工具区。 */
+    'toolbar-tools'?: (props: VxeGridSlotTypes.DefaultSlotParams<T>) => VNodeChild;
 }
+/** useYeeGrid 返回的、携带行类型和插槽提示的组件类型。 */
+export type YeeGridComponent<T = Record<string, unknown>> = DefineComponent<YeeGridRuntimeProps> & {
+    new (): {
+        $slots: YeeGridSlots<T>;
+    };
+};
+/** YeeGrid 内部挂载属性，不属于业务页面的直接调用入口。 */
+export interface YeeGridInternalProps<T = Record<string, unknown>, TFormValues extends object = YeeFormValues> extends YeeGridRuntimeProps {
+    api: YeeGridApi<T, TFormValues>;
+}
+/** YeeGrid 内部持有的 VXE Grid 实例。 */
 export type YeeGridRef<T> = VxeGridInstance<T>;
 export {};

package/dist/components/grid/use-yee-grid.d.ts

@@ -1,5 +1,8 @@
-import { DefineComponent } from 'vue';
 import { YeeFormValues } from '../form';
 import { YeeGridApi } from './yee-grid-api';
-import { YeeGridRuntimeProps, UseYeeGridOptions } from './types';
-export declare function useYeeGrid<T = Record<string, unknown>, TFormValues extends object = YeeFormValues>(options: UseYeeGridOptions<T, TFormValues>): readonly [DefineComponent<YeeGridRuntimeProps>, YeeGridApi<T, TFormValues>];
+import { YeeGridComponent as YeeGridPublicComponent, UseYeeGridOptions } from './types';
+/**
+ * 创建类型安全的 YeeGrid 组件和控制器。
+ * T 为表格行类型，TFormValues 为查询表单字段类型。
+ */
+export declare function useYeeGrid<T = Record<string, unknown>, TFormValues extends object = YeeFormValues>(options: UseYeeGridOptions<T, TFormValues>): readonly [YeeGridPublicComponent<T>, YeeGridApi<T, TFormValues>];

package/dist/components/grid/yee-grid-api.d.ts

@@ -1,18 +1,26 @@
 import { ShallowRef } from 'vue';
 import { YeeFormApi, YeeFormValues } from '../form';
-import { YeeGridOptions, YeeGridRef, UseYeeGridOptions } from './types';
+import { YeeGridOptions, UseYeeGridOptions } from './types';
+/** useYeeGrid 返回的表格控制器。 */
 export declare class YeeGridApi<T = Record<string, unknown>, TFormValues extends object = YeeFormValues> {
+    /** 查询表单控制器。 */
     readonly formApi: YeeFormApi<TFormValues>;
+    /** 查询表单当前是否可见。 */
     readonly searchFormVisible: ShallowRef<boolean>;
+    /** 当前 Grid 初始化配置。 */
     readonly state: ShallowRef<UseYeeGridOptions<T, TFormValues>>;
     private grid;
     constructor(options: UseYeeGridOptions<T, TFormValues>);
-    mount(grid: YeeGridRef<T>): void;
+    /** 保留当前页码并执行查询，可在查询前合并表单值。 */
     query: (values?: Partial<TFormValues>) => Promise<unknown>;
+    /** 回到第一页并重新查询，可在查询前合并表单值。 */
     reload: (values?: Partial<TFormValues>) => Promise<unknown>;
+    /** 合并更新 VXE Grid 配置。 */
     setGridOptions(options: Partial<YeeGridOptions<T, TFormValues>>): void;
+    /** 设置表格加载状态。 */
     setLoading(loading: boolean): void;
+    /** 合并更新 useYeeGrid 初始化配置。 */
     setState(state: Partial<UseYeeGridOptions<T, TFormValues>>): void;
+    /** 切换查询表单显隐，并返回切换后的状态。 */
     toggleSearchForm(show?: boolean): boolean;
-    unmount(): void;
 }

package/dist/components/modal/YeeModal.vue.d.ts

@@ -1,22 +1,11 @@
-import { VNodeChild } from 'vue';
-import { YeeModalProps } from './types';
-type __VLS_Props = YeeModalProps;
+import { YeeModalOwnProps, YeeModalSlots } from './types';
+type __VLS_Props = YeeModalOwnProps;
 type __VLS_PublicProps = {
     'open'?: boolean;
 } & __VLS_Props;
 declare function __VLS_template(): {
     attrs: Partial<{}>;
-    slots: Readonly<{
-        closeIcon(): VNodeChild;
-        default(): VNodeChild;
-        footer(): VNodeChild;
-        header(): VNodeChild;
-    }> & {
-        closeIcon(): VNodeChild;
-        default(): VNodeChild;
-        footer(): VNodeChild;
-        header(): VNodeChild;
-    };
+    slots: Readonly<YeeModalSlots> & YeeModalSlots;
     refs: {};
     rootEl: any;
 };

package/dist/components/modal/index.d.ts

@@ -1,2 +1,3 @@
-export { default as YeeModal } from './YeeModal.vue';
-export type { YeeModalProps, YeeModalType } from './types';
+import { YeeModalComponent as YeeModalPublicComponent } from './types';
+export declare const YeeModal: YeeModalPublicComponent;
+export type { YeeModalComponent, YeeModalEmits, YeeModalProps, YeeModalSlots, YeeModalType, } from './types';

package/dist/components/modal/types.d.ts

@@ -1,21 +1,83 @@
-import { StyleValue } from 'vue';
+import { DrawerProps, ModalProps } from 'ant-design-vue';
+import { ComponentOptionsMixin, DefineComponent, StyleValue, VNodeChild } from 'vue';
+/** YeeModal 支持的容器形态。 */
 export type YeeModalType = 'drawer' | 'modal';
-export interface YeeModalProps {
+/** YeeModal 自身管理的属性。 */
+export interface YeeModalOwnProps {
+    /** 取消按钮文案。 */
     cancelButtonText?: string;
+    /** Modal 是否垂直居中；Drawer 模式忽略此项。 */
     centered?: boolean;
+    /** 是否显示关闭按钮。 */
     closable?: boolean;
+    /** 确认按钮加载状态。 */
     confirmButtonLoading?: boolean;
+    /** 确认按钮文案。 */
     confirmButtonText?: string;
+    /** 关闭后是否销毁内容。 */
     destroyOnClose?: boolean;
+    /** Modal 是否全屏；Drawer 模式忽略此项。 */
     fullscreen?: boolean;
+    /** 是否显示全屏切换按钮。 */
     fullscreenButton?: boolean;
+    /** 是否允许按 Esc 关闭。 */
     keyboard?: boolean;
+    /** 点击遮罩是否关闭。 */
     maskClosable?: boolean;
+    /** 打开状态，支持 v-model:open。 */
+    open?: boolean;
+    /** 是否显示取消按钮。 */
     showCancelButton?: boolean;
+    /** 是否显示确认按钮。 */
     showConfirmButton?: boolean;
+    /** Modal 或 Drawer 根节点样式。 */
     style?: StyleValue;
+    /** 标题。 */
     title?: string;
+    /** 容器类型。 */
     type?: YeeModalType;
+    /** 宽度。 */
     width?: number | string;
+    /** Dialog 根节点的无障碍属性。 */
     wrapProps?: Record<string, unknown>;
 }
+type YeeModalManagedProp = 'afterClose' | 'cancelText' | 'centered' | 'closable' | 'closeIcon' | 'confirmLoading' | 'destroyOnClose' | 'footer' | 'keyboard' | 'maskClosable' | 'onCancel' | 'onClose' | 'onOk' | 'onUpdate:open' | 'open' | 'style' | 'title' | 'visible' | 'width' | 'wrapProps';
+/**
+ * YeeModal 的完整公开属性。
+ * 除组件自身管理的属性外，同时提供 Ant Design Vue Modal/Drawer 的透传属性提示。
+ */
+export type YeeModalProps = YeeModalOwnProps & Omit<ModalProps, YeeModalManagedProp> & Partial<Omit<DrawerProps, YeeModalManagedProp | keyof ModalProps>>;
+/** YeeModal 的公开事件。 */
+export type YeeModalEmits = {
+    /** 用户执行取消或关闭操作时触发。 */
+    cancel: [event: Event];
+    /** 弹层关闭动画结束后触发。 */
+    close: [];
+    /** 用户点击确认按钮时触发，弹层是否关闭由父组件决定。 */
+    confirm: [event: Event];
+    /** 全屏状态变化时触发。 */
+    'update:fullscreen': [fullscreen: boolean];
+    /** 打开状态变化时触发。 */
+    'update:open': [open: boolean];
+};
+type YeeModalEmitOptions = {
+    [TEvent in keyof YeeModalEmits]: (...args: YeeModalEmits[TEvent]) => void;
+};
+/** YeeModal 的公开插槽。 */
+export interface YeeModalSlots {
+    /** 自定义关闭图标。 */
+    closeIcon?: () => VNodeChild;
+    /** 弹层主体内容。 */
+    default?: () => VNodeChild;
+    /** 自定义底部操作区。 */
+    footer?: () => VNodeChild;
+    /** 自定义标题区域。 */
+    header?: () => VNodeChild;
+}
+/** 带完整 Props、Events 和 Slots 提示的 YeeModal 组件类型。 */
+export type YeeModalComponent = DefineComponent<YeeModalProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, YeeModalEmitOptions> & {
+    new (): {
+        $slots: YeeModalSlots;
+    };
+};
+export {};