Skip to content

Function: fileUpload()

ts
function fileUpload(ctx: Context, options: FileUploadOptions): Promise<MwFile[] | null>;

Defined in: src/renderer/templates/fileUpload.ts:71

Displays file upload dialog with validation.

Shows drop zone with automatic button state management. Proceed button disabled until files meet criteria (count limits, type, validation). Default: Cancel & Proceed button.

Parameters

ParameterTypeDescription
ctxContextRender context
optionsFileUploadOptionsUpload configuration

Returns

Promise<MwFile[] | null>

Uploaded MwFile array or null if cancelled

Examples

ts
import {fileUpload} from '@matterway/sdk/UI';

const files = await fileUpload(ctx, {
  title: 'Upload Documents',
  name: 'docs',
  fileUploadTitle: 'Drop files here',
  allowedTypes: ['.pdf', '.docx'],
  minFileLimit: 1,
  maxFileLimit: 3
});
ts
const files = await fileUpload(ctx, {
  title: 'Upload Documents',
  name: 'docs',
  fileUploadTitle: 'Drop files here',
  buttons: [
    {text: 'Cancel', value: 'cancel'},
    {text: 'Upload', value: 'upload'}
  ]
});
// files is null when Cancel is clicked

Matterway Assistant SDK Documentation