此组件一般用于在全屏页面中,典型的比如微信小程序左上角。

提示

右侧的演示中,导航栏上方有圆角,也有顶部的手机模型状态栏内容,以及返回图标和文字不对齐的情况。这是因为网页演示导致,实际中无此情况,请通过右上角的“演示”扫码查看实际效果。

# 平台差异说明

App(vue) App(nvue) H5 小程序

# 基本使用

默认情况下,该组件只有向左的箭头及返回主页的按钮,点击向左的箭头可以返回上一页。

  • 通过fixed配置是否将导航栏固定在顶部

说明

  • 非常适合在小程序全屏页面中,避开导航栏右侧的胶囊位置。
<template>
	<view>
		<!-- 2.0.19支持autoBack,默认为false -->
        <up-navbar-mini
            @leftClick="leftClick"
            :autoBack="true"
            homeUrl="/pages/index/index"
        >
        </up-navbar-mini>
	</view>
</template>
<script setup>  
  
// 定义方法
const leftClick = () => {  
    console.log('leftClick');  
};  

</script>
<script>
    methods:{
        leftClick() {
            console.log('leftClick');
        }
    }
</script>

# 注意事项

既然是要自定义导航栏,那么首先就要取消系统自带的导航栏,需要在uni-app目的根目录的"pages.json"中设置,同时在此设置状态栏字体的颜色(H5无效), 自定义导航栏后,如果想通过"uni.setNavigationBarColor"动态设置导航栏颜色相关参数,是可能会出问题的,请勿使用此方式。

// pages.json

"pages": [
	// navbar-自定义导航栏
	{
		"path": "/pages/navbar/index",
		"style": {
			"navigationStyle": "custom" ,// 隐藏系统导航栏
			"navigationBarTextStyle": "white" // 状态栏字体为白色,只能为 white-白色,black-黑色 二选一
		}
	}
]

# 导航栏高度

组件内部会自动加上状态栏的高度,并填充状态栏的占位区域。

# 自定义导航栏内容

通过自定义slot传入的内容

<template>
	<view>
        <up-navbar-mini
            :safeAreaInsetTop="false"
        >
            <template #left>
                <up-icon
                    name="arrow-left"
                    size="19"
                ></up-icon>
          </template>
	</up-navbar-mini>
  </view>
</template>

# 自定义导航栏背景颜色

uview-plus提供了一个bgColor参数,可以自定义导航栏的背景颜色:

<template>
	<view>
		<up-navbar-mini fixed :bgColor="bgColor">
			
		</up-navbar-mini>
		<view class="content">
			<!-- 正文内容 -->
		</view>
	</view>
</template>
<script setup>  
import { ref } from 'vue';  
  
// 创建响应式数据  
const bgColor = ref('#001f3f');  
</script>
<script>
	export default {
		data() {
			return {
				bgColor: '#001f3f',
			}
		}
	}
</script>

# 右侧演示页面源代码地址

点击以下链接以查看右侧演示页面的源码


 github  gitee

# API

# Props

参数 说明 类型 默认值 可选值
safeAreaInsetTop 是否开启顶部安全区适配 Boolean true false
fixed 导航栏是否固定在顶部 Boolean true false
leftIcon 左边返回图标的名称,只能为uview-plus自带的图标 String arrow-left -
bgColor 导航栏背景设置 String #ffffff -
height 导航栏高度(不包括状态栏高度在内,内部自动加上),单位px String | Number 44px -
iconSize 左侧返回图标的大小 String | Number 20px -
iconColor 左侧返回图标的颜色 String #303133 -
autoBack 点击左侧区域(返回图标),是否自动返回上一页 Boolean false true

# Event

名称 说明 类型
leftClick 点击左侧区域 Handler

# Slot

名称 说明
left 自定义左侧部分内容
center 自定义中部内容