Interface UploadProps<T>

interface UploadProps<T> {
    accept?: string;
    action?: string | ((file) => string) | ((file) => PromiseLike<string>);
    beforeUpload?: ((file, FileList) => BeforeUploadValueType | Promise<BeforeUploadValueType>);
    capture?: boolean | "environment" | "user";
    children?: ReactNode;
    className?: string;
    customRequest?: ((options) => void);
    data?: Record<string, unknown> | ((file) => Record<string, unknown> | Promise<Record<string, unknown>>);
    defaultFileList?: UploadFile<T>[];
    directory?: boolean;
    disabled?: boolean;
    fileList?: UploadFile<T>[];
    hasControlInside?: boolean;
    headers?: HttpRequestHeader;
    iconRender?: ((file, listType?) => ReactNode);
    id?: string;
    isImageUrl?: ((file) => boolean);
    itemRender?: ItemRender<T>;
    listType?: UploadListType;
    locale?: UploadLocale;
    maxCount?: number;
    method?: "post" | "POST" | "PUT" | "PATCH" | "put" | "patch";
    multiple?: boolean;
    name?: string;
    onChange?: ((info) => void);
    onDownload?: ((file) => void);
    onDrop?: ((event) => void);
    onPreview?: ((file) => void);
    onRemove?: ((file) => boolean | void | Promise<boolean | void>);
    openFileDialogOnClick?: boolean;
    prefixCls?: string;
    previewFile?: PreviewFileHandler;
    progress?: UploadListProgressProps;
    rootClassName?: string;
    showUploadList?: boolean | ShowUploadListInterface<any>;
    style?: CSSProperties;
    supportServerRender?: boolean;
    transformFile?: TransformFileHandler;
    type?: UploadType;
    withCredentials?: boolean;
}

Type Parameters

  • T = any

Hierarchy

  • Pick<RcUploadProps, "capture" | "hasControlInside">
    • UploadProps

Properties

accept? action? beforeUpload? capture? children? className? customRequest? data? defaultFileList? directory? disabled? fileList? hasControlInside? headers? iconRender? id? isImageUrl? itemRender? listType? locale? maxCount? method? multiple? name? onChange? onDownload? onDrop? onPreview? onRemove? openFileDialogOnClick? prefixCls? previewFile? progress? rootClassName? showUploadList? style? supportServerRender? transformFile? type? withCredentials?

Properties

Optional accept

accept?: string

Optional action

action?: string | ((file) => string) | ((file) => PromiseLike<string>)

Type declaration

    • (file): string

    • Parameters

      • file: RcFile

      Returns string

Type declaration

    • (file): PromiseLike<string>

    • Parameters

      • file: RcFile

      Returns PromiseLike<string>

Optional beforeUpload

beforeUpload?: ((file, FileList) => BeforeUploadValueType | Promise<BeforeUploadValueType>)

Type declaration

    • (file, FileList): BeforeUploadValueType | Promise<BeforeUploadValueType>

    • Parameters

      • file: RcFile
      • FileList: RcFile[]

      Returns BeforeUploadValueType | Promise<BeforeUploadValueType>

Optional capture

capture?: boolean | "environment" | "user"

Optional children

children?: ReactNode

Optional className

className?: string

Optional customRequest

customRequest?: ((options) => void)

Type declaration

    • (options): void

    • Parameters

      • options: UploadRequestOption<any>

      Returns void

Optional data

data?: Record<string, unknown> | ((file) => Record<string, unknown> | Promise<Record<string, unknown>>)

Type declaration

Optional defaultFileList

defaultFileList?: UploadFile<T>[]

Optional directory

directory?: boolean

Optional disabled

disabled?: boolean

Optional fileList

fileList?: UploadFile<T>[]

Optional hasControlInside

hasControlInside?: boolean

Optional headers

headers?: HttpRequestHeader

Optional iconRender

iconRender?: ((file, listType?) => ReactNode)

Type declaration

    • (file, listType?): ReactNode

    • Parameters

      Returns ReactNode

Optional id

id?: string

Optional isImageUrl

isImageUrl?: ((file) => boolean)

Type declaration

    • (file): boolean

    • Parameters

      Returns boolean

Optional itemRender

itemRender?: ItemRender<T>

Optional listType

listType?: UploadListType

Optional locale

locale?: UploadLocale

Optional maxCount

maxCount?: number

Config max count of fileList. Will replace current one when maxCount is 1

Optional method

method?: "post" | "POST" | "PUT" | "PATCH" | "put" | "patch"

Optional multiple

multiple?: boolean

Optional name

name?: string

Optional onChange

onChange?: ((info) => void)

Type declaration

    • (info): void

    • Parameters

      Returns void

Optional onDownload

onDownload?: ((file) => void)

Type declaration

Optional onDrop

onDrop?: ((event) => void)

Type declaration

Optional onPreview

onPreview?: ((file) => void)

Type declaration

Optional onRemove

onRemove?: ((file) => boolean | void | Promise<boolean | void>)

Type declaration

    • (file): boolean | void | Promise<boolean | void>

    • Parameters

      Returns boolean | void | Promise<boolean | void>

Optional openFileDialogOnClick

openFileDialogOnClick?: boolean

Optional prefixCls

prefixCls?: string

Optional previewFile

previewFile?: PreviewFileHandler

Optional progress

progress?: UploadListProgressProps

Optional rootClassName

rootClassName?: string

Optional showUploadList

showUploadList?: boolean | ShowUploadListInterface<any>

Optional style

style?: CSSProperties

Optional supportServerRender

supportServerRender?: boolean

Optional transformFile

transformFile?: TransformFileHandler

Deprecated

Please use beforeUpload directly

Optional type

type?: UploadType

Optional withCredentials

withCredentials?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc