Toast API - MuPDF WebViewer

The toast object is an instance accessible from the main MuPDFWebViewer instance as follows:

const toast = webViewer.toast;

This assumes you have returned your instance name as webViewer from the initMuPDFWebViewer() promise!

toast

The toast object has the following methods:

show(config: {
  type: 'success' | 'fail' | 'notification';
  content: string;
  header?: string;
  timeout?: number;
}): Promise<undefined>;

Shows a toast message.

config

object

required

Configuration object.

Show config properties

config.type

'success' | 'fail' | 'notification'

required

Toast type ("success" | "fail" | "notification").

config.content

string

required

Toast content.

config.header

string

Toast header.

config.timeout

number

Display duration in milliseconds.

result

Promise<undefined>

required

A Promise.

Example

webViewer.toast.show({ type: 'success', content: 'Document opened' });