Skip to content

NavBar 导航栏

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

基础用法

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

返回上级

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

右侧按钮

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

使用插槽

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

API

Props

参数说明类型默认值
icon左侧返回图标string / ComponentArrowLeft
title标题string''
left-text左侧文案string''
right-text右侧文案string''
left-disabled是否禁用左侧按钮,禁用时透明度降低,且无法点击booleanfalse
right-disabled是否禁用右侧按钮,禁用时透明度降低,且无法点击booleanfalse
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

类型定义

组件导出以下类型定义:

ts
import type { NavBarProps } from 'ryxon'

主题定制

样式变量

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

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

Released under the MIT License.