Skip to content

useToast

@astryxdesign/core v0.7.1 · useToast

返回值 ​

名称类型说明
show(options: ToastOptions) => () => void弹出一条提示。返回的函数用来关掉这一条。hook 本身可以直接调用,所以 toast({ body }) 和 toast.show({ body }) 是一回事。
dismiss(id: string) => void按 id 关掉一条提示。它挂在返回的函数上:toast.dismiss(id)。
clear() => void关掉当前所有提示,写作 toast.clear()。

提示配置 ​

名称类型默认值说明
bodystring—提示正文。必填。
type'info' | 'success' | 'warning' | 'error''info'提示的类型,决定配色和图标。
isAutoHidebooleantrue是否自动消失。error 类型的提示默认留着,等人关掉。
autoHideDurationnumber5000自动消失前停留的毫秒数。
uniqueIDstring—同一个身份的多条提示会合并成一条。
collisionBehavior'ignore' | 'overwrite''overwrite'uniqueID 撞上时怎么处理。
endContentComponent—正文后面的操作,例如「撤销」按钮。
onDismiss(reason: 'auto' | 'manual') => void—提示卡片自己关掉时调用:计时到了、点了关闭按钮、或者划走。
onHide(reason: 'auto' | 'manual') => void—提示被移除时调用,不管是哪种关闭方式。