Skip to content

Toast 轻提示 ​

查看 sn-toast 的 2.0 版本差异

基础用法 ​

轻提示(吐司),默认居中显示、2 秒后自动消失,可配置图标、加载状态与显示位置。

  • 通过组件方法显示与关闭:可按组件配置显示,也可传入参数临时覆盖配置
  • 默认不拦截手势,提示期间仍可操作页面;开启遮罩后可防穿透
  • 加载状态下不自动关闭,需手动关闭

必须放在 sn-page 下

本组件为弹出层,需直接放在 sn-page 根节点下使用,否则主题颜色与动画时长等 CSS 变量无法作用到组件内部。

建议直接使用 API

推荐使用 snu.showToast:无需在页面放置组件或绑定 ref,任意位置可直接调用(snu.hideToast() 关闭),配置字段与组件 props 一致(组件的 overlay 对应 API 的 passThrough,默认均为不拦截手势)。组件本身不提供插槽,需先放置到页面再通过 ref 调用。

typescript
snu.showToast({ text: '保存成功', icon: 'success' })

snu.showToast({
	text: '加载中...',
	loading: true,
	duration: 3000
})
vue
<template>
	<sn-page>
		<sn-button text="显示轻提示" type="primary" @click="show"></sn-button>
		<sn-toast ref="toastEle" text="这是一个提示信息"></sn-toast>
	</sn-page>
</template>

更多演示请下载 demo 查看

属性 ​

参数说明类型默认值可选值
text提示文本内容String''-
bgColor轻提示背景颜色,支持 $ 简写主题色String$toast-
overlay是否显示透明遮罩(防穿透),开启后提示期间拦截底部页面点击Booleanfalsetrue | false
position轻提示位置Stringcentertop | center | bottom
duration轻提示显示时长(ms),loading 为 true 时不自动关闭Number2000-
textSize提示文本字体大小String | Number$14-
textColor提示文本颜色,支持 $ 简写主题色String#fff-
borderRadius轻提示圆角大小String | Number$12-
padding轻提示内边距,支持 $ 前缀按间距乘数缩放String12px 15px-
icon提示图标名称(sn-icon 图标名)String''-
iconSize图标大小String | Number$20-
iconColor图标颜色,支持 $ 简写主题色(loading 圈的描边色同样取此颜色)String#fff-
textAlign文本对齐方式Stringcenterleft | center | right
loading是否显示加载中图标(旋转 loading 圈)Booleanfalsetrue | false
textLines文本最大行数,超长自动换行,0 不限制Number0-
customStyle自定义轻提示内容块样式SnStyleValue''-

方法 ​

名称参数返回值描述
show--按组件 props 配置显示轻提示
configShowparam: SnToastParams | null-按传入参数显示轻提示,参数缺省字段回退组件 props 配置,无需改动属性
close--关闭轻提示(loading 状态下必须通过此方法关闭)

sn-toast 组件参数型轻提示的配置,见组件类型。

使用 MIT 协议