Skip to content

使用 useToast Hook

基础用法

toast Options

属性类型默认值说明
positionstringTOP_CENTER显示位置
autoCloseboolean | numbertrue是否自动关闭(数字为毫秒)
pauseOnHoverbooleantrue鼠标悬停时暂停计时
closeOnClickbooleantrue点击是否关闭
draggablebooleanfalse是否可拖拽
draggablePercentnumber0.6拖拽阈值
toastClassNamestring-自定义 Toast 类名
bodyClassNamestring-自定义内容类名
isLoadingbooleanfalse是否显示加载状态
renderstring | Component-自定义渲染内容
typestring-Toast 类型:success, error, warn, info

位置常量

  • toast.POSITION.TOP_LEFT
  • toast.POSITION.TOP_CENTER
  • toast.POSITION.TOP_RIGHT
  • toast.POSITION.BOTTOM_LEFT
  • toast.POSITION.BOTTOM_CENTER
  • toast.POSITION.BOTTOM_RIGHT

预设方法

方法说明
toast(message, options)显示默认 Toast
toast.success(message, options)显示成功 Toast
toast.error(message, options)显示错误 Toast
toast.warn(message, options)显示警告 Toast
toast.info(message, options)显示信息 Toast
toast.loading(message, options)显示加载 Toast
toast.update(id, options)更新指定 Toast
toast.done(id)标记加载 Toast 完成
toast.remove(id)关闭指定 Toast
toast.clearAll()关闭所有 Toast

useToast Hook

typescript
const {
  success,   // 成功提示
  error,     // 错误提示
  warn,      // 警告提示
  info,      // 信息提示
  loading,   // 加载提示
  default,   // 默认提示
  clearAll,  // 关闭所有
  remove,    // 关闭指定
} = useToast()

风起江湖 · 资料站