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/icon/README.md
+14 -15
View File
@@ -22,7 +22,7 @@ Use `name` prop to set icon name or icon URL
### Show Badge
Use `dot` prop, a small red dot will be displayed in the upper right corner of the icon.
Use `dot` prop, a small red dot will be displayed in the upper right corner of the icon.
Use `badge` prop, the badge will be displayed in the upper right corner of the icon.
@@ -46,8 +46,7 @@ Use `color` prop to set icon color
Use `size` prop to set icon size
```html
<van-icon name="chat-o" size="40" />
<van-icon name="chat-o" size="3rem" />
<van-icon name="chat-o" size="40" /> <van-icon name="chat-o" size="3rem" />
```
### Use local font file
@@ -83,18 +82,18 @@ import 'vant/lib/icon/local.css';
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| name | Icon name or URL | *string* | `''` |
| dot `v2.2.1` | Whether to show red dot | *boolean* | `false` |
| badge `v2.5.6` | Content of the badge | *number \| string* | `''` |
| color | Icon color | *string* | `inherit` |
| size | Icon size | *number \| string* | `inherit` |
| class-prefix | ClassName prefix | *string* | `van-icon` |
| tag | HTML Tag | *string* | `i` |
| Attribute | Description | Type | Default |
| -------------- | ----------------------- | ------------------ | ---------- |
| name | Icon name or URL | _string_ | `''` |
| dot `v2.2.1` | Whether to show red dot | _boolean_ | `false` |
| badge `v2.5.6` | Content of the badge | _number \| string_ | `''` |
| color | Icon color | _string_ | `inherit` |
| size | Icon size | _number \| string_ | `inherit` |
| class-prefix | ClassName prefix | _string_ | `van-icon` |
| tag | HTML Tag | _string_ | `i` |
### Events
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when click icon | *event: Event* |
| Event | Description | Arguments |
| ----- | ------------------------- | -------------- |
| click | Triggered when click icon | _event: Event_ |
src/icon/README.zh-CN.md
+13 -14
View File
@@ -48,8 +48,7 @@ Vue.use(Icon);
`Icon`的`size`属性用来设置图标的尺寸大小，默认单位为`px`
```html
<van-icon name="chat-o" size="40" />
<van-icon name="chat-o" size="3rem" />
<van-icon name="chat-o" size="40" /> <van-icon name="chat-o" size="3rem" />
```
### 使用本地字体文件
@@ -90,18 +89,18 @@ import 'vant/lib/icon/local.css';
### Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| name | 图标名称或图片链接 | *string* | - |
| dot `v2.2.1` | 是否显示图标右上角小红点 | *boolean* | `false` |
| badge `v2.5.6` | 图标右上角徽标的内容 | *number \| string* | - |
| info | 图标右上角徽标的内容（已废弃，请使用 badge 属性） | *number \| string* | - |
| color | 图标颜色 | *string* | `inherit` |
| size | 图标大小，如 `20px` `2em`，默认单位为`px` | *number \| string* | `inherit` |
| class-prefix | 类名前缀，用于使用自定义图标 | *string* | `van-icon` |
| tag | HTML 标签 | *string* | `i` |
| --- | --- | --- | --- |
| name | 图标名称或图片链接 | _string_ | - |
| dot `v2.2.1` | 是否显示图标右上角小红点 | _boolean_ | `false` |
| badge `v2.5.6` | 图标右上角徽标的内容 | _number \| string_ | - |
| info | 图标右上角徽标的内容（已废弃，请使用 badge 属性） | _number \| string_ | - |
| color | 图标颜色 | _string_ | `inherit` |
| size | 图标大小，如 `20px` `2em`，默认单位为`px` | _number \| string_ | `inherit` |
| class-prefix | 类名前缀，用于使用自定义图标 | _string_ | `van-icon` |
| tag | HTML 标签 | _string_ | `i` |
### Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击图标时触发 | *event: Event* |
| 事件名 | 说明 | 回调参数 |
| ------ | -------------- | -------------- |
| click | 点击图标时触发 | _event: Event_ |