Matterway
    Preparing search index...

    Interface ShowFileUploadOptions

    The options to configure the file upload dialog.

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    fileUploadTitle: ReactNode

    The title of the file upload dialog.

    uploadButton: ReactNode

    The label to use for the upload button.

    maxFileLimit?: number

    The maximum number of files that can be uploaded.

    minFileLimit?: number

    The minimum number of files that can be uploaded.

    error?: ReactNode

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

    fileUploadText?: ReactNode

    The text of the upload file input.

    loadingText?: string

    The text to display while the file is being uploaded.

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

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

    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.

    title?: ReactNode

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

    description?: ReactNode

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

    text

    text: ReactNode

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

    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.

    overlay?: boolean

    Obscure the content behind the message and prevent interaction.

    forcePosition?: Position

    Force the position of the bubble.

    isDraggable?: boolean

    If true, the bubble will be draggable. Default true

    Settings

    On This Page

    Properties