Navbar 导航栏

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

常见问题

右图标被小程序胶囊挡住？

在小程序平台开启自定义顶部导航时，右上角会固定显示胶囊，所以此时右侧插槽及选项是不建议使用。

如何设置为背景透明？

通过 custom-style 设置组件 background-color 为 transparent。

<wui-navbar title="标题" custom-style="background-color: transparent !important;"></wui-navbar>

组件会被 video 覆盖？

video为原生组件，层级较高，目前无法遮盖，需要具体平台具体分析。

基础用法

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

<wui-navbar title="标题"></wui-navbar>

返回上级

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

<wui-navbar title="标题" left-text="返回" left-arrow @click-left="handleClickLeft"></wui-navbar>

function handleClickLeft() {
  uni.navigateBack()
}

右侧按钮

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

<wui-toast></wui-toast>

<wui-navbar title="标题" left-text="返回" left-arrow right-text="按钮" @click-left="handleClickLeft" @click-right="handleClickRight"></wui-navbar>

import { useToast } from '@/uni_modules/elegant-wui-uni'

const { show: showToast } = useToast()

function handleClickRight() {
  showToast('按钮')
}

使用插槽

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

<wui-navbar title="标题" left-text="返回" left-arrow>
  <template #right>
    <wui-icon name="search" size="18" />
  </template>
</wui-navbar>

固定在顶部

通过 fixed 可以设置导航条固定在页面顶部，通过设置 placeholder 可以在顶部生成占位空间，通过设置 safeAreaInsetTop 可以开启顶部安全区的适配。

<wui-navbar fixed placeholder title="Navbar 导航条" left-arrow safeAreaInsetTop></wui-navbar>

禁用按钮

通过 left-disabled 或 right-disabled 属性来禁用两侧的按钮。按钮被禁用时透明度降低，且无法点击。

<wui-navbar title="标题" left-text="返回" right-text="按钮" left-arrow left-disabled right-disabled></wui-navbar>

胶囊样式

通过 capsule 插槽和 navbar-capsule 组件定制返回胶囊。

<wui-navbar title="标题" left-text="返回" right-text="设置" left-arrow>
  <template #capsule>
    <wui-navbar-capsule @back="handleBack" @back-home="handleBackHome" />
  </template>
</wui-navbar>

function handleBack() {
  uni.navigateBack({})
}

function handleBackHome() {
  uni.reLaunch({ url: '/pages/index/Index' })
}

带搜索栏

通过 title 插槽，自定义标题。

<wui-navbar left-text="返回" right-text="设置" left-arrow>
  <template #title>
    <view class="search-box">
      <wui-search v-model="keyword" hide-cancel placeholder-left></wui-search>
    </view>
  </template>
</wui-navbar>

.search-box {
  display: flex;
  height: 100%;
  align-items: center;
  --wui-search-padding: 0;
  --wui-search-side-padding: 0;
  :deep() {
    .wui-search {
      background: transparent;
    }
  }
}

Navbar Attributes

参数	说明	类型	可选值	默认值	最低版本
title	卡片标题	string	-	''	-
leftText	左侧文案	string	-	''	-
rightText	右侧文案	string	-	''	-
leftArrow	显示左侧箭头	boolean	true, false	false	-
bordered	显示下边框	boolean	true, false	true	-
fixed	固定到顶部	boolean	true, false	false	-
placeholder	固定在顶部时，在标签位置生成一个等高的占位元素	boolean	true, false	false	-
zIndex	导航栏 z-index	number	-	1	-
safeAreaInsetTop	开启顶部安全区适配	boolean	true, false	false	-
leftDisabled	禁用左侧按钮，禁用时透明度降低，且无法点击	boolean	true, false	false	-
rightDisabled	禁用右侧按钮，禁用时透明度降低，且无法点击	boolean	true, false	false	-

Navbar Events

事件名称	说明	参数	最低版本
click-left	点击左侧按钮时触发	-	-
click-right	点击右侧按钮时触发	-	-

NavbarCapsule Events

事件名称	说明	参数	最低版本
back	点击返回按钮时触发	-	-
back-home	点击返回首页按钮时触发	-	-

Navbar Slot

名称	说明	最低版本
capsule	自定义胶囊（当存在胶囊时，left 不生效）	-
left	左侧内容	-
title	标题内容	-
right	右侧内容	-

外部样式类

类名	说明	最低版本
custom-class	根节点样式类	-
custom-style	根节点样式	-

源代码

文档

• 组件