@xto/form 1.6.8 → 1.7.0

package/es/Upload/types.d.ts

@@ -0,0 +1,238 @@
+/**
+ * Upload 组件类型定义
+ */
+/**
+ * Upload 文件状态
+ */
+export type UploadStatus = 'ready' | 'uploading' | 'success' | 'error';
+/**
+ * Upload 文件列表类型
+ */
+export type UploadListType = 'text' | 'picture' | 'picture-card';
+/**
+ * Upload 文件对象
+ */
+export interface UploadFile {
+    /**
+     * 文件名
+     */
+    name: string;
+    /**
+     * 文件大小
+     */
+    size?: number;
+    /**
+     * 文件 URL
+     */
+    url?: string;
+    /**
+     * 上传状态
+     */
+    status?: UploadStatus;
+    /**
+     * 上传进度
+     */
+    percentage?: number;
+    /**
+     * 文件唯一标识
+     */
+    uid?: number | string;
+    /**
+     * 原始文件对象
+     */
+    raw?: File;
+    /**
+     * 上传响应
+     */
+    response?: any;
+    /**
+     * 缩略图 URL
+     */
+    thumbUrl?: string;
+}
+/**
+ * Upload HTTP 请求选项
+ */
+export interface UploadRequestOptions {
+    /**
+     * 上传地址
+     */
+    action: string;
+    /**
+     * 请求头
+     */
+    headers?: Record<string, string>;
+    /**
+     * 附带数据
+     */
+    data?: Record<string, any>;
+    /**
+     * 文件对象
+     */
+    file: File;
+    /**
+     * 文件字段名
+     */
+    name: string;
+    /**
+     * 是否携带凭证
+     */
+    withCredentials?: boolean;
+    /**
+     * 进度回调
+     */
+    onProgress?: (e: {
+        percent: number;
+    }) => void;
+    /**
+     * 成功回调
+     */
+    onSuccess?: (response: any) => void;
+    /**
+     * 错误回调
+     */
+    onError?: (error: Error) => void;
+}
+/**
+ * Upload Props
+ */
+export interface UploadProps {
+    /**
+     * 上传地址
+     * @default '#'
+     */
+    action?: string;
+    /**
+     * 请求头
+     */
+    headers?: Record<string, string>;
+    /**
+     * 附带数据
+     */
+    data?: Record<string, any>;
+    /**
+     * 是否支持多选
+     * @default false
+     */
+    multiple?: boolean;
+    /**
+     * 接受的文件类型
+     */
+    accept?: string;
+    /**
+     * 最大上传数量
+     */
+    limit?: number;
+    /**
+     * 是否禁用
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * 是否拖拽上传
+     * @default false
+     */
+    drag?: boolean;
+    /**
+     * 文件列表类型
+     * @default 'text'
+     */
+    listType?: UploadListType;
+    /**
+     * 是否自动上传
+     * @default true
+     */
+    autoUpload?: boolean;
+    /**
+     * 默认文件列表
+     */
+    fileList?: UploadFile[];
+    /**
+     * 是否显示文件列表
+     * @default true
+     */
+    showFileList?: boolean;
+    /**
+     * 是否携带凭证
+     * @default false
+     */
+    withCredentials?: boolean;
+    /**
+     * 文件字段名
+     * @default 'file'
+     */
+    name?: string;
+    /**
+     * 自定义上传方法
+     */
+    httpRequest?: (options: UploadRequestOptions) => Promise<any>;
+    /**
+     * 上传前钩子
+     */
+    beforeUpload?: (file: File, fileList: File[]) => boolean | Promise<boolean>;
+    /**
+     * 删除前钩子
+     */
+    beforeRemove?: (file: UploadFile, fileList: UploadFile[]) => boolean;
+    /**
+     * 上传成功钩子
+     */
+    onSuccess?: (response: any, file: UploadFile, fileList: UploadFile[]) => void;
+    /**
+     * 上传失败钩子
+     */
+    onError?: (error: Error, file: UploadFile, fileList: UploadFile[]) => void;
+    /**
+     * 上传进度钩子
+     */
+    onProgress?: (event: {
+        percent: number;
+    }, file: UploadFile, fileList: UploadFile[]) => void;
+    /**
+     * 文件状态改变钩子
+     */
+    onChange?: (file: UploadFile, fileList: UploadFile[]) => void;
+    /**
+     * 文件删除钩子
+     */
+    onRemove?: (file: UploadFile, fileList: UploadFile[]) => void;
+    /**
+     * 超出限制钩子
+     */
+    onExceed?: (files: File[], fileList: UploadFile[]) => void;
+}
+/**
+ * Upload Emits
+ */
+export interface UploadEmits {
+    (e: 'update:fileList', fileList: UploadFile[]): void;
+    (e: 'success', response: any, file: UploadFile, fileList: UploadFile[]): void;
+    (e: 'error', error: Error, file: UploadFile, fileList: UploadFile[]): void;
+    (e: 'progress', event: {
+        percent: number;
+    }, file: UploadFile, fileList: UploadFile[]): void;
+    (e: 'change', file: UploadFile, fileList: UploadFile[]): void;
+    (e: 'remove', file: UploadFile, fileList: UploadFile[]): void;
+    (e: 'exceed', files: File[], fileList: UploadFile[]): void;
+}
+/**
+ * Upload Expose
+ */
+export interface UploadExpose {
+    /**
+     * 手动上传
+     */
+    submit: () => void;
+    /**
+     * 清空文件列表
+     */
+    clearFiles: () => void;
+    /**
+     * 文件列表
+     */
+    uploadFiles: UploadFile[];
+}
+/**
+ * Upload 组件实例类型
+ */
+export type UploadInstance = InstanceType<typeof import('./index.vue').default>;

