vant/docs/markdown/en-US/toast.md

Toast

Install

import { Toast } from 'vant';

Usage

Text

Toast('Some messages');

Loading

Toast.loading({
  mask: true,
  message: 'Loading...'
});

Success/Fail

Toast.success('Success');
Toast.fail('Fail');

Advanced Usage

const toast = Toast.loading({
  duration: 0,       // continuous display toast
  forbidClick: true, // forbid click background
  message: '3 seconds'
});

let second = 3;
const timer = setInterval(() => {
  second--;
  if (second) {
    toast.message = `${second} seconds`;
  } else {
    clearInterval(timer);
    Toast.clear();
  }
}, 1000);

$toast Method

After import the Toast component, the $toast method is automatically mounted on Vue.prototype, making it easy to call within a vue component.

export default {
  mounted() {
    this.$toast('Some messages');
  }
}

Singleton

Toast use singleton mode by default, if you need to pop multiple Toast at the same time, you can refer to the following example

Toast.allowMultiple();

const toast1 = Toast('First Toast');
const toast2 = Toast.success('Second Toast');

toast1.clear();
toast2.clear();

Methods

Methods	Attribute	Return value	Description
Toast	`options	message`	toast instance
Toast.loading	`options	message`	toast instance
Toast.success	`options	message`	toast instance
Toast.fail	`options	message`	toast instance
Toast.clear	clearAll	void	Close
Toast.allowMultiple	-	void	Allow multlple toast at the same time
Toast.setDefaultOptions	options	void	Set default options of all toasts
Toast.resetDefaultOptions	-	void	Reset default options of all toasts

Options

Attribute	Description	Type	Default	Accepted Values
type	Type	String	text	loading success fail html
message	Message	String	''	-
position	Position	String	middle	top bottom
mask	Whether to show mask	Boolean	false	-
forbidClick	Whether to forbid click background	Boolean	false	-
duration	Toast duration(ms)	Number	3000	Toast won't disappear if value is 0