mirror of
https://gitee.com/vant-contrib/vant-weapp.git
synced 2025-04-06 03:58:05 +08:00
91 lines
2.1 KiB
Markdown
91 lines
2.1 KiB
Markdown
# NavBar 导航栏
|
|
|
|
### 介绍
|
|
|
|
为页面提供导航功能，常用于页面顶部。
|
|
|
|
### 引入
|
|
|
|
在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。
|
|
|
|
```json
|
|
"usingComponents": {
|
|
"van-nav-bar": "@vant/weapp/nav-bar/index"
|
|
}
|
|
```
|
|
|
|
## 代码演示
|
|
|
|
### 基础用法
|
|
|
|
```html
|
|
<van-nav-bar
|
|
title="标题"
|
|
left-text="返回"
|
|
right-text="按钮"
|
|
left-arrow
|
|
bind:click-left="onClickLeft"
|
|
bind:click-right="onClickRight"
|
|
/>
|
|
```
|
|
|
|
```js
|
|
Page({
|
|
onClickLeft() {
|
|
wx.showToast({ title: '点击返回', icon: 'none' });
|
|
},
|
|
onClickRight() {
|
|
wx.showToast({ title: '点击按钮', icon: 'none' });
|
|
},
|
|
});
|
|
```
|
|
|
|
### 高级用法
|
|
|
|
通过 slot 定制内容。
|
|
|
|
```html
|
|
<van-nav-bar title="标题" left-text="返回" left-arrow>
|
|
<van-icon name="search" slot="right" />
|
|
</van-nav-bar>
|
|
```
|
|
|
|
## API
|
|
|
|
### Props
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
| --- | --- | --- | --- |
|
|
| title | 标题 | _string_ | `''` |
|
|
| left-text | 左侧文案 | _string_ | `''` |
|
|
| right-text | 右侧文案 | _string_ | `''` |
|
|
| left-arrow | 是否显示左侧箭头 | _boolean_ | `false` |
|
|
| fixed | 是否固定在顶部 | _boolean_ | `false` |
|
|
| placeholder | 固定在顶部时是否开启占位 | _boolean_ | `false` |
|
|
| border | 是否显示下边框 | _boolean_ | `true` |
|
|
| z-index | 元素 z-index | _number_ | `1` |
|
|
| custom-style | 根节点自定义样式 | _string_ | - |
|
|
| safe-area-inset-top | 是否留出顶部安全距离（状态栏高度） | _boolean_ | `true` |
|
|
|
|
### Slot
|
|
|
|
| 名称 | 说明 |
|
|
| ----- | ------------------ |
|
|
| title | 自定义标题 |
|
|
| left | 自定义左侧区域内容 |
|
|
| right | 自定义右侧区域内容 |
|
|
|
|
### Events
|
|
|
|
| 事件名 | 说明 | 参数 |
|
|
| ---------------- | ------------------ | ---- |
|
|
| bind:click-left | 点击左侧按钮时触发 | - |
|
|
| bind:click-right | 点击右侧按钮时触发 | - |
|
|
|
|
### 外部样式类
|
|
|
|
| 类名 | 说明 |
|
|
| ------------ | ------------ |
|
|
| custom-class | 根节点样式类 |
|
|
| title-class | 标题样式类 |
|