Skip to content

Toast

静默式消息通知对话框,与 Message 不同的是 Toast 仅显示于屏幕的边角区域

实例

消息类型

显示位置

界面定制化

ts
DialogToast('Hello', { icon: false })
DialogToast('Hello', { closeButton: false })
DialogToast('Hello', { duration: 0 })
DialogToast('Hello', { offset: 100 })

API

ts
type MessageContent = string | VNode

function DialogToast(
  message?: MessageContent,
  callback?: Function,
  options?: ToastOptions
): Function

配置选项 ToastOptions 的类型

ts
interface ToastOptions {
  /**
   * 语言
   * @default `en`
   */
  language?: string
  /**
   * 自定义样式类名
   */
  customClass?: string
  /**
   * 消息类型
   * @default `info`
   */
  messageType?: 'info' | 'warning' | 'error' |'success'
  /**
   * 消息类型图标
   * @default true
   */
  icon?: boolean
  /**
   * 关闭按钮
   * @default false
   */
  closeButton?: boolean
  /**
   * 自动关闭对话框的时间(单位:毫秒)
   *
   * 设置为 0 则取消自动关闭
   *
   * @default 3000
   */
  duration?: number
  /**
   * 距离屏幕边缘的值
   * @default 16
   */
  offset?: string | number
  /**
   * 显示位置
   * @default `top-right`
   */
  placement?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
}

Released under the MIT License.