vant-weapp/packages/notice-bar

NoticeBar 通知栏

介绍

用于循环播放展示一组消息通知。

引入

在app.json或index.json中引入组件，详细介绍见快速上手。

"usingComponents": {
  "van-notice-bar": "@vant/weapp/notice-bar/index"
}

代码演示

基础用法

<van-notice-bar
  left-icon="volume-o"
  text="在代码阅读过程中人们说脏话的频率是衡量代码质量的唯一标准。"
/>

滚动播放

通知栏的内容长度溢出时会自动开启滚动播放，通过 scrollable 属性可以控制该行为。

<!-- 文字较短时，通过设置 scrollable 属性开启滚动播放 -->
<van-notice-bar scrollable text="技术是开发它的人的共同灵魂。" />

<!-- 文字较长时，通过禁用 scrollable 属性关闭滚动播放 -->
<van-notice-bar
  scrollable="{{ false }}"
  text="在代码阅读过程中人们说脏话的频率是衡量代码质量的唯一标准。"
/>

多行展示

文字较长时，可以通过设置 wrapable 属性来开启多行展示。

<van-notice-bar
  wrapable
  scrollable="{{ false }}"
  text="在代码阅读过程中人们说脏话的频率是衡量代码质量的唯一标准。"
/>

通知栏模式

通知栏支持 closeable 和 link 两种模式。

<!-- closeable 模式，在右侧显示关闭按钮 -->
<van-notice-bar mode="closeable" text="技术是开发它的人的共同灵魂。" />

<!-- link 模式，在右侧显示链接箭头 -->
<van-notice-bar mode="link" text="技术是开发它的人的共同灵魂。" />

自定义样式

通过 color 属性设置文本颜色，通过 background 属性设置背景色。

<van-notice-bar
  color="#1989fa"
  background="#ecf9ff"
  left-icon="info-o"
  text="技术是开发它的人的共同灵魂。"
/>

自定义滚动速率

使用speed属性控制滚动速率。

<van-notice-bar
  text="{{ text }}"
  speed="{{speedValue}}"
  left-icon="//img.yzcdn.cn/public_files/2017/8/10/6af5b7168eed548100d9041f07b7c616.png"
/>

API

Props

参数	说明	类型	默认值
mode	通知栏模式，可选值为 closeable link	string	''
text	通知文本内容	string	''
color	通知文本颜色	string	#ed6a0c
background	滚动条背景	string	#fffbe8
left-icon	左侧图标名称或图片链接	string	-
delay	动画延迟时间 (s)	number	1
speed	滚动速率 (px/s)	number	60
scrollable	是否开启滚动播放，内容长度溢出时默认开启	boolean	-
wrapable	是否开启文本换行，只在禁用滚动时生效	boolean	false
open-type	微信开放能力	string	navigate

Events

事件名	说明	参数
click	点击通知栏时触发	event: Event
close	关闭通知栏时触发	event: Event

Slot

名称	说明
-	通知文本内容，仅在 text 属性为空时有效
left-icon	自定义左侧图标
right-icon	自定义右侧图标

外部样式类

类名	说明
custom-class	根节点样式类