Skip to main content
Version: v5

@capacitor/toast

The Toast API provides a notification pop up for displaying important information to a user. Just like real toast!

Installโ€‹

npm install @capacitor/toast
npx cap sync

PWA Notesโ€‹

PWA Elements are required for the Toast plugin to work.

Exampleโ€‹

import { Toast } from '@capacitor/toast';

const showHelloToast = async () => {
await Toast.show({
text: 'Hello!',
});
};

APIโ€‹

show(...)โ€‹

show(options: ShowOptions) => Promise<void>

Shows a Toast on the screen

ParamType
options
ShowOptions

Since: 1.0.0


Interfacesโ€‹

ShowOptionsโ€‹

PropTypeDescriptionDefaultSince
textstringText to display on the Toast1.0.0
duration'short' | 'long'Duration of the Toast, either 'short' (2000ms) or 'long' (3500ms)'short'1.0.0
position'top' | 'center' | 'bottom'Position of the Toast. On Android 12 and newer all toasts are shown at the bottom.'bottom'1.0.0