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;
    errorText?: string;
    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

Список допустимых MIME-типов загружаемых файлов, например "image/*".

`Optional`action

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

Адрес загрузки или функция, возвращающая адрес.

Param: file

Загружаемый файл.

`Optional`beforeUpload

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

Функция, вызываемая перед загрузкой.

Type declaration

- (file: RcFile, FileList: RcFile[]): boolean | PromiseLike<void>
- Parameters
  - file: RcFile
    Файл для загрузки.
  - FileList: RcFile[]
    Список файлов.
  Returns boolean | PromiseLike<void>

`Optional`className

className?: string

Дополнительный CSS-класс контейнера.

`Optional`customRequest

customRequest?: (options: UploadCustomRequestOptions) => void

Пользовательская функция загрузки файла.

Type declaration

- (options: UploadCustomRequestOptions): void
- Parameters
  - options: UploadCustomRequestOptions
    Параметры запроса.
  Returns void

`Optional`data

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

Дополнительные параметры запроса или функция.

Param: file

Загружаемый файл.

`Optional`defaultFileList

defaultFileList?: UploadFile[]

Список файлов по умолчанию.

`Optional`directory

directory?: boolean

Включает загрузку целой директории.

`Optional`disabled

disabled?: boolean

Отключение загрузки.

`Optional`errorText

errorText?: string

Текст ошибки при загрузке.

`Optional`fileList

fileList?: UploadFile[]

Текущий список загружаемых файлов.

`Optional`headers

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

Заголовки запроса.

`Optional`iconRender

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

Функция для рендера иконки файла.

Type declaration

- (file: UploadFile, listType?: "picture" | "text" | "picture-card"): ReactNode
- Parameters
  - file: UploadFile
    Файл для рендера.
  - OptionallistType: "picture" | "text" | "picture-card"
    Тип списка.
  Returns ReactNode

`Optional`id

id?: string

Идентификатор компонента.

`Optional`isImageUrl

isImageUrl?: (file: UploadFile) => boolean

Функция для проверки, является ли файл изображением.

Type declaration

- (file: UploadFile): boolean
- Parameters
  - file: UploadFile
    Файл для проверки.
  Returns boolean

`Optional`listType

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

Тип визуального представления списка файлов.

`Optional`locale

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

Локализованные надписи.

`Optional`method

HTTP-метод загрузки.

`Optional`multiple

multiple?: boolean

Разрешает множественный выбор файлов.

`Optional`name

name?: string

Имя параметра для отправки файла.

`Optional`onChange

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

Колбэк, вызываемый при изменении списка файлов.

Type declaration

- (
      info: {
          event?: { percent: number };
          file: UploadFile;
          fileList: UploadFile[];
      },
  ): void
- Parameters
  - info: { event?: { percent: number }; file: UploadFile; fileList: UploadFile[] }
    Объект с информацией о загружаемом файле.
  Returns void

`Optional`onDownload

onDownload?: (file: UploadFile) => void

Колбэк для загрузки файла.

Type declaration

- (file: UploadFile): void
- Parameters
  - file: UploadFile
    Файл для загрузки.
  Returns void

`Optional`onPreview

onPreview?: (file: UploadFile) => void

Колбэк предпросмотра файла.

Type declaration

- (file: UploadFile): void
- Parameters
  - file: UploadFile
    Файл для предпросмотра.
  Returns void

`Optional`onRemove

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

Колбэк, вызываемый при удалении файла.

Type declaration

- (file: UploadFile): boolean | void | Promise<boolean | void>
- Parameters
  - file: UploadFile
    Файл для удаления.
  Returns boolean | void | Promise<boolean | void>

`Optional`openFileDialogOnClick

openFileDialogOnClick?: boolean

Отображать диалог выбора файла при клике.

`Optional`prefixCls

prefixCls?: string

Префикс CSS-класса компонента.

`Optional`previewFile

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

Функция для генерации предпросмотра файла.

Type declaration

- (file: File | Blob): PromiseLike<string>
- Parameters
  - file: File | Blob
    Объект файла или Blob.
  Returns 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

CSS-стили.

`Optional`supportServerRender

supportServerRender?: boolean

Включение рендеринга сервера.

`Optional`transformFile

Функция для преобразования файла перед загрузкой.

Type declaration

- (file: RcFile): string | File | Blob | PromiseLike<string | File | Blob>
- Parameters
  - file: RcFile
    Файл для преобразования.
  Returns string | File | Blob | PromiseLike<string | File | Blob>

`Optional`type

type?: "select" | "drag"

Тип загрузки: перетаскивание или выбор.

`Optional`withCredentials

withCredentials?: boolean

Указывает, следует ли отправлять куки при кросс-доменной загрузке.

Interface UploadProps

Public

Index

Properties

Properties

Optionalaccept

Optionalaction

Param: file

OptionalbeforeUpload

Type declaration

Parameters

Returns boolean | PromiseLike<void>

OptionalclassName

OptionalcustomRequest

Type declaration

Parameters

Returns void

Optionaldata

Param: file

OptionaldefaultFileList

Optionaldirectory

Optionaldisabled

OptionalerrorText

OptionalfileList

Optionalheaders

OptionaliconRender

Type declaration

Parameters

Returns ReactNode

Optionalid

OptionalisImageUrl

Type declaration

Parameters

Returns boolean

OptionallistType

Optionallocale

Optionalmethod

Optionalmultiple

Optionalname

OptionalonChange

Type declaration

Parameters

Returns void

OptionalonDownload

Type declaration

Parameters

Returns void

OptionalonPreview

Type declaration

Parameters

Returns void

OptionalonRemove

Type declaration

Parameters

Returns boolean | void | Promise<boolean | void>

OptionalopenFileDialogOnClick

OptionalprefixCls

OptionalpreviewFile

Type declaration

Parameters

Returns PromiseLike<string>

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

`Optional`accept

`Optional`action

`Optional`beforeUpload

`Optional`className

`Optional`customRequest

`Optional`data

`Optional`defaultFileList

`Optional`directory

`Optional`disabled

`Optional`errorText

`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