Interface ShowFileUploadOptions

The options to configure the file upload dialog.

interface ShowFileUploadOptions {
    buttons?: MessageBubbleButtonProps[];
    description?: ReactNode;
    error?: ReactNode;
    fileUploadText?: ReactNode;
    fileUploadTitle: ReactNode;
    forcePosition?: Position;
    isDraggable?: boolean;
    loadingText?: string;
    maxFileLimit?: number;
    maxFileSize?: {
        message: string;
        size: number;
    };
    minFileLimit?: number;
    overlay?: boolean;
    text: ReactNode;
    title?: ReactNode;
    uploadButton: ReactNode;
    validate?: ((mwFile: DroppedMwFile) => Promise<{
        isValid: boolean;
        message: string;
        processedFile?: any;
    }>);
}

Hierarchy (view full)

Properties

buttons? description? error? fileUploadText? fileUploadTitle forcePosition? isDraggable? loadingText? maxFileLimit? maxFileSize? minFileLimit? overlay? text title? uploadButton validate?

Properties

Optionalbuttons

buttons?: MessageBubbleButtonProps[]

A list of buttons that will resolve the message. By default, a Proceed button with value ok. The helper will resolve with the value of the button that was clicked.

Optionaldescription

description?: ReactNode

A description shown under the title. Usually, describes the contents of the step.

Optionalerror

error?: ReactNode

The error message to display if the user tries to upload too many files.

OptionalfileUploadText

fileUploadText?: ReactNode

The text of the upload file input.

fileUploadTitle

fileUploadTitle: ReactNode

The title of the file upload dialog.

OptionalforcePosition

forcePosition?: Position

Force the position of the bubble.

OptionalisDraggable

isDraggable?: boolean

If true, the bubble will be draggable. Default true

OptionalloadingText

loadingText?: string

The text to display while the file is being uploaded.

OptionalmaxFileLimit

maxFileLimit?: number

The maximum number of files that can be uploaded.

OptionalmaxFileSize

maxFileSize?: {
    message: string;
    size: number;
}

Pre-validation of file size, before converting to base64.

OptionalminFileLimit

minFileLimit?: number

The minimum number of files that can be uploaded.

Optionaloverlay

overlay?: boolean

Obscure the content behind the message and prevent interaction.

text

text: ReactNode

Markdown text to show in the content. Usually, the instructions for the current step. It also accepts ReactNodes.

Optionaltitle

title?: ReactNode

A title shown in the header. Usually, the title of the step.

uploadButton

uploadButton: ReactNode

The label to use for the upload button.

Optionalvalidate

validate?: ((mwFile: DroppedMwFile) => Promise<{
    isValid: boolean;
    message: string;
    processedFile?: any;
}>)

A function that takes a DroppedFile object and returns a promise that resolves to an object with isValid and message properties. If the isValid property is false, the message property should contain an error message. If the isValid property is true, the message property should be empty. If the validate function is not provided, all files will be considered valid.

Settings

On This Page

Properties