NavBar 导航栏

介绍

为页面提供导航功能,常用于页面顶部。

引入

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

  1. import { createApp } from 'vue';
  2. import { NavBar } from 'vant';
  3. const app = createApp();
  4. app.use(NavBar);

代码演示

基础用法

通过 title 属性设置导航栏标题。

  1. <van-nav-bar title="标题" />

返回上级

在导航栏实现返回上级功能。

  1. <van-nav-bar
  2. title="标题"
  3. left-text="返回"
  4. left-arrow
  5. @click-left="onClickLeft"
  6. />
  1. export default {
  2. setup() {
  3. const onClickLeft = () => history.back();
  4. return {
  5. onClickLeft,
  6. };
  7. },
  8. };

右侧按钮

在导航栏右侧添加可点击的按钮。

  1. <van-nav-bar
  2. title="标题"
  3. left-text="返回"
  4. right-text="按钮"
  5. left-arrow
  6. @click-left="onClickLeft"
  7. @click-right="onClickRight"
  8. />
  1. import { showToast } from 'vant';
  2. export default {
  3. setup() {
  4. const onClickLeft = () => history.back();
  5. const onClickRight = () => showToast('按钮');
  6. return {
  7. onClickLeft,
  8. onClickRight,
  9. };
  10. },
  11. };

使用插槽

可以通过插槽自定义导航栏两侧的内容。

  1. <van-nav-bar title="标题" left-text="返回" left-arrow>
  2. <template #right>
  3. <van-icon name="search" size="18" />
  4. </template>
  5. </van-nav-bar>

API

Props

参数说明类型默认值
title标题string‘’
left-text左侧文案string‘’
right-text右侧文案string‘’
left-arrow是否显示左侧箭头booleanfalse
border是否显示下边框booleantrue
fixed是否固定在顶部booleanfalse
placeholder固定在顶部时,是否在标签位置生成一个等高的占位元素booleanfalse
z-index导航栏 z-indexnumber | string1
safe-area-inset-top是否开启顶部安全区适配booleanfalse
clickable是否开启两侧按钮的点击反馈booleantrue

Slots

名称说明
title自定义标题
left自定义左侧区域内容
right自定义右侧区域内容

Events

事件名说明回调参数
click-left点击左侧按钮时触发event: MouseEvent
click-right点击右侧按钮时触发event: MouseEvent

类型定义

组件导出以下类型定义:

  1. import type { NavBarProps } from 'vant';

主题定制

样式变量

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

名称默认值描述
—van-nav-bar-height46px-
—van-nav-bar-backgroundvar(—van-background-2)-
—van-nav-bar-arrow-size16px-
—van-nav-bar-icon-colorvar(—van-primary-color)-
—van-nav-bar-text-colorvar(—van-primary-color)-
—van-nav-bar-title-font-sizevar(—van-font-size-lg)-
—van-nav-bar-title-text-colorvar(—van-text-color)-
—van-nav-bar-z-index1-

NavBar 导航栏 - 图1