版本 >= v0.6.0-alpha.0
可以直接调用。低版本需要手动在页面(page)里挂载一个 Toast 组件并指定 id 为 toast
。
import { Cell, Toast } from "@taroify/core"
function ImperativeToast() {
return (
<>
{/* <Toast id="toast" /> */}
<Cell title="函数调用" clickable isLink onClick={() => Toast.open("文字提示")} />
</>
)
}
import { Cell, Toast } from "@taroify/core"
function BasicToast() {
const [open, setOpen] = useState(false)
return (
<>
<Toast open={open} onClose={setOpen}>
文字提示
</Toast>
<Cell title="基础用法" clickable onClick={() => setOpen(true)} />
</>
)
}
使用 type="loading"
方法展示加载提示。
Toast.open({ type: "loading", message: "加载中..." })}
<Toast open type="loading">
加载中...
</Toast>
使用 type="success"
展示成功提 示,使用 type="fail"
展示失败提示。
Toast.open({ type: "success", message: "成功文案" })
Toast.open({ type: "fail", message: "失败文案" })
<Toast open type="success">成功文案</Toast>
<Toast open type="fail">失败文案</Toast>
通过 icon
选项可以自定义图标,支持传入图标名称或图片链接。
Toast.open({ message: "自定义图标", icon: <LikeOutlined /> })
Toast.open({
message: "自定义图片",
icon: (
<Image
style={{
width: "40px",
height: "40px",
}}
src="https://img01.yzcdn.cn/vant/logo.png"
/>
),
})
<Toast open icon={<LikeOutlined />}>自定义图标</Toast>
<Toast
open
icon={<Image style={{ width: "1em", height: "1em" }}
src="https://img01.yzcdn.cn/vant/logo.png" />}
>
自定义图片
</Toast>
<Toast open icon={<Loading />}>加载中...</Toast>
Toast 默认渲染在屏幕正中位置,通过 position
属性可以控制 Toast 展示的位置。
Toast.open({
position: "top",
message: "顶部展示",
})
Toast.open({
position: "bottom",
message: "顶部展示",
})
<Toast open position="top">顶部展示</Toast>
<Toast open position="bottom">底部展示</Toast>
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
defaultOpen | 默认是否显示弹出层 | boolean | false |
open | 是否显示弹出层 | boolean | false |
type | 提示类型,可选值为 loading success fail html | string | text |
icon | 自定义图标,支持传入图标名称或图片链接 | ReactNode | - |
position | 弹出位置,可选值为 top bottom | string | center |
duration v0.4.0-alpha.0 | 动画时长,单位毫秒,值为 0 时,toast 不会消失 | number | string | 3000 |
backdrop | 是否显示遮罩层 | boolean | false |
children | 文本内容 | ReactNode | - |
onClose | 关闭时的回调函数 | (open : boolean) => void | - |
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
selector | 自定义节点选择器 | string | toast |
type | 提示类型,可选值为 loading success fail html | string | text |
icon | 自定义图标,支持传入图标或图片 | ReactNode | - |
position | 弹出位置,可选值为 top bottom | string | center |
duration v0.4.0-alpha.0 | 动画时长,单位毫秒,值为 0 时,toast 不会消失 | number | string | 3000 |
backdrop | 是否显示遮罩层 | boolean | false |
message | 文本内容 | ReactNode | - |
onClose | 关闭时的回调函数 | (open : boolean) => void | - |