mand-mobile/components/toast/README.en-US.md

4.8 KiB

title preview
Toast https://didi.github.io/mand-mobile/examples/#/toast

Import

import { Toast } from 'mand-mobile'

Toast.succeed('Good Job!')

this.$toast.info('hint') // Totally Import

Instruction

Code Examples

API

Toast Static Methods

Toast({content, icon, iconSvg, duration, position, hasMask, parentNode, square})

Dynamically create a toast

Props Description Type Default Note
icon name of icon String - refer to Icon component for customized icons
iconSvg use svg icon Boolean false -
content content of message String/Number - -
duration toast will be closed in milliseconds; if set duration as0, the toast will always be visible Number 3000 -
position display position String center top/center/bottom
hasMask whether to show a transparent mask, which will prevent users from clicking Boolean false -
parentNode portal node of toast HTMLElement document.body -
square 2.6.0+ use square style Boolean false -
Toast.info(content, duration, hasMask, parentNode, square)

Dynamically create a text toast

Props Description Type Default Note
content content of message String/Number - -
duration toast will be closed in milliseconds; if set duration as0, the toast will always be visible Number 3000 -
hasMask whether to show a transparent mask, which will prevent users from clicking Boolean false -
parentNode portal node of toast HTMLElement document.body -
square 2.6.0+ use square style Boolean false -
Toast.succeed(content, duration, hasMask, parentNode, square)

Dynamically create a success toast

Props Description Type Default Note
content content of message String/Number - -
duration toast will be closed in milliseconds; if set duration as0, the toast will always be visible Number 3000 -
hasMask whether to show a transparent mask, which will prevent users from clicking Boolean false -
parentNode portal node of toast HTMLElement document.body -
square 2.6.0+ use square style Boolean false -
Toast.failed(content, duration, hasMask, parentNode, square)

Dynamically create a failed toast

Props Description Type Default Note
content content of message String/Number - -
duration toast will be closed in milliseconds; if set duration as0, the toast will always be visible Number 3000 -
hasMask whether to show a transparent mask, which will prevent users from clicking Boolean false -
parentNode portal node of toast HTMLElement document.body -
square 2.6.0+ use square style Boolean false -
Toast.loading(content, duration, hasMask, parentNode, square)

Dynamically create a loading toast

Props Description Type Default Note
content content of message String/Number - -
duration toast will be closed in milliseconds; if set duration as0, the toast will always be visible Number 0 -
hasMask whether to show a transparent mask, which will prevent users from clicking Boolean false -
parentNode portal node of toast HTMLElement document.body -
square 2.6.0+ use square style Boolean false -
Toast.hide()

Hide current toast

Toast Props

2.3.0+

Props Description Type Default Note
icon name of icon String - refer to Icon component for customized icons
iconSvg use svg icon Boolean false -
content content of message String/Number - -
duration toast will be closed in milliseconds; if set duration as0, the toast will always be visible Number 3000 -
position display position String center top/center/bottom
hasMask whether to show a transparent mask, which will prevent users from clicking Boolean false -
square 2.6.0+ use square style Boolean false -

Toast Slots

default

<md-toast>
  <md-activity-indicator>loading...</md-activity-indicator>
</md-toast>

Toast Methods

2.3.0+

show()

Show toast

hide()

Hide toast

Toast Events

2.3.0+

@show()

Toast show event

@hide()

Toast hidden event