Skip to content

Badge 徽标

查看 sn-badge 的 2.0 版本差异

基础用法

  • 用以展示未读消息及消息提示,默认数字模式,包裹在需要显示徽标的内容右上角。
  • 支持数字模式(number)、文本模式(text)与浮点模式(dot);数字超过 max 时显示 max+,数字为 0 时默认隐藏。
  • 不包裹内容时也可独立使用,徽标直接显示在文档流中。
vue
<template>
	<sn-badge :value="15">
		<sn-avatar src="https://www.example.com/example.png"></sn-avatar>
	</sn-badge>
</template>

更多演示请下载 demo 查看

自定义徽标内容

  • 通过 value 插槽完全自定义徽标内部内容(优先级最高)。
  • 通过 offset 在默认右上角定位基础上追加位移,格式同 css transform(如 translate(-10px, 6px))。
vue
<template>
	<sn-badge :value="0">
		<template #value>
			<sn-icon name="emotion-happy-line" :size="12" color="#FFFFFF"></sn-icon>
		</template>
		<sn-icon name="notification-3-line" :size="26"></sn-icon>
	</sn-badge>
</template>

属性

参数说明类型默认值可选值
mode徽标显示模式BadgeModenumbernumber | text | dot
value数字模式下徽标的数字值Number0-
max数字模式下徽标的最大数字值,超过显示 max+-1 表示不限制Number-1-
text文本模式下徽标的文本内容String--
type徽标功能色,背景与文字色自动配套BadgeTypeerrorprimary | info | success | warning | error
bgColor徽标背景颜色,支持 $ 功能色简写;为空时取 type 对应色String--
textColor徽标文字颜色,支持 $ 功能色简写;为空时取 type 对应文字色String--
size数字/文本模式下控制字号,浮点模式下控制圆点直径;支持 $ 简写String | Number--
showZero数字模式下数字为 0 时是否显示Booleanfalsetrue | false
show是否显示徽标Booleantruetrue | false
offset徽标偏移量,格式同 css 属性 transformString--
alwaysWrap是否始终保留外层容器包裹内容;默认隐藏徽标时内容直出(无多余节点),开启后显隐切换带过渡动画Booleanfalsetrue | false
customStyle自定义徽标样式UTSJSONObject | String--
textStyle徽标内数字/文本的自定义样式UTSJSONObject | String--
dotStyle浮点模式下徽标圆点的自定义样式UTSJSONObject | String--
containStyle包裹内容的外层容器自定义样式UTSJSONObject | String--
badgeClass徽标的外部样式类String--
textClass徽标内数字/文本的外部样式类String--
containClass外层容器的外部样式类String--

插槽

名称说明
default需要显示徽标的内容,可选;不传时徽标独立使用
value完全自定义徽标内部内容,优先级最高

使用 MIT 协议