vant/packages/nav-bar/en-US.md
2019-05-15 20:53:04 +08:00

74 lines
1.3 KiB
Markdown

# NavBar
### Install
``` javascript
import { NavBar } from 'vant';
Vue.use(NavBar);
```
## Usage
### Basic Usage
```html
<van-nav-bar
title="Title"
left-text="Back"
right-text="Button"
left-arrow
@click-left="onClickLeft"
@click-right="onClickRight"
/>
```
```js
export default {
methods: {
onClickLeft() {
Toast('Back');
},
onClickRight() {
Toast('Button');
}
}
}
```
### Advanced Usage
```html
<van-nav-bar title="Title" left-text="Back" left-arrow>
<van-icon name="search" slot="right" />
</van-nav-bar>
```
## API
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| title | Title | `String` | `''` |
| left-text | Left Text | `String` | `''` |
| right-text | Right Text | `String` | `''` |
| left-arrow | Whether to show left arrow | `Boolean` | `false` |
| fixed | Whether to fixed top | `Boolean` | `false` |
| border | Whether to show bottom border | `Boolean` | `true` |
| z-index | Z-index | `Number` | `1` |
### Slots
| Name | Description |
|------|------|
| title | Custom title |
| left | Custom left side content |
| right | Custom right side content |
### Events
| Event | Description | Arguments |
|------|------|------|
| click-left | Triggered when click left button | - |
| click-right | Triggered when click right button | - |