Appearance
Interface: ShowUploadFileOptions
Defined in: src/file/getFile.tsx:24
Deprecated
The options to configure the file upload dialog.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
fileUploadTitle | ReactNode | The title of the file upload dialog. | - | src/file/getFile.tsx:28 |
uploadButton | ReactNode | The label to use for the upload button. | - | src/file/getFile.tsx:32 |
maxFileLimit? | number | The maximum number of files that can be uploaded. | - | src/file/getFile.tsx:36 |
minFileLimit? | number | The minimum number of files that can be uploaded. | - | src/file/getFile.tsx:40 |
error? | ReactNode | The error message to display if the user tries to upload too many files. | - | src/file/getFile.tsx:44 |
fileUploadText? | ReactNode | The text of the upload file input. | - | src/file/getFile.tsx:48 |
loadingText? | string | The text to display while the file is being uploaded. | - | src/file/getFile.tsx:52 |
maxFileSize? | { size: number; message: string; } | Pre-validation of file size, before converting to base64. | - | src/file/getFile.tsx:56 |
maxFileSize.size | number | - | - | src/file/getFile.tsx:57 |
maxFileSize.message | string | - | - | src/file/getFile.tsx:58 |
validate? | (sdkFile: DroppedFile) => 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. | - | src/file/getFile.tsx:66 |
title? | ReactNode | Title shown in the header. | ShowMessageOptions.title | src/message/showMessage.tsx:17 |
description? | ReactNode | Description shown under the title. | ShowMessageOptions.description | src/message/showMessage.tsx:20 |
text | ReactNode | Markdown text or ReactNode shown in the content area. | ShowMessageOptions.text | src/message/showMessage.tsx:23 |
buttons? | MessageBubbleButtonProps[] | Buttons that resolve the message. Defaults to a single "Proceed" button with value ok. | ShowMessageOptions.buttons | src/message/showMessage.tsx:26 |
overlay? | boolean | If true, obscure the page behind the message and block interaction. | ShowMessageOptions.overlay | src/message/showMessage.tsx:29 |
overlayProps? | { blur?: boolean; blurIntensity?: number; background?: "white" | "grey"; } | Props passed to the overlay component. | ShowMessageOptions.overlayProps | src/message/showMessage.tsx:32 |
overlayProps.blur? | boolean | Apply a blur effect to the obscured content | - | src/message/components/MessageBubble.tsx:28 |
overlayProps.blurIntensity? | number | Custom blur intensity (in pixels) | - | src/message/components/MessageBubble.tsx:30 |
overlayProps.background? | "white" | "grey" | Background color of the overlay | - | src/message/components/MessageBubble.tsx:32 |
forcePosition? | Position | Force the position of the bubble. | ShowMessageOptions.forcePosition | src/message/showMessage.tsx:35 |
isDraggable? | boolean | If true, the bubble is draggable. Defaults to true. | ShowMessageOptions.isDraggable | src/message/showMessage.tsx:38 |