@yeepay/yee-boss-ui 0.1.13 → 0.1.15

package/README.md

@@ -74,6 +74,22 @@ import '@yeepay/yee-boss-ui/theme.css'
 
 `--yee-radius`、`--yee-radius-lg` 与 `--yee-radius-sm` 默认分别为 `4px`、`8px` 与 `2px`。公共组件使用基础圆角，Ant Design Vue 映射按对应尺寸消费这组语义化变量；需要特殊圆角时由 Portal 通过 `theme.tokens` 显式覆盖。
 
+## TypeScript 类型
+
+组件的公共类型都可以从包根入口导入。命名统一使用 `组件名 + Props / Emits / Slots`；存在组件实例方法时额外提供 `Expose`，例如 `YeeFileUploadExpose`。公共字段带中文 JSDoc，业务项目在编写 Props、监听事件、使用插槽或组件 `ref` 时可以直接获得 IDE 提示。
+
+```ts
+import type {
+  YeeFileUploadEmits,
+  YeeFileUploadExpose,
+  YeeGridSlots,
+  YeeModalProps,
+  YeeSelectProps,
+} from '@yeepay/yee-boss-ui'
+```
+
+`YeeModal` 和 `YeeSelect` 的 Props 同时包含 Ant Design Vue 原生透传属性。`useYeeGrid<Row, QueryValues>` 会把行类型传递给列、事件、查询函数和具名插槽，不需要在页面中重复断言类型。
+
 ## Tailwind CSS
 
 ```js
@@ -122,21 +138,71 @@ export default {
     { label: '订单号', name: 'orderNo', value: orderNo, copyable: true },
     { label: '状态', name: 'status', value: status },
   ]"
-/>
+>
+  <template #content-status="{ item }">
+    <span>{{ item.value }}</span>
+  </template>
+</YeeDescriptions>
 ```
 
 ### YeeFileUpload
 
 组件不接受上传 URL，也不依赖业务请求客户端。自动上传由 `customRequest` 完成；手动模式监听 `file-select`，完成后调用组件实例的 `addResult(uid, { url, name? })` 或 `addError(uid)`。
 
+自动上传模式通过回调接入项目统一请求层：
+
+```ts
+import type { YeeUploadRequestOptions } from '@yeepay/yee-boss-ui'
+
+async function uploadFile(options: YeeUploadRequestOptions): Promise<void> {
+  try {
+    const result = await uploadAttachment(options.file, options.onProgress)
+    options.onSuccess({ name: result.name, url: result.url })
+  }
+  catch (error) {
+    options.onError(error instanceof Error ? error : new Error('上传失败'))
+  }
+}
+```
+
+手动模式适合先选择文件，再由页面决定何时请求或回写结果：
+
 ```vue
-<YeeFileUpload
-  v-model:file-list="fileList"
-  :custom-request="uploadFile"
-  @file-removed="removeFile"
-/>
+<script setup lang="ts">
+import { shallowRef } from 'vue'
+import {
+  YeeFileUpload,
+  type YeeFileSelectPayload,
+  type YeeFileUploadExpose,
+  type YeeUploadFile,
+} from '@yeepay/yee-boss-ui'
+
+const uploadRef = shallowRef<YeeFileUploadExpose>()
+const fileList = shallowRef<YeeUploadFile[]>([])
+
+async function handleFileSelect({ file, uid }: YeeFileSelectPayload): Promise<void> {
+  try {
+    const result = await uploadAttachment(file)
+    uploadRef.value?.addResult(uid, { name: result.name, url: result.url })
+  }
+  catch {
+    uploadRef.value?.addError(uid)
+  }
+}
+</script>
+
+<template>
+  <YeeFileUpload
+    ref="uploadRef"
+    v-model:file-list="fileList"
+    manual
+    @file-select="handleFileSelect"
+  />
+</template>
 ```
 