package/es/index.d.ts

@@ -0,0 +1,41 @@
+export { default as Input } from './Input/index.vue';
+export { default as InputNumber } from './InputNumber/index.vue';
+export { default as Textarea } from './Textarea/index.vue';
+export { default as Switch } from './Switch/index.vue';
+export { Radio, RadioGroup, RadioButton } from './Radio';
+export { Checkbox, CheckboxGroup } from './Checkbox';
+export { Form, FormItem } from './Form';
+export { default as DatePicker } from './DatePicker/index.vue';
+export { default as TimePicker } from './TimePicker/index.vue';
+export { Select, SelectOption } from './Select';
+export { default as Transfer } from './Transfer/index.vue';
+export { default as Slider } from './Slider/index.vue';
+export { default as Upload } from './Upload/index.vue';
+export { default as Rate } from './Rate/index.vue';
+export { default as DynamicFields } from './DynamicFields/index.vue';
+export { default as RichEditor } from './RichEditor/index.vue';
+export { default as Cascader } from './Cascader/index.vue';
+export { default as ColorPicker } from './ColorPicker/index.vue';
+export { default as AutoComplete } from './AutoComplete/index.vue';
+export { default as Segmented } from './Segmented/index.vue';
+export { default as Mention } from './Mention/index.vue';
+export type { InputProps } from './Input';
+export type { TextareaProps } from './Textarea';
+export type { RadioProps, RadioGroupProps, RadioButtonProps } from './Radio';
+export type { CheckboxProps, CheckboxGroupProps } from './Checkbox';
+export type { FormProps, FormItemProps, FormRule } from './Form';
+export type { SwitchProps } from './Switch';
+export type { DatePickerProps, DatePickerType } from './DatePicker';
+export type { TimePickerProps, TimePickerType } from './TimePicker';
+export type { SelectProps, SelectType, SelectOption } from './Select';
+export type { TransferProps, TransferOption } from './Transfer';
+export type { SliderProps } from './Slider';
+export type { UploadProps, UploadFile } from './Upload';
+export type { RateProps } from './Rate';
+export type { DynamicField, DynamicFieldsProps, DynamicFieldsEmits } from './DynamicFields';
+export type { RichEditorProps } from './RichEditor';
+export type { CascaderOption, CascaderProps, CascaderComponentProps } from './Cascader';
+export type { ColorPickerProps } from './ColorPicker';
+export type { AutoCompleteSuggestion, AutoCompleteProps } from './AutoComplete';
+export type { SegmentedOption, SegmentedProps } from './Segmented';
+export type { MentionOption, MentionProps } from './Mention';