alighasami/vant
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: prettier all markdown files

Browse Source
This commit is contained in:
chenjiahan
2020-04-11 09:17:33 +08:00
committed by neverland
parent 48067f79db
commit 7f84f8a487
140 changed files with 4441 additions and 4723 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/notice-bar/README.md
+20 -24
View File
@@ -48,11 +48,7 @@ Vue.use(NoticeBar);
### Custom Style
```html
<van-notice-bar
color="#1989fa"
background="#ecf9ff"
left-icon="info-o"
>
<van-notice-bar color="#1989fa" background="#ecf9ff" left-icon="info-o">
Notice Content
</van-notice-bar>
```
@@ -62,28 +58,28 @@ Vue.use(NoticeBar);
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| mode | Mode, can be set to `closeable` `link` | *string* | `''` |
| text | Notice text content | *string* | `''` | - |
| color | Text color | *string* | `#f60` |
| background | Background color | *string* | `#fff7cc` |
| left-icon | Left Icon | *string* | - |
| delay | Animation delay (s) | *number \| string* | `1` |
| speed | Scroll speed (px/s) | *number \| string* | `50` |
| scrollable | Whether to scroll content | *boolean* | `true` |
| wrapable | Whether to enable text wrap | *boolean* | `false` | - |
| --- | --- | --- | --- |
| mode | Mode, can be set to `closeable` `link` | _string_ | `''` |
| text | Notice text content | _string_ | `''` | - |
| color | Text color | _string_ | `#f60` |
| background | Background color | _string_ | `#fff7cc` |
| left-icon | Left Icon | _string_ | - |
| delay | Animation delay (s) | _number \| string_ | `1` |
| speed | Scroll speed (px/s) | _number \| string_ | `50` |
| scrollable | Whether to scroll content | _boolean_ | `true` |
| wrapable | Whether to enable text wrap | _boolean_ | `false` | - |
### Events
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when click NoticeBar | *event: Event* |
| close | Triggered when closed | *event: Event* |
| Event | Description | Arguments |
| ----- | ------------------------------ | -------------- |
| click | Triggered when click NoticeBar | _event: Event_ |
| close | Triggered when closed | _event: Event_ |
### Slots
| Name | Description |
|------|------|
| default | Notice text content |
| left-icon | Custom left icon |
| right-icon | Custom right icon |
| Name | Description |
| ---------- | ------------------- |
| default | Notice text content |
| left-icon | Custom left icon |
| right-icon | Custom right icon |
src/notice-bar/README.zh-CN.md
+19 -23
View File
@@ -56,11 +56,7 @@ Vue.use(NoticeBar);
### 自定义样式
```html
<van-notice-bar
color="#1989fa"
background="#ecf9ff"
left-icon="info-o"
>
<van-notice-bar color="#1989fa" background="#ecf9ff" left-icon="info-o">
通知内容
</van-notice-bar>
```
@@ -70,28 +66,28 @@ Vue.use(NoticeBar);
### Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| mode | 通知栏模式，可选值为 `closeable` `link` | *string* | `''` |
| text | 通知文本内容 | *string* | `''` |
| color | 文本颜色 | *string* | `#f60` |
| background | 滚动条背景 | *string* | `#fff7cc` |
| left-icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
| delay | 动画延迟时间 (s) | *number \| string* | `1` |
| speed | 滚动速率 (px/s) | *number \| string* | `50` |
| scrollable | 是否在长度溢出时滚动播放 | *boolean* | `true` |
| wrapable | 是否开启文本换行，只在禁用滚动时生效 | *boolean* | `false` |
| --- | --- | --- | --- |
| mode | 通知栏模式，可选值为 `closeable` `link` | _string_ | `''` |
| text | 通知文本内容 | _string_ | `''` |
| color | 文本颜色 | _string_ | `#f60` |
| background | 滚动条背景 | _string_ | `#fff7cc` |
| left-icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | _string_ | - |
| delay | 动画延迟时间 (s) | _number \| string_ | `1` |
| speed | 滚动速率 (px/s) | _number \| string_ | `50` |
| scrollable | 是否在长度溢出时滚动播放 | _boolean_ | `true` |
| wrapable | 是否开启文本换行，只在禁用滚动时生效 | _boolean_ | `false` |
### Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击通知栏时触发 | *event: Event* |
| close | 关闭通知栏时触发 | *event: Event* |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------------- | -------------- |
| click | 点击通知栏时触发 | _event: Event_ |
| close | 关闭通知栏时触发 | _event: Event_ |
### Slots
| 名称 | 内容 |
|------|------|
| default | 通知文本内容 |
| left-icon | 自定义左侧图标 |
| 名称 | 内容 |
| ---------- | -------------- |
| default | 通知文本内容 |
| left-icon | 自定义左侧图标 |
| right-icon | 自定义右侧图标 |