+组件实例还提供 `getFiles()`，用于读取当前列表中的原始 `File[]`。
+
 ### YeeFilePreview
 
 `YeeFilePreview` 不依赖业务请求层，支持传入文件地址、`Blob`、`File` 或 `ArrayBuffer`。解析器由组件库统一提供，并按文件类型动态加载；消费者不需要额外安装 `xlsx`、`docx-preview`、`postal-mime` 等解析依赖。
@@ -144,11 +210,19 @@ export default {
 ```vue
 <script setup lang="ts">
 import { ref } from 'vue'
-import { YeeFilePreview } from '@yeepay/yee-boss-ui'
+import {
+  YeeFilePreview,
+  type YeeFilePreviewError,
+  type YeeFilePreviewLoadResult,
+} from '@yeepay/yee-boss-ui'
 
 const source = ref<string | Blob>('https://example.com/report.pdf')
 
-function handlePreviewError(error: { message: string }): void {
+function handlePreviewLoad(result: YeeFilePreviewLoadResult): void {
+  console.info(result.kind, result.fileName)
+}
+
+function handlePreviewError(error: YeeFilePreviewError): void {
   console.error(error.message)
 }
 </script>
@@ -159,6 +233,7 @@ function handlePreviewError(error: { message: string }): void {
     :max-file-size="50 * 1024 * 1024"
     height="640"
     @error="handlePreviewError"
+    @load="handlePreviewLoad"
   />
 </template>
 ```
@@ -174,22 +249,147 @@ function handlePreviewError(error: { message: string }): void {
 使用标准 `v-model:open`。Modal 默认在 header 右侧显示全屏切换按钮，可通过 `v-model:fullscreen` 控制状态，或通过 `:fullscreen-button="false"` 隐藏。`type="drawer"` 适合长详情或复杂表单，不显示全屏按钮；`confirm` 只通知父组件，不会主动关闭，便于父组件在异步提交成功后再更新 `open`。
 
 ```vue
-<YeeModal
-  v-model:fullscreen="fullscreen"
-  v-model:open="open"
-  title="提交确认"
-  @confirm="submit"
-/>
+<script setup lang="ts">
+import { shallowRef } from 'vue'
+import { YeeModal } from '@yeepay/yee-boss-ui'
+
+const open = shallowRef(false)
+const submitting = shallowRef(false)
+
+async function submit(): Promise<void> {
+  submitting.value = true
+  try {
+    await saveForm()
+    open.value = false
+  }
+  finally {
+    submitting.value = false
+  }
+}
+</script>
+
+<template>
+  <YeeModal
+    v-model:open="open"
+    :confirm-button-loading="submitting"
+    title="提交确认"
+    @confirm="submit"
+  >
+    确认提交当前内容？
+  </YeeModal>
+</template>
 ```
 
+Drawer 模式使用 `<YeeModal v-model:open="open" type="drawer" placement="right">`，`placement`、`getContainer`、`zIndex` 等原生属性会继续透传。
+
 ### YeeSelect
 
 `YeeSelect` 保持 Ant Design Vue `Select` 的透传能力，并针对当前选中项和默认 option 提供完整文案提示。
 
 ```vue
-<YeeSelect v-model:value="status" :options="statusOptions" />
+<script setup lang="ts">
+import { shallowRef } from 'vue'
+import {
+  YeeSelect,
+  type YeeSelectExpose,
+  type YeeSelectOption,
+  type YeeSelectValue,
+} from '@yeepay/yee-boss-ui'
+
+const status = shallowRef<YeeSelectValue>()
+const selectRef = shallowRef<YeeSelectExpose>()
+const statusOptions: YeeSelectOption[] = [
+  { label: '成功', value: 'SUCCESS' },
+  { label: '失败', value: 'FAILED' },
+]
+
+function focusSelect(): void {
+  selectRef.value?.focus()
+}
+</script>
+
+<template>
+  <YeeSelect
+    ref="selectRef"
+    v-model:value="status"
+    allow-clear
+    show-search
+    :options="statusOptions"
+  >
+    <template #option="option">
+      {{ option.label }}
+    </template>
+  </YeeSelect>
+  <a-button @click="focusSelect">
+    聚焦选择器
+  </a-button>
+</template>
+```
+
+通过 `YeeSelectExpose` 可以调用 `focus()`、`blur()` 和 `scrollTo()`。`change`、`select`、`deselect`、`search`、`clear`、`focus`、`blur`、`popupScroll`、`dropdownVisibleChange` 等原生事件均有参数提示；`option`、`optionLabel`、`tagRender`、`dropdownRender`、`maxTagPlaceholder` 等作用域插槽也会提示对应参数。
+
+### YeeForm
+
+`YeeForm` 可以独立使用，也会在 `useYeeGrid` 配置 `formOptions` 后自动挂载。Schema 的 `component` 是判别字段，选择组件后，`componentProps` 会提示对应 Ant Design Vue 组件或 `YeeFileUpload` 的原生属性。
+
+内置支持：`AutoComplete`、`Cascader`、`Checkbox`、`CheckboxGroup`、`DatePicker`、`Input`、`InputNumber`、`InputPassword`、`Mentions`、`Radio`、`RadioGroup`、`RangePicker`、`Rate`、`Segmented`、`Select`、`Slider`、`Switch`、`Textarea`、`TimePicker`、`TimeRangePicker`、`TreeSelect` 和 `Upload`。
+
+```vue
+<script setup lang="ts">
+import {
+  YeeForm,
+  YeeFormApi,
+  type YeeFormOptions,
+} from '@yeepay/yee-boss-ui'
+
+interface QueryValues {
+  channel?: 'OFFLINE' | 'ONLINE'
+  enabled?: boolean
+  orderNo?: string
+}
+
+const formApi = new YeeFormApi<QueryValues>()
+const formOptions: YeeFormOptions<QueryValues> = {
+  schema: [
+    {
+      component: 'Input',
+      componentProps: { allowClear: true, placeholder: '请输入订单号' },
+      fieldName: 'orderNo',
+      label: '订单号',
+    },
+    {
+      component: 'Switch',
+      fieldName: 'enabled',
+      label: '是否启用',
+    },
+    {
+      component: 'Custom',
+      fieldName: 'channel',
+      label: '业务渠道',
+    },
+  ],
+}
+
+function query(values: QueryValues): void {
+  console.info(values.orderNo)
+}
+</script>
+
+<template>
+  <YeeForm :api="formApi" :on-submit="query" :options="formOptions">
+    <template #channel="{ field, setValue, value, values }">
+      <button type="button" @click="setValue(value === 'ONLINE' ? 'OFFLINE' : 'ONLINE')">
+        {{ field.label }}：{{ values.channel ?? '未选择' }}
+      </button>
+    </template>
+  </YeeForm>
+</template>
 ```
 
+字段同名插槽可以覆盖任意内置组件；只使用自定义内容时，将 `component` 设置为 `Custom`。插槽提供 `field`、`value`、`values` 和 `setValue`，其中字段值会根据 `QueryValues` 自动提示类型，并统一写回 `YeeFormApi`。
+
+`YeeFormApi` 提供 `getFieldValue`、`getValues`、`setFieldValue`、`setValues`、`resetForm` 和 `updateSchema`；字段名和值会保持 `QueryValues` 中声明的类型。
+
 ## YeePage 与 VXE Grid
 
 `YeePage auto-content-height` 会使用宿主布局提供的 `--yee-content-height` 作为可选内容区高度；未注入时按 Page 父容器的 `100%` 计算，适合 Wujie 等嵌入场景。`heightOffset` 会从 Page 的整体高度中扣除宿主额外占用的空间。宿主如果需要注入该变量，可使用导出的 `CSS_VARIABLE_LAYOUT_CONTENT_HEIGHT` 常量。
@@ -227,7 +427,13 @@ const formOptions: YeeFormOptions<QueryValues> = {
 }
 
 const gridOptions: YeeGridOptions<OrderItem, QueryValues> = {
-  columns: [{ field: 'orderNo', title: '订单号' }],
+  columns: [
+    {
+      field: 'orderNo',
+      title: '订单号',
+      slots: { default: 'orderNo' },
+    },
+  ],
   pagerConfig: {},
   proxyConfig: {
     ajax: {
@@ -247,16 +453,38 @@ const [YeeGrid, gridApi] = useYeeGrid({
   gridOptions,
 })
 
+function openDetail(row: OrderItem): void {
+  console.info(row.orderNo)
+}
+
+function createOrder(): void {
+  console.info('create order')
+}
+
 defineExpose({ reload: gridApi.reload })
 </script>
 
 <template>
   <yee-page auto-content-height>
-    <yee-grid table-title="订单明细" />
+    <yee-grid table-title="订单明细">
+      <template #orderNo="{ row }">
+        <a-button type="link" @click="openDetail(row)">
+          {{ row.orderNo }}
+        </a-button>
+      </template>
+
+      <template #toolbar-tools>
+        <a-button type="primary" @click="createOrder">
+          新增
+        </a-button>
+      </template>
+    </yee-grid>
   </yee-page>
 </template>
 ```
 
+`table-title`、`toolbar-actions`、`toolbar-tools` 以及列配置中的具名插槽都有类型提示，其中列插槽的 `row` 会保持 `OrderItem` 类型。`YeeGridApi` 提供 `query`、`reload`、`setGridOptions`、`setLoading`、`setState` 和 `toggleSearchForm`。
+
 组件的 TypeScript 导出使用 `YeeForm`、`YeeGrid`、`YeePage`，Vue 模板标签对应 `yee-form`、`yee-grid`、`yee-page`。新代码统一使用 `useYeeGrid`，不提供旧命名兼容别名。查询接口统一返回 `{ items, total }`。
 
 ## 开发

package/dist/components/PlatformConfigProvider.vue.d.ts

@@ -1,18 +1,13 @@
-import { PlatformTheme } from '../theme/types';
-interface Props {
-    theme?: PlatformTheme;
-}
+import { PlatformConfigProviderProps, PlatformConfigProviderSlots } from './platform-config-provider/types';
 declare function __VLS_template(): {
     attrs: Partial<{}>;
-    slots: {
-        default?(_: {}): any;
-    };
+    slots: Readonly<PlatformConfigProviderSlots> & PlatformConfigProviderSlots;
     refs: {};
     rootEl: any;
 };
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {
-    theme: PlatformTheme;
+declare const __VLS_component: import('vue').DefineComponent<PlatformConfigProviderProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<PlatformConfigProviderProps> & Readonly<{}>, {
+    theme: import('..').PlatformTheme;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 export default _default;

package/dist/components/descriptions/YeeDescriptions.vue.d.ts

@@ -1,16 +1,14 @@
-import { YeeDescriptionItem, YeeDescriptionsProps } from './types';
+import { YeeDescriptionsProps } from './types';
 declare function __VLS_template(): {
     attrs: Partial<{}>;
-    slots: Partial<Record<`content-${string}`, (_: {
-        item: YeeDescriptionItem;
-    }) => any>> & Partial<Record<`content-${string}`, (_: {
-        item: YeeDescriptionItem;
-    }) => any>>;
+    slots: Readonly<Partial<Record<`content-${string}`, (props: import('./types').YeeDescriptionContentSlotProps) => import('vue').VNodeChild>>> & Partial<Record<`content-${string}`, (props: import('./types').YeeDescriptionContentSlotProps) => import('vue').VNodeChild>>;
     refs: {};
     rootEl: any;
 };
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<YeeDescriptionsProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<YeeDescriptionsProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const __VLS_component: import('vue').DefineComponent<YeeDescriptionsProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<YeeDescriptionsProps> & Readonly<{}>, {
+    colon: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {

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

@@ -1,2 +1,2 @@
 export { default as YeeDescriptions } from './YeeDescriptions.vue';
-export type { YeeDescriptionItem, YeeDescriptionsProps } from './types';
+export type { YeeDescriptionContentSlotProps, YeeDescriptionItem, YeeDescriptionsProps, YeeDescriptionsSlots, } from './types';

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

@@ -1,20 +1,44 @@
-import { StyleValue } from 'vue';
+import { StyleValue, VNodeChild } from 'vue';
+/** 详情展示中的单个字段配置。 */
 export interface YeeDescriptionItem {
+    /** 是否显示复制按钮。 */
     copyable?: boolean;
+    /** 是否对过长内容显示省略 Tooltip。 */
     ellipsis?: boolean;
+    /** 字段值下方的补充说明。 */
     info?: string;
+    /** 补充说明的自定义样式。 */
     infoStyle?: StyleValue;
+    /** 字段标题。 */
     label: string;
+    /** 稳定字段名，同时用于生成 content-${name} 插槽名。 */
     name?: string;
+    /** 字段横跨的列数。 */
     span?: number;
+    /** 默认展示值。 */
     value: unknown;
 }
+/** YeeDescriptions 的公开属性。 */
 export interface YeeDescriptionsProps {
+    /** 是否显示边框。 */
     bordered?: boolean;
+    /** 是否在字段标题后显示冒号。 */
     colon?: boolean;
+    /** 每行展示的字段列数。 */
     column?: number;
+    /** 详情字段列表。 */
     items: readonly YeeDescriptionItem[];
+    /** 字段标题和值的排列方式。 */
     layout?: 'horizontal' | 'vertical';
+    /** 组件尺寸。 */
     size?: 'default' | 'middle' | 'small';
+    /** 详情区域标题。 */
     title?: string;
 }
+/** 动态内容插槽接收的参数。 */
+export interface YeeDescriptionContentSlotProps {
+    /** 当前字段配置。 */
+    item: YeeDescriptionItem;
+}
+/** YeeDescriptions 的公开插槽，名称格式为 content-${字段 name}。 */
+export type YeeDescriptionsSlots = Partial<Record<`content-${string}`, (props: YeeDescriptionContentSlotProps) => VNodeChild>>;

package/dist/components/ellipsis-text/YeeEllipsisText.vue.d.ts

@@ -1,14 +1,8 @@
 import { CSSProperties } from 'vue';
-import { YeeEllipsisTextProps } from './types';
+import { YeeEllipsisTextProps, YeeEllipsisTextSlots } from './types';
 declare function __VLS_template(): {
     attrs: Partial<{}>;
-    slots: Readonly<{
-        default?(): unknown;
-        tooltip?(): unknown;
-    }> & {
-        default?(): unknown;
-        tooltip?(): unknown;
-    };
+    slots: Readonly<YeeEllipsisTextSlots> & YeeEllipsisTextSlots;
     refs: {
         text: HTMLDivElement;
     };

package/dist/components/ellipsis-text/index.d.ts

@@ -1,2 +1,2 @@
 export { default as YeeEllipsisText } from './YeeEllipsisText.vue';
-export type { YeeEllipsisTextEmits, YeeEllipsisTextPlacement, YeeEllipsisTextProps, } from './types';
+export type { YeeEllipsisTextEmits, YeeEllipsisTextPlacement, YeeEllipsisTextProps, YeeEllipsisTextSlots, } from './types';

package/dist/components/ellipsis-text/types.d.ts

@@ -1,5 +1,7 @@
-import { CSSProperties } from 'vue';
+import { CSSProperties, VNodeChild } from 'vue';
+/** Tooltip 相对文本的展示位置。 */
 export type YeeEllipsisTextPlacement = 'bottom' | 'left' | 'right' | 'top';
+/** YeeEllipsisText 的公开属性。 */
 export interface YeeEllipsisTextProps {
     /** 是否允许点击文本展开全部内容。 */
     expand?: boolean;
@@ -26,6 +28,15 @@ export interface YeeEllipsisTextProps {
     /** 是否仅在文本实际被截断时启用 Tooltip。 */
     tooltipWhenEllipsis?: boolean;
 }
+/** YeeEllipsisText 的公开事件。 */
 export interface YeeEllipsisTextEmits {
+    /** 展开状态变化时触发。 */
     expandChange: [expanded: boolean];
 }
+/** YeeEllipsisText 的公开插槽。 */
+export interface YeeEllipsisTextSlots {
+    /** 需要省略展示的文本内容。 */
+    default?: () => VNodeChild;
+    /** Tooltip 中展示的完整内容；未传时复用 default。 */
+    tooltip?: () => VNodeChild;
+}

package/dist/components/file-preview/YeeFilePreview.vue.d.ts

@@ -1,13 +1,13 @@
-import { YeeFilePreviewError, YeeFilePreviewLoadResult, YeeFilePreviewProps } from './types';
+import { YeeFilePreviewError, YeeFilePreviewProps } from './types';
 declare const _default: import('vue').DefineComponent<YeeFilePreviewProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     error: (error: YeeFilePreviewError) => any;
     unsupported: (error: YeeFilePreviewError) => any;
-    load: (result: YeeFilePreviewLoadResult) => any;
+    load: (result: import('./types').YeeFilePreviewLoadResult) => any;
     download: () => any;
 }, string, import('vue').PublicProps, Readonly<YeeFilePreviewProps> & Readonly<{
     onError?: (error: YeeFilePreviewError) => any;
     onUnsupported?: (error: YeeFilePreviewError) => any;
-    onLoad?: (result: YeeFilePreviewLoadResult) => any;
+    onLoad?: (result: import('./types').YeeFilePreviewLoadResult) => any;
     onDownload?: () => any;
 }>, {
     maxFileSize: number | undefined;

package/dist/components/file-preview/index.d.ts

@@ -1,2 +1,2 @@
 export { default as YeeFilePreview } from './YeeFilePreview.vue';
-export type { YeeFilePreviewError, YeeFilePreviewKind, YeeFilePreviewProps, YeeFilePreviewSource, YeeFilePreviewStatus, YeeFilePreviewTableRow, } from './types';
+export type { YeeFilePreviewEmits, YeeFilePreviewEmailMeta, YeeFilePreviewError, YeeFilePreviewKind, YeeFilePreviewLoadResult, YeeFilePreviewProps, YeeFilePreviewSource, YeeFilePreviewStatus, YeeFilePreviewTableRow, } from './types';

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

@@ -1,32 +1,70 @@
+/** 可直接交给 YeeFilePreview 的文件来源。 */
 export type YeeFilePreviewSource = string | Blob | File | ArrayBuffer;
+/** YeeFilePreview 当前支持识别的文件类型。 */
 export type YeeFilePreviewKind = 'image' | 'pdf' | 'text' | 'json' | 'xml' | 'csv' | 'markdown' | 'html' | 'video' | 'audio' | 'docx' | 'spreadsheet' | 'eml' | 'unsupported';
+/** 文件预览的加载状态。 */
 export type YeeFilePreviewStatus = 'idle' | 'loading' | 'ready' | 'error' | 'unsupported';
+/** YeeFilePreview 的公开属性。 */
 export interface YeeFilePreviewProps {
+    /** 文件地址、Blob、File 或 ArrayBuffer。 */
     source?: YeeFilePreviewSource | undefined;
+    /** 兼容只提供文件地址的调用方式，优先推荐 source。 */
     url?: string | undefined;
+    /** 用于格式识别和下载的文件名。 */
     fileName?: string | undefined;
+    /** 用于格式识别的 MIME 类型或扩展名。 */
     fileType?: string | undefined;
+    /** 预览区域高度，数字按 px 处理。 */
     height?: string | number | undefined;
+    /** 允许解析的最大文件字节数。 */
     maxFileSize?: number | undefined;
+    /** 表格预览最多展示的行数。 */
     maxRows?: number | undefined;
+    /** 表格预览最多展示的列数。 */
     maxColumns?: number | undefined;
+    /** 是否显示文件名和工具栏。 */
     showHeader?: boolean | undefined;
+    /** 是否显示下载按钮。 */
     showDownload?: boolean | undefined;
+    /** 图片预览的替代文本。 */
     alt?: string | undefined;
 }
+/** 表格文件解析后的单行数据。 */
 export interface YeeFilePreviewTableRow {
+    /** 当前行的单元格文本。 */
     cells: string[];
 }
+/** 文件预览失败或不支持时的错误信息。 */
 export interface YeeFilePreviewError {
+    /** 当前识别到的文件类型。 */
     kind: YeeFilePreviewKind;
+    /** 可直接展示给用户的错误信息。 */
     message: string;
+    /** 原始异常。 */
     cause?: unknown;
 }
+/** 文件成功加载后的事件参数。 */
 export interface YeeFilePreviewLoadResult {
+    /** 当前文件类型。 */
     kind: YeeFilePreviewKind;
+    /** 最终解析出的文件名。 */
     fileName: string;
 }
+/** EML 文件解析后的头部字段。 */
 export interface YeeFilePreviewEmailMeta {
+    /** 字段标题。 */
     label: string;
+    /** 字段内容。 */
     value: string;
 }
+/** YeeFilePreview 的公开事件。 */
+export interface YeeFilePreviewEmits {
+    /** 用户触发下载后触发。 */
+    download: [];
+    /** 文件加载或解析失败时触发。 */
+    error: [error: YeeFilePreviewError];
+    /** 文件成功加载后触发。 */
+    load: [result: YeeFilePreviewLoadResult];
+    /** 文件类型暂不支持在线预览时触发。 */
+    unsupported: [error: YeeFilePreviewError];
+}

package/dist/components/file-upload/YeeFileUpload.vue.d.ts

@@ -1,26 +1,17 @@
 import { YeeFileUploadProps, YeeUploadResult } from './types';
-declare function addResult(uid: string, result: Required<Pick<YeeUploadResult, 'url'>> & YeeUploadResult): void;
-declare function addError(uid: string): void;
-declare function getFiles(): File[];
 declare const _default: import('vue').DefineComponent<YeeFileUploadProps, {
-    addError: typeof addError;
-    addResult: typeof addResult;
-    getFiles: typeof getFiles;
+    addError: (uid: string) => void;
+    addResult: (uid: string, result: Required<Pick<YeeUploadResult, "url">> & YeeUploadResult) => void;
+    getFiles: () => File[];
 }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     fileRemoved: (file: import('ant-design-vue').UploadFile<unknown>) => any;
-    fileSelect: (payload: {
-        file: File;
-        uid: string;
-    }) => any;
+    fileSelect: (payload: import('./types').YeeFileSelectPayload) => any;
     "update:fileList": (fileList: import('ant-design-vue').UploadFile<unknown>[]) => any;
     uploadSuccess: () => any;
     uploadingChange: (isUploading: boolean) => any;
 }, string, import('vue').PublicProps, Readonly<YeeFileUploadProps> & Readonly<{
     onFileRemoved?: (file: import('ant-design-vue').UploadFile<unknown>) => any;
-    onFileSelect?: (payload: {
-        file: File;
-        uid: string;
-    }) => any;
+    onFileSelect?: (payload: import('./types').YeeFileSelectPayload) => any;
     "onUpdate:fileList"?: (fileList: import('ant-design-vue').UploadFile<unknown>[]) => any;
     onUploadSuccess?: () => any;
     onUploadingChange?: (isUploading: boolean) => any;

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

@@ -1,2 +1,2 @@
 export { default as YeeFileUpload } from './YeeFileUpload.vue';
-export type { YeeFileUploadProps, YeeUploadFile, YeeUploadRequestOptions, YeeUploadResult, } from './types';
+export type { YeeFileSelectPayload, YeeFileUploadEmits, YeeFileUploadExpose, YeeFileUploadProps, YeeUploadFile, YeeUploadRequestOptions, YeeUploadResult, } from './types';