Ioniconf 2022 logo

Uniting our global community of Ionic developers and contributors. May 25, 2022.

DocsPluginsCLI
pwaiosandroid

Toast

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

PWA Notes

PWA Elements are required for Toast plugin to work.

Example

import { Plugins } from '@capacitor/core';
const { Toast } = Plugins;

async show() {
  await Toast.show({
    text: 'Hello!'
  });
}

API

show(…)

show(options: ToastShowOptions) => Promise<void>
Param Type
options ToastShowOptions

Interfaces

ToastShowOptions

Prop Type Description
text string
duration "short" | "long" Duration of the toast, either ‘short’ (2000ms, default) or ‘long’ (3500ms)
position "center" | "bottom" | "top"
Previous
<- Storage
Contribute ->