@yeepay/yee-boss-ui 0.1.4 → 0.1.6

package/README.md

@@ -14,6 +14,10 @@
 - `YeePage` 页面容器。
 - `YeeForm` Schema 查询表单。
 - `useYeeGrid` 与 `gridApi/formApi`。
+- `YeeDescriptions` 配置驱动的详情展示。
+- `YeeFileUpload` 业务无关的文件选择与上传生命周期。
+- `YeeModal` 统一的 Modal / Drawer 容器。
+- `YeeSelect` 带完整文案提示的选择器。
 - Tailwind CSS 语义主题 preset。
 
 不提供主题切换器、业务组件或对 Ant Design Vue 基础组件的机械封装，也不依赖任何 `@vben-*` 包。
@@ -67,6 +71,8 @@ import '@yeepay/yee-boss-ui/theme.css'
 }
 ```
 
+`--yee-radius`、`--yee-radius-lg` 与 `--yee-radius-sm` 默认分别为 `4px`、`8px` 与 `2px`。公共组件使用基础圆角，Ant Design Vue 映射按对应尺寸消费这组语义化变量；需要特殊圆角时由 Portal 通过 `theme.tokens` 显式覆盖。
+
 ## Tailwind CSS
 
 ```js
@@ -81,6 +87,55 @@ export default {
 
 业务页面可以直接使用 `bg-background`、`bg-background-deep`、`bg-card`、`bg-accent`、`text-foreground`、`text-muted-foreground` 和 `border-border`，底层统一映射到 `--yee-*`。
 
+## 通用业务组件
+
+### YeeDescriptions
+
+配置项使用稳定的 `name` 时，可通过 `content-${name}` 覆盖内容。`copyable` 仅复制展示值，`info` 用于补充说明。
+
+```vue
+<YeeDescriptions
+  bordered
+  :items="[
+    { label: '订单号', name: 'orderNo', value: orderNo, copyable: true },
+    { label: '状态', name: 'status', value: status },
+  ]"
+/>
+```
+
+### YeeFileUpload
+
+组件不接受上传 URL，也不依赖业务请求客户端。自动上传由 `customRequest` 完成；手动模式监听 `file-select`，完成后调用组件实例的 `addResult(uid, { url, name? })` 或 `addError(uid)`。
+
+```vue
+<YeeFileUpload
+  v-model:file-list="fileList"
+  :custom-request="uploadFile"
+  @file-removed="removeFile"
+/>
+```
+
+### YeeModal
+
+使用标准 `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"
+/>
+```
+
+### YeeSelect
+
+`YeeSelect` 保持 Ant Design Vue `Select` 的透传能力，并针对当前选中项和默认 option 提供完整文案提示。
+
+```vue
+<YeeSelect v-model:value="status" :options="statusOptions" />
+```
+
 ## YeePage 与 VXE Grid
 
 ```vue
@@ -153,3 +208,13 @@ pnpm install
 pnpm check
 pnpm pack --dry-run
 ```
+
+## 组件演示
+
+本地演示入口覆盖当前公共组件与 light/dark 主题切换：
+
+```bash
+pnpm example
+```
+
+执行 `pnpm build:example` 可验证演示入口的生产构建。示例仅用于本地开发，不会打入 npm 包。

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

@@ -0,0 +1,20 @@
+import { YeeDescriptionItem, YeeDescriptionsProps } from './types';
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: Partial<Record<`content-${string}`, (_: {
+        item: YeeDescriptionItem;
+    }) => any>> & Partial<Record<`content-${string}`, (_: {
+        item: YeeDescriptionItem;
+    }) => any>>;
+    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 _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

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

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

@@ -0,0 +1,20 @@
+import { StyleValue } from 'vue';
+export interface YeeDescriptionItem {
+    copyable?: boolean;
+    ellipsis?: boolean;
+    info?: string;
+    infoStyle?: StyleValue;
+    label: string;
+    name?: string;
+    span?: number;
+    value: unknown;
+}
+export interface YeeDescriptionsProps {
+    bordered?: boolean;
+    colon?: boolean;
+    column?: number;
+    items: readonly YeeDescriptionItem[];
+    layout?: 'horizontal' | 'vertical';
+    size?: 'default' | 'middle' | 'small';
+    title?: string;
+}

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

@@ -0,0 +1,28 @@
+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;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    fileRemoved: (file: import('ant-design-vue').UploadFile<unknown>) => any;
+    fileSelect: (payload: {
+        file: File;
+        uid: string;
+    }) => 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;
+    "onUpdate:fileList"?: (fileList: import('ant-design-vue').UploadFile<unknown>[]) => any;
+    onUploadSuccess?: () => any;
+    onUploadingChange?: (isUploading: boolean) => any;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

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

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

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

@@ -0,0 +1,26 @@
+import { UploadProps } from 'ant-design-vue';
+export type YeeUploadFile = NonNullable<NonNullable<UploadProps['fileList']>[number]>;
+export interface YeeUploadResult {
+    name?: string;
+    url?: string;
+}
+export interface YeeUploadRequestOptions {
+    file: File;
+    onError: (error: Error) => void;
+    onProgress: (percent: number) => void;
+    onSuccess: (result?: YeeUploadResult) => void;
+    uid: string;
+}
+export interface YeeFileUploadProps {
+    accept?: string;
+    customRequest?: (options: YeeUploadRequestOptions) => Promise<void> | void;
+    fileList?: YeeUploadFile[];
+    height?: number | string;
+    manual?: boolean;
+    maxCount?: number;
+    maxSize?: number;
+    multiple?: boolean;
+    readonly?: boolean;
+    uploadText?: string;
+    width?: number | string;
+}

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

@@ -0,0 +1,59 @@
+import { VNodeChild } from 'vue';
+import { YeeModalProps } from './types';
+type __VLS_Props = YeeModalProps;
+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;
+    };
+    refs: {};
+    rootEl: any;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    close: () => any;
+    confirm: (event: Event) => any;
+    cancel: (event: Event) => any;
+    "update:fullscreen": (fullscreen: boolean) => any;
+    "update:open": (value: boolean) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    onClose?: () => any;
+    onConfirm?: (event: Event) => any;
+    onCancel?: (event: Event) => any;
+    "onUpdate:fullscreen"?: (fullscreen: boolean) => any;
+    "onUpdate:open"?: (value: boolean) => any;
+}>, {
+    type: import('./types').YeeModalType;
+    title: string;
+    width: number | string;
+    keyboard: boolean;
+    closable: boolean;
+    maskClosable: boolean;
+    destroyOnClose: boolean;
+    cancelButtonText: string;
+    centered: boolean;
+    confirmButtonLoading: boolean;
+    confirmButtonText: string;
+    fullscreen: boolean;
+    fullscreenButton: boolean;
+    showCancelButton: boolean;
+    showConfirmButton: 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 & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,2 @@
+export { default as YeeModal } from './YeeModal.vue';
+export type { YeeModalProps, YeeModalType } from './types';

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

@@ -0,0 +1,21 @@
+import { StyleValue } from 'vue';
+export type YeeModalType = 'drawer' | 'modal';
+export interface YeeModalProps {
+    cancelButtonText?: string;
+    centered?: boolean;
+    closable?: boolean;
+    confirmButtonLoading?: boolean;
+    confirmButtonText?: string;
+    destroyOnClose?: boolean;
+    fullscreen?: boolean;
+    fullscreenButton?: boolean;
+    keyboard?: boolean;
+    maskClosable?: boolean;
+    showCancelButton?: boolean;
+    showConfirmButton?: boolean;
+    style?: StyleValue;
+    title?: string;
+    type?: YeeModalType;
+    width?: number | string;
+    wrapProps?: Record<string, unknown>;
+}

package/dist/components/select/YeeSelect.vue.d.ts

@@ -0,0 +1,30 @@
+import { YeeSelectProps, YeeSelectValue } from './types';
+type __VLS_Props = YeeSelectProps;
+type __VLS_PublicProps = {
+    'value'?: YeeSelectValue;
+} & __VLS_Props;
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: any): any;
+        option?(_: any): any;
+        tagRender?(_: any): any;
+        dropdownRender?(_: any): any;
+        notFoundContent?(_: any): any;
+    };
+    refs: {};
+    rootEl: any;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:value": (value: (string | number) | import('ant-design-vue/es/select').LabeledValue | (string | number)[] | import('ant-design-vue/es/select').LabeledValue[] | undefined) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:value"?: (value: (string | number) | import('ant-design-vue/es/select').LabeledValue | (string | number)[] | import('ant-design-vue/es/select').LabeledValue[] | undefined) => any;
+}>, {}, {}, {}, {}, 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 & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,2 @@
+export { default as YeeSelect } from './YeeSelect.vue';
+export type { YeeSelectFieldNames, YeeSelectOption, YeeSelectProps, YeeSelectValue, } from './types';

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

@@ -0,0 +1,18 @@
+import { SelectProps } from 'ant-design-vue';
+export interface YeeSelectOption {
+    [key: string]: unknown;
+    label?: unknown;
+    options?: YeeSelectOption[];
+    title?: unknown;
+    value?: unknown;
+}
+export interface YeeSelectFieldNames {
+    label: string;
+    options: string;
+    value: string;
+}
+export type YeeSelectValue = SelectProps['value'];
+export interface YeeSelectProps {
+    fieldNames?: YeeSelectFieldNames;
+    options?: YeeSelectOption[];
+}

package/dist/index.d.ts

@@ -1,7 +1,11 @@
 export { default as PlatformConfigProvider } from './components/PlatformConfigProvider.vue';
+export * from './components/descriptions';
+export * from './components/file-upload';
 export * from './components/form';
 export * from './components/grid';
+export * from './components/modal';
 export * from './components/page';
+export * from './components/select';
 export { toAntDesignTheme } from './theme/ant-theme';
 export { platformThemeKey, usePlatformTheme } from './theme/context';
 export { toPlatformCssVariables } from './theme/css-variables';