@yeepay/yee-boss-ui 0.1.6 → 0.1.8

package/README.md

@@ -15,6 +15,7 @@
 - `YeeForm` Schema 查询表单。
 - `useYeeGrid` 与 `gridApi/formApi`。
 - `YeeDescriptions` 配置驱动的详情展示。
+- `YeeEllipsisText` 单行/多行省略文本与按需完整提示。
 - `YeeFileUpload` 业务无关的文件选择与上传生命周期。
 - `YeeModal` 统一的 Modal / Drawer 容器。
 - `YeeSelect` 带完整文案提示的选择器。
@@ -89,6 +90,27 @@ export default {
 
 ## 通用业务组件
 
+### YeeEllipsisText
+
+通过 `line` 和 `maxWidth` 控制单行或多行省略；`tooltipWhenEllipsis` 开启后，仅在文本实际被截断时显示 Tooltip。`expand` 支持鼠标、Enter 和 Space 展开/收起，并通过 `expandChange` 通知状态变化。
+
+```vue
+<YeeEllipsisText
+  :line="2"
+  :max-width="360"
+  expand
+  tooltip-when-ellipsis
+  @expand-change="handleExpandChange"
+>
+  {{ remark }}
+  <template #tooltip>
+    完整备注：{{ remark }}
+  </template>
+</YeeEllipsisText>
+```
+
+`placement` 支持 `top`、`right`、`bottom`、`left`；`ellipsisThreshold` 默认是 `3px`。还可使用 `tooltipMaxWidth`、`tooltipOverlayStyle`、`tooltipBackgroundColor`、`tooltipColor` 和 `tooltipFontSize` 调整提示内容。默认背景、文字和字号消费 Yee 的 `popover`、`popoverForeground` 与 `fontSize` Theme Tokens；未使用 `PlatformConfigProvider` 时回退到对应的 `--yee-*` CSS Variables。
+
 ### YeeDescriptions
 
 配置项使用稳定的 `name` 时，可通过 `content-${name}` 覆盖内容。`copyable` 仅复制展示值，`info` 用于补充说明。
@@ -115,6 +137,38 @@ export default {
 />
 ```
 
+### YeeFilePreview
+
+`YeeFilePreview` 不依赖业务请求层，支持传入文件地址、`Blob`、`File` 或 `ArrayBuffer`。解析器由组件库统一提供，并按文件类型动态加载；消费者不需要额外安装 `xlsx`、`docx-preview`、`postal-mime` 等解析依赖。
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue'
+import { YeeFilePreview } from '@yeepay/yee-boss-ui'
+
+const source = ref<string | Blob>('https://example.com/report.pdf')
+
+function handlePreviewError(error: { message: string }): void {
+  console.error(error.message)
+}
+</script>
+
+<template>
+  <YeeFilePreview
+    :source="source"
+    :max-file-size="50 * 1024 * 1024"
+    height="640"
+    @error="handlePreviewError"
+  />
+</template>
+```
+
+`source` 也可以直接传入 `Blob`、`File` 或 `ArrayBuffer`；需要兼容只提供地址的调用方时，可以使用 `url`。通常组件会根据文件名或 MIME 类型识别格式，也可以通过 `file-name`、`file-type` 显式指定。
+
+当前支持图片、PDF、文本、JSON、XML、CSV、Markdown、HTML、音视频、DOCX、XLS/XLSX 和 EML。EML 会解析正文及 `cid:` 内嵌图片；DOCX 和 Excel 属于基础预览，不保证还原原始复杂排版。PPT/PPTX、DOC 等暂不支持在线解析，会提供下载回退。
+
+远程地址的解析型文件需要服务端允许 CORS；图片、PDF、音视频仍由浏览器原生能力加载。远程下载会先读取为 Blob 再触发下载，不会主动打开新窗口。解析默认限制 50 MB、表格 200 行和 50 列，可通过 `max-file-size`、`max-rows`、`max-columns` 调整。
+
 ### YeeModal
 
 使用标准 `v-model:open`。Modal 默认在 header 右侧显示全屏切换按钮，可通过 `v-model:fullscreen` 控制状态，或通过 `:fullscreen-button="false"` 隐藏。`type="drawer"` 适合长详情或复杂表单，不显示全屏按钮；`confirm` 只通知父组件，不会主动关闭，便于父组件在异步提交成功后再更新 `open`。

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

@@ -0,0 +1,40 @@
+import { CSSProperties } from 'vue';
+import { YeeEllipsisTextProps } from './types';
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: Readonly<{
+        default?(): unknown;
+        tooltip?(): unknown;
+    }> & {
+        default?(): unknown;
+        tooltip?(): unknown;
+    };
+    refs: {
+        text: HTMLDivElement;
+    };
+    rootEl: any;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<YeeEllipsisTextProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    expandChange: (expanded: boolean) => any;
+}, string, import('vue').PublicProps, Readonly<YeeEllipsisTextProps> & Readonly<{
+    onExpandChange?: (expanded: boolean) => any;
+}>, {
+    line: number;
+    placement: import('./types').YeeEllipsisTextPlacement;
+    expand: boolean;
+    ellipsisThreshold: number;
+    maxWidth: number | string;
+    tooltip: boolean;
+    tooltipOverlayStyle: CSSProperties;
+    tooltipWhenEllipsis: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    text: HTMLDivElement;
+}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

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

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

@@ -0,0 +1,31 @@
+import { CSSProperties } from 'vue';
+export type YeeEllipsisTextPlacement = 'bottom' | 'left' | 'right' | 'top';
+export interface YeeEllipsisTextProps {
+    /** 是否允许点击文本展开全部内容。 */
+    expand?: boolean;
+    /** 判定文本截断时允许的像素误差。 */
+    ellipsisThreshold?: number;
+    /** 折叠状态下最多展示的行数。 */
+    line?: number;
+    /** 文本区域最大宽度，数字按 px 处理。 */
+    maxWidth?: number | string;
+    /** Tooltip 展示位置。 */
+    placement?: YeeEllipsisTextPlacement;
+    /** 是否启用 Tooltip。 */
+    tooltip?: boolean;
+    /** Tooltip 背景色。 */
+    tooltipBackgroundColor?: string;
+    /** Tooltip 文字颜色。 */
+    tooltipColor?: string;
+    /** Tooltip 字号，单位 px。 */
+    tooltipFontSize?: number;
+    /** Tooltip 最大宽度，单位 px。 */
+    tooltipMaxWidth?: number;
+    /** Tooltip 内容区域样式。 */
+    tooltipOverlayStyle?: CSSProperties;
+    /** 是否仅在文本实际被截断时启用 Tooltip。 */
+    tooltipWhenEllipsis?: boolean;
+}
+export interface YeeEllipsisTextEmits {
+    expandChange: [expanded: boolean];
+}

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

@@ -0,0 +1,23 @@
+import { YeeFilePreviewError, YeeFilePreviewLoadResult, 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;
+    download: () => any;
+}, string, import('vue').PublicProps, Readonly<YeeFilePreviewProps> & Readonly<{
+    onError?: (error: YeeFilePreviewError) => any;
+    onUnsupported?: (error: YeeFilePreviewError) => any;
+    onLoad?: (result: YeeFilePreviewLoadResult) => any;
+    onDownload?: () => any;
+}>, {
+    maxFileSize: number | undefined;
+    maxRows: number | undefined;
+    maxColumns: number | undefined;
+    showHeader: boolean | undefined;
+    showDownload: boolean | undefined;
+    alt: string | undefined;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    previewContainer: HTMLElement;
+    docxContainer: HTMLDivElement;
+}, HTMLElement>;
+export default _default;

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

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

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

@@ -0,0 +1,8 @@
+import { YeeFilePreviewKind, YeeFilePreviewSource } from './types';
+export declare function extensionFromName(name: string | undefined): string;
+export declare function fileNameFromSource(source: YeeFilePreviewSource | undefined): string;
+export declare function kindFromType(type: string | undefined): YeeFilePreviewKind | undefined;
+export declare function resolveFileKind(source: YeeFilePreviewSource | undefined, fileName: string | undefined, fileType: string | undefined): YeeFilePreviewKind;
+export declare function supportedFileExtensions(): readonly string[];
+export declare function isBlobLike(source: YeeFilePreviewSource | undefined): source is Blob | File | ArrayBuffer;
+export declare function sourceToBlob(source: Blob | File | ArrayBuffer): Blob;

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

@@ -0,0 +1,32 @@
+export type YeeFilePreviewSource = string | Blob | File | ArrayBuffer;
+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';
+export interface YeeFilePreviewProps {
+    source?: YeeFilePreviewSource | undefined;
+    url?: string | undefined;
+    fileName?: string | undefined;
+    fileType?: string | undefined;
+    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;
+}
+export interface YeeFilePreviewEmailMeta {
+    label: string;
+    value: string;
+}

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

@@ -0,0 +1,31 @@
+import { Ref } from 'vue';
+import { YeeFilePreviewEmailMeta, YeeFilePreviewError, YeeFilePreviewKind, YeeFilePreviewLoadResult, YeeFilePreviewProps, YeeFilePreviewStatus, YeeFilePreviewTableRow } from './types';
+interface PreviewTargets {
+    docxContainer: Readonly<Ref<HTMLElement | null>>;
+}
+interface PreviewEmit {
+    (event: 'load', result: YeeFilePreviewLoadResult): void;
+    (event: 'error', error: YeeFilePreviewError): void;
+    (event: 'unsupported', error: YeeFilePreviewError): void;
+}
+export declare function useFilePreview(props: Readonly<YeeFilePreviewProps>, targets: PreviewTargets, emit: PreviewEmit): {
+    displayUrl: import('vue').ShallowRef<string, string>;
+    emailHtml: import('vue').ShallowRef<string, string>;
+    emailMeta: import('vue').ShallowRef<YeeFilePreviewEmailMeta[], YeeFilePreviewEmailMeta[]>;
+    emailText: import('vue').ShallowRef<string, string>;
+    errorMessage: import('vue').ShallowRef<string, string>;
+    fileName: import('vue').ComputedRef<string>;
+    htmlContent: import('vue').ShallowRef<string, string>;
+    isError: import('vue').ComputedRef<boolean>;
+    isLoading: import('vue').ComputedRef<boolean>;
+    isReady: import('vue').ComputedRef<boolean>;
+    isUnsupported: import('vue').ComputedRef<boolean>;
+    kind: import('vue').ComputedRef<YeeFilePreviewKind>;
+    load: () => Promise<void>;
+    markdownHtml: import('vue').ShallowRef<string, string>;
+    status: import('vue').ShallowRef<YeeFilePreviewStatus, YeeFilePreviewStatus>;
+    tableRows: import('vue').ShallowRef<YeeFilePreviewTableRow[], YeeFilePreviewTableRow[]>;
+    textContent: import('vue').ShallowRef<string, string>;
+    truncated: import('vue').ShallowRef<boolean, boolean>;
+};
+export {};