mobile-more/es/components/BizImageUploader/index.d.ts

基于 antd-mobile v5 扩展移动端 UI 组件

import { ImageUploaderProps as BaseImageUploaderProps, ImageUploadItem } from 'antd-mobile';
import * as React from 'react';
import './index.less';
import UploadType, { UploadTypeProps } from './UploadType';
import UploadCustom, { UploadCustomProps } from './UploadCustom';
export type { ImageUploadItem, UploadCustomProps, UploadTypeProps };
export type BizImageUploaderActionType = {
    /**
     * @description 手动触发上传
     * @returns
     */
    clickInput: () => void;
};
export interface BizImageUploaderProps extends BaseImageUploaderProps {
    /**
     * @description 块级显示。
     */
    block?: boolean;
    /**
     * @description 使用内置样式。
     */
    type?: UploadTypeProps['type'];
    /**
     * @description 删除样式。
     * @default 'circle'
     */
    deleteStyle?: 'default' | 'circle';
    /**
     * @description 最大上传文件大小，单位 `MB`。
     * @default 2
     */
    maxSize?: number;
    /**
     * @description 常用操作引用。
     */
    actionRef?: React.MutableRefObject<BizImageUploaderActionType | undefined>;
    /**
     * @description 文件类型错误时提示，包含 `%s` 会自动替换为 `accept`。
     * @default '只支持上传 %s 文件'
     */
    fileTypeMessage?: string | false;
    /**
     * @description 文件超过最大尺寸时提示，包含 `%s` 会自动替换为 `maxFileSizeStr`。
     * @default '请选择小于 %s 的文件'
     */
    fileSizeMessage?: string | false;
    /**
     * @description 删除时是否需要二次确认。
     * @default false
     */
    comfirmDelete?: boolean;
    /**
     * @description 删除提示内容，`comfirmDelete=true` 时才生效。
     * @default '是否确认删除'
     */
    deleteTiptext?: React.ReactNode;
    /**
     * @description 名称，用于提示。建议搭配 `block` 或内置类型使用。
     */
    name?: React.ReactNode;
    /**
     * @description 名称属性，同 `div`。
     */
    nameProps?: React.HTMLAttributes<HTMLDivElement>;
    /**
     * @description 内置样式组件属性。仅在 `type` 有值时生效。
     */
    uploadTypeProps?: UploadTypeProps;
}
declare const BizImageUploader: React.FC<BizImageUploaderProps> & {
    /**
     * @deprecated 已废弃，请使用 `UploadType` 替代。
     */
    UploadBackground: typeof UploadType;
    UploadType: typeof UploadType;
    UploadCustom: typeof UploadCustom;
};
/**
 * @deprecated 即将废弃，请使用 `BizImageUploader` 替代。
 */
export declare const ImageUploader: React.FC<BizImageUploaderProps> & {
    /**
     * @deprecated 已废弃，请使用 `UploadType` 替代。
     */
    UploadBackground: typeof UploadType;
    UploadType: typeof UploadType;
    UploadCustom: typeof UploadCustom;
};
/**
 * @deprecated 即将废弃，请使用 `BizImageUploaderProps` 替代。
 */
export type ImageUploaderProps = BizImageUploaderProps;
/**
 * @deprecated 即将废弃，请使用 `BizImageUploaderActionType` 替代。
 */
export type ImageUploaderActionType = BizImageUploaderActionType;
export default BizImageUploader;