yuang-framework-ui-pc 1.1.42 → 1.1.44

package/lib/ele-upload-list/props.d.ts

@@ -0,0 +1,81 @@
+import { PropType, ExtractPropTypes } from 'vue';
+import { StyleValue } from '../ele-app/types';
+import { ElProgressProps, ElImageProps } from '../ele-app/el';
+import { EleImageViewerProps } from '../ele-app/plus';
+import { UploadItem, UploadLocale, EditUploadResult, ListType, BeforeUploadClick, BeforeItemEdit } from './types';
+
+/**
+ * 属性
+ */
+export declare const uploadListProps: {
+    /** 已上传列表 */
+    modelValue: PropType<UploadItem[]>;
+    /** 是否只读 */
+    readonly: BooleanConstructor;
+    /** 是否禁用 */
+    disabled: BooleanConstructor;
+    /** 是否支持点击预览 */
+    preview: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** 最大上传数量 */
+    limit: NumberConstructor;
+    /** 是否支持多选文件 */
+    multiple: BooleanConstructor;
+    /** 是否启用拖拽上传 */
+    drag: BooleanConstructor;
+    /** 接受上传的文件类型 */
+    accept: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** 自定义条目样式 */
+    itemStyle: PropType<StyleValue | false>;
+    /** 自定义上传按钮样式 */
+    buttonStyle: {
+        type: PropType<StyleValue | false>;
+        default: null;
+    };
+    /** 是否开启拖拽排序 */
+    sortable: {
+        type: PropType<boolean | Record<keyof any, any>>;
+        default: boolean;
+    };
+    /** 自定义图片属性 */
+    imageProps: PropType<ElImageProps>;
+    /** 自定义进度条属性 */
+    progressProps: PropType<ElProgressProps>;
+    /** 自定义图片预览属性 */
+    previewProps: PropType<EleImageViewerProps>;
+    /** 是否开启底部预览和修改的操作按钮 */
+    tools: BooleanConstructor;
+    /** 列表显示样式 */
+    listType: PropType<ListType>;
+    /** 上传按钮点击前的钩子 */
+    beforeUploadClick: PropType<BeforeUploadClick>;
+    /** 修改按钮点击前的钩子 */
+    beforeItemEdit: PropType<BeforeItemEdit>;
+    /** 国际化 */
+    locale: PropType<Partial<UploadLocale>>;
+};
+export type UploadListProps = ExtractPropTypes<typeof uploadListProps>;
+/**
+ * 事件
+ */
+export declare const uploadListEmits: {
+    /** 更新绑定值 */
+    'update:modelValue': (_value: UploadItem[]) => boolean;
+    /** item 点击事件 */
+    itemClick: (_item: UploadItem) => boolean;
+    /** 上传事件 */
+    upload: (_item: UploadItem) => boolean;
+    /** item 移除事件 */
+    remove: (_item: UploadItem) => boolean;
+    /** item 上传失败重试事件 */
+    retry: (_item: UploadItem) => boolean;
+    /** item 修改上传事件 */
+    editUpload: (_result: EditUploadResult) => boolean;
+    /** item 预览事件 */
+    preview: (_item: UploadItem) => boolean;
+};

package/lib/ele-upload-list/types.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 数据类型
+ */
+export interface UploadItem extends Record<keyof any, any> {
+  /** 唯一标识 */
+  key: string | number | symbol;
+  /** 显示的图片地址, 为空时显示文件图标 */
+  url?: string;
+  /** 文件名称 */
+  name?: string;
+  /** 上传状态 */
+  status?: UploadStatus;
+  /** 上传进度, 0 ~ 100 */
+  progress?: number;
+  /** 选择的文件 */
+  file?: File;
+  /** 是否只读 */
+  readonly?: boolean;
+}
+
+/**
+ * 上传状态
+ */
+export type UploadStatus = 'uploading' | 'done' | 'exception' | null;
+
+/**
+ * 列表样式
+ */
+export type ListType = 'image' | 'file' | null;
+
+/**
+ * 上传按钮点击前的钩子
+ */
+export type BeforeUploadClick = (e: MouseEvent) => boolean | undefined | void;
+
+/**
+ * 修改按钮点击前的钩子
+ */
+export type BeforeItemEdit = (item: UploadItem) => boolean | undefined | void;
+
+/**
+ * 图片文件预读地址
+ */
+export interface ImageObjectUrl {
+  /** 文件 */
+  file: File;
+  /** 预览地址 */
+  url: string;
+}
+
+/**
+ * 修改事件参数
+ */
+export interface EditUploadResult {
+  /** 修改的数据项 */
+  item: UploadItem;
+  /** 新的数据项 */
+  newItem: UploadItem;
+}
+
+/**
+ * 国际化
+ */
+export interface UploadLocale {
+  uploading: string;
+  exception: string;
+  retry: string;
+  remove: string;
+  preview: string;
+  edit: string;
+}