当前位置: 首页 > 文档资料 > Vant 中文文档 >

NoticeBar 通知栏

优质
小牛编辑
129浏览
2023-12-01

介绍

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

引入

import { createApp } from 'vue';
import { NoticeBar } from 'vant';

const app = createApp();
app.use(NoticeBar);

代码演示

基础用法

通过 text 属性设置通知栏的内容,通过 left-icon 属性设置通知栏左侧的图标。

<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="在代码阅读过程中人们说脏话的频率是衡量代码质量的唯一标准。"
/>

通知栏模式

通知栏支持 closeablelink 两种模式。

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

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

自定义样式

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

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

垂直滚动

搭配 NoticeBar 和 Swipe 组件可以实现垂直滚动的效果。

<van-notice-bar left-icon="volume-o" :scrollable="false">
  <van-swipe
    vertical
    class="notice-swipe"
    :autoplay="3000"
    :show-indicators="false"
  >
    <van-swipe-item>内容 1</van-swipe-item>
    <van-swipe-item>内容 2</van-swipe-item>
    <van-swipe-item>内容 3</van-swipe-item>
  </van-swipe>
</van-notice-bar>

<style>
  .notice-swipe {
    height: 40px;
    line-height: 40px;
  }
</style>

API

Props

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

Events

事件名说明回调参数
click点击通知栏时触发event: Event
close关闭通知栏时触发event: Event
replay v2.6.2每当滚动栏重新开始滚动时触发-

Slots

名称内容
default通知文本内容
left-icon自定义左侧图标
right-icon自定义右侧图标