Interface UploadProps

Public

interface UploadProps {
    accept?: string;
    action?:
        | string
        | ((file: RcFile) => string)
        | ((file: RcFile) => PromiseLike<string>);
    beforeUpload?: (
        file: RcFile,
        FileList: RcFile[],
    ) => boolean | PromiseLike<void>;
    className?: string;
    customRequest?: (options: UploadCustomRequestOptions) => void;
    data?: object | ((file: UploadFile) => object);
    defaultFileList?: UploadFile[];
    directory?: boolean;
    disabled?: boolean;
    fileList?: UploadFile[];
    headers?: { [key: string]: string };
    iconRender?: (
        file: UploadFile,
        listType?: "picture" | "text" | "picture-card",
    ) => ReactNode;
    id?: string;
    isImageUrl?: (file: UploadFile) => boolean;
    listType?: "picture" | "text" | "picture-card";
    locale?: {
        downloadFile?: string;
        previewFile?: string;
        removeFile?: string;
        uploadError?: string;
        uploading?: string;
    };
    method?: "POST"
    | "PUT"
    | "PATCH"
    | "post"
    | "put"
    | "patch";
    multiple?: boolean;
    name?: string;
    onChange?: (
        info: {
            event?: { percent: number };
            file: UploadFile;
            fileList: UploadFile[];
        },
    ) => void;
    onDownload?: (file: UploadFile) => void;
    onPreview?: (file: UploadFile) => void;
    onRemove?: (file: UploadFile) => boolean | void | Promise<boolean | void>;
    openFileDialogOnClick?: boolean;
    prefixCls?: string;
    previewFile?: (file: File | Blob) => PromiseLike<string>;
    progress?: {
        className?: string;
        format?: (percent?: number, successPercent?: number) => ReactNode;
        gapDegree?: number;
        gapPosition?: "left" | "right" | "bottom" | "top";
        prefixCls?: string;
        showInfo?: boolean;
        size?: "small" | "default";
        status?: "normal" | "active" | "exception" | "success";
        steps?: number;
        strokeColor?:
            | string
            | (
                { direction?: string | undefined; } & ({ [percentage: string]: string; } | { from: string; to: string; })
            );
        strokeLinecap?: "butt"
        | "round"
        | "square";
        strokeWidth?: number;
        style?: CSSProperties;
        success?: { percent?: number; progress?: number; strokeColor?: string };
        successPercent?: number;
        trailColor?: string;
        width?: number;
    };
    showUploadList?: | boolean
    | {
        downloadIcon?: ReactNode;
        removeIcon?: ReactNode;
        showDownloadIcon?: boolean;
        showPreviewIcon?: boolean;
        showRemoveIcon?: boolean;
    };
    style?: CSSProperties;
    supportServerRender?: boolean;
    transformFile?: (
        file: RcFile,
    ) => string | File | Blob | PromiseLike<string | File | Blob>;
    type?: "select" | "drag";
    withCredentials?: boolean;
}

Properties

`Optional`accept

accept?: string

`Optional`action

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

`Optional`beforeUpload

beforeUpload?: (file: RcFile, FileList: RcFile[]) => boolean | PromiseLike<void>

`Optional`className

className?: string

`Optional`customRequest

customRequest?: (options: UploadCustomRequestOptions) => void

`Optional`data

data?: object | ((file: UploadFile) => object)

`Optional`defaultFileList

defaultFileList?: UploadFile[]

`Optional`directory

directory?: boolean

`Optional`disabled

disabled?: boolean

`Optional`fileList

fileList?: UploadFile[]

`Optional`headers

headers?: { [key: string]: string }

`Optional`iconRender

iconRender?: (
file: UploadFile,
listType?: "picture" | "text" | "picture-card",
) => ReactNode

`Optional`id

id?: string

`Optional`isImageUrl

isImageUrl?: (file: UploadFile) => boolean

`Optional`listType

listType?: "picture" | "text" | "picture-card"

`Optional`locale

locale?: {
    downloadFile?: string;
    previewFile?: string;
    removeFile?: string;
    uploadError?: string;
    uploading?: string;
}

`Optional`method

`Optional`multiple

multiple?: boolean

`Optional`name

name?: string

`Optional`onChange

onChange?: (
    info: {
        event?: { percent: number };
        file: UploadFile;
        fileList: UploadFile[];
    },
) => void

`Optional`onDownload

onDownload?: (file: UploadFile) => void

`Optional`onPreview

onPreview?: (file: UploadFile) => void

`Optional`onRemove

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

`Optional`openFileDialogOnClick

openFileDialogOnClick?: boolean

`Optional`prefixCls

prefixCls?: string

`Optional`previewFile

previewFile?: (file: File | Blob) => PromiseLike<string>

`Optional`progress

progress?: {
    className?: string;
    format?: (percent?: number, successPercent?: number) => ReactNode;
    gapDegree?: number;
    gapPosition?: "left" | "right" | "bottom" | "top";
    prefixCls?: string;
    showInfo?: boolean;
    size?: "small" | "default";
    status?: "normal" | "active" | "exception" | "success";
    steps?: number;
    strokeColor?:
        | string
        | (
            { direction?: string | undefined; } & ({ [percentage: string]: string; } | { from: string; to: string; })
        );
    strokeLinecap?: "butt"
    | "round"
    | "square";
    strokeWidth?: number;
    style?: CSSProperties;
    success?: { percent?: number; progress?: number; strokeColor?: string };
    successPercent?: number;
    trailColor?: string;
    width?: number;
}

Type declaration

OptionalclassName?: string
Optionalformat?: (percent?: number, successPercent?: number) => ReactNode
OptionalgapDegree?: number
OptionalgapPosition?: "left" | "right" | "bottom" | "top"
OptionalprefixCls?: string
OptionalshowInfo?: boolean
Optionalsize?: "small" | "default"
Optionalstatus?: "normal" | "active" | "exception" | "success"
Optionalsteps?: number
OptionalstrokeColor?:
    | string
    | (
        { direction?: string | undefined; } & ({ [percentage: string]: string; } | { from: string; to: string; })
    )
OptionalstrokeLinecap?: "butt" | "round" | "square"
OptionalstrokeWidth?: number
Optionalstyle?: CSSProperties
Optionalsuccess?: { percent?: number; progress?: number; strokeColor?: string }
- Optionalpercent?: number
- Optionalprogress?: number
  Deprecated
  Следует использовать свойство percent
  
  End Of Support
  @universe-platform/uikit 2.0.0
- OptionalstrokeColor?: string
OptionalsuccessPercent?: number
Deprecated
Следует использовать свойство success

End Of Support
@universe-platform/uikit 2.0.0
OptionaltrailColor?: string
Optionalwidth?: number

`Optional`showUploadList

showUploadList?:
    | boolean
    | {
        downloadIcon?: ReactNode;
        removeIcon?: ReactNode;
        showDownloadIcon?: boolean;
        showPreviewIcon?: boolean;
        showRemoveIcon?: boolean;
    }

`Optional`style

style?: CSSProperties

`Optional`supportServerRender

supportServerRender?: boolean

`Optional`transformFile

`Optional`type

type?: "select" | "drag"

`Optional`withCredentials

withCredentials?: boolean

Interface UploadProps

Public

Index

Properties

Properties

Optionalaccept

Optionalaction

OptionalbeforeUpload

OptionalclassName

OptionalcustomRequest

Optionaldata

OptionaldefaultFileList

Optionaldirectory

Optionaldisabled

OptionalfileList

Optionalheaders

OptionaliconRender

Optionalid

OptionalisImageUrl

OptionallistType

Optionallocale

Optionalmethod

Optionalmultiple

Optionalname

OptionalonChange

OptionalonDownload

OptionalonPreview

OptionalonRemove

OptionalopenFileDialogOnClick

OptionalprefixCls

OptionalpreviewFile

Optionalprogress

Type declaration

OptionalclassName?: string

Optionalformat?: (percent?: number, successPercent?: number) => ReactNode

OptionalgapDegree?: number

OptionalgapPosition?: "left" | "right" | "bottom" | "top"

OptionalprefixCls?: string

OptionalshowInfo?: boolean

Optionalsize?: "small" | "default"

Optionalstatus?: "normal" | "active" | "exception" | "success"

Optionalsteps?: number

OptionalstrokeColor?: | string | ( { direction?: string | undefined; } & ({ [percentage: string]: string; } | { from: string; to: string; }) )

OptionalstrokeLinecap?: "butt" | "round" | "square"

OptionalstrokeWidth?: number

Optionalstyle?: CSSProperties

Optionalsuccess?: { percent?: number; progress?: number; strokeColor?: string }

Optionalpercent?: number

Optionalprogress?: number

Deprecated

End Of Support

OptionalstrokeColor?: string

OptionalsuccessPercent?: number

Deprecated

End Of Support

OptionaltrailColor?: string

Optionalwidth?: number

OptionalshowUploadList

Optionalstyle

OptionalsupportServerRender

OptionaltransformFile

Optionaltype

OptionalwithCredentials

On This Page

`Optional`accept

`Optional`action

`Optional`beforeUpload

`Optional`className

`Optional`customRequest

`Optional`data

`Optional`defaultFileList

`Optional`directory

`Optional`disabled

`Optional`fileList

`Optional`headers

`Optional`iconRender

`Optional`id

`Optional`isImageUrl

`Optional`listType

`Optional`locale

`Optional`method

`Optional`multiple

`Optional`name

`Optional`onChange

`Optional`onDownload

`Optional`onPreview

`Optional`onRemove

`Optional`openFileDialogOnClick

`Optional`prefixCls

`Optional`previewFile

`Optional`progress

`Optional`className?: string

`Optional`format?: (percent?: number, successPercent?: number) => ReactNode

`Optional`gapDegree?: number

`Optional`gapPosition?: "left" | "right" | "bottom" | "top"

`Optional`prefixCls?: string

`Optional`showInfo?: boolean

`Optional`size?: "small" | "default"

`Optional`status?: "normal" | "active" | "exception" | "success"

`Optional`steps?: number

`Optional`strokeColor?:
| string
| (
{ direction?: string | undefined; } & ({ [percentage: string]: string; } | { from: string; to: string; })
)

`Optional`strokeLinecap?: "butt" | "round" | "square"

`Optional`strokeWidth?: number

`Optional`style?: CSSProperties

`Optional`success?: { percent?: number; progress?: number; strokeColor?: string }

`Optional`percent?: number

`Optional`progress?: number

`Optional`strokeColor?: string

`Optional`successPercent?: number

`Optional`trailColor?: string

`Optional`width?: number

`Optional`showUploadList

`Optional`style

`Optional`supportServerRender

`Optional`transformFile

`Optional`type

`Optional`withCredentials