Vant3 中文入门教程 Vant3 NoticeBar 通知栏

2024-02-25 开发教程 Vant3 中文入门教程 匿名 6

介绍

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

实例演示

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册。

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

通知栏模式

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

<!-- 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

通知栏模式,可选值为 closeablelink

string

''

text通知文本内容

string

''

color通知文本颜色

string

#f60

background滚动条背景

string

#fff7cc

left-icon左侧图标名称或图片链接

string

-
delay动画延迟时间 (s)

number | string

1

speed滚动速率 (px/s)

number | string

60

scrollable是否开启滚动播放,内容长度溢出时默认开启

boolean

-
wrapable是否开启文本换行,只在禁用滚动时生效

boolean

false

Events

事件名说明回调参数
click点击通知栏时触发

event: MouseEvent

close关闭通知栏时触发

event: MouseEvent

replay每当滚动栏重新开始滚动时触发-

方法

通过 ref 可以获取到 NoticeBar 实例并调用实例方法,详见组件实例方法。

方法名说明参数返回值

reset v3.1.1

重置通知栏到初始状态--

Slots

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

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件。

名称默认值描述
--van-notice-bar-height

40px

-
--van-notice-bar-padding

0 var(--van-padding-md)

-
--van-notice-bar-wrapable-padding

var(--van-padding-xs) var(--van-padding-md)

-
--van-notice-bar-text-color

var(--van-orange-dark)

-
--van-notice-bar-font-size

var(--van-font-size-md)

-
--van-notice-bar-line-height

24px

-
--van-notice-bar-background-color

var(--van-orange-light)

-
--van-notice-bar-icon-size

16px

-
--van-notice-bar-icon-min-width

24px

-