反馈类 · Toast
提示
Toast 提示是对用户的操作做出及时反馈,由用户的操作触发,反馈信息可以是操作的结果状态,如成功、失败、出错、警告等。

代码演示

如何引入

普通提示

信息提醒反馈

其他提示类型

包括成功、失败、警告

多色样式

可以使用 theme 设置浅色填充样式提高与界面的对比,默认为 'normal' 的白色模式。

链接文本

配合 Typography 可以自定义链接文本,用来配合更复杂的场景的使用。

修改延时

自定义时长 10s,默认时长为 3s

手动关闭

duration 设置为 0 时,toast 不会自动关闭,此时必须通过手动关闭。

Hooks 用法

通过 Toast.useToast 创建支持读取 context 的 contextHolder。此时的 toast 会渲染在 contextHolder 所在的节点处。
如果需要渲染到 Portal 中可以使用 ReactDOM.createPortal 方法。

API 参考

组件提供的静态方法,使用方式和参数如下:展示:可以直接传入 options 对象或 string,返回值为toastIdconst toastId = Toast.info({ /*...options*/ })
  • Toast.info(options || string)
  • Toast.error(options || string)
  • Toast.warning(options || string)
  • Toast.success(options || string)
手动关闭 ( toastId 为展示方法的返回值)
  • Toast.close(toastId)
属性说明类型默认值版本
bottom弹出位置 bottomnumber | string-0.25.0
content提示内容ReactNode''
duration自动关闭的延时,单位 s,设为 0 时不自动关闭number3
getPopupContainer指定父级 DOM,弹层将会渲染至该 DOM 中,自定义需要设置 container 和 内部的 .semi-toast-wrapper position: relative() => HTMLElement | null() => document.body0.34.0
icon自定义图标ReactNode0.25.0
left弹出位置 leftnumber | string-0.25.0
right弹出位置 rightnumber | string-0.25.0
showClose是否展示关闭按钮booleantrue0.25.0
textMaxWidth内容的最大宽度number | string4500.25.0
theme填充样式,支持 light, normalstringnormal1.0.0
top弹出位置 topnumber | string-0.25.0
zIndex弹层 z-index 值number1010
onClosetoast 关闭的回调函数() => void
全局配置在调用前提前配置,全局一次生效 ( >= 0.25.0 ):
  • Toast.config(config)
属性说明类型默认值版本
bottom弹出位置 bottomnumber | string-0.25.0
duration自动关闭的延时,单位 s,设为 0 时不自动关闭number30.25.0
getPopupContainer指定父级 DOM,弹层将会渲染至该 DOM 中,自定义需要设置 container 和 内部的 .semi-toast-wrapper position: relative() => HTMLElement | null() => document.body1.23.0
left弹出位置 leftnumber | string-0.25.0
right弹出位置 rightnumber | string-0.25.0
top弹出位置 topnumber | string-0.25.0
zIndex弹层 z-index 值number10100.25.0
  • ToastFactory.create(config) => Toast
    如果您的应用中需要使用不同 config 的 Toast,可以使用 ToastFactory.create(config)创建新的 Toast (>= 1.23):
全局销毁 ( >= 0.25.0 ):
  • Toast.destroyAll()
HookToast ( >= 1.2.0 ):
  • Toast.useToast()
    当你需要使用 Context 时,可以通过 Toast.useToast 创建一个 contextHolder 插入相应的节点中。此时通过 hooks 创建的 Toast 将会得到 contextHolder 所在位置的所有上下文。创建的 toast 对象拥有与以下方法:info, success, warning, error, close

Accessibility

ARIA

  • Toast 的 role 为 alert

设计变量

© 2021 Semi Design. All rights reserved.

京ICP备19058139号-13浙公网安备 33011002016131号

Designed & Developed with love by Douyin FE & MED