Interface ShowUploadFileOptions

The options to configure the file upload dialog.

Hierarchy

Properties

buttons? description? error? fileLimit? fileUploadText? fileUploadTitle loadingText? overlay? text title? uploadButton validate?

Properties

Optional buttons

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

Optional description

description?: ReactNode

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

Optional error

error?: ReactNode

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

Optional fileLimit

fileLimit?: number

The maximum number of files that can be uploaded.

Optional fileUploadText

fileUploadText?: ReactNode

The text of the upload file input.

fileUploadTitle

fileUploadTitle: ReactNode

The title of the file upload dialog.

Optional loadingText

loadingText?: string

The text to display while the file is being uploaded.

Optional overlay

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

Optional title

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.

Optional validate

validate?: ((sdkFile) => Promise<{
    isValid: boolean;
    message: string;
}>)

Type declaration

    • (sdkFile): Promise<{
          isValid: boolean;
          message: string;
      }>

    • /**

      • 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.

      Parameters

      • sdkFile: DroppedFile

      Returns Promise<{
          isValid: boolean;
          message: string;
      }>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc