Skip to content

Commit

Permalink
docs: button组件文档补充
Browse files Browse the repository at this point in the history
  • Loading branch information
@MrXiangXvFan
MrXiangXvFan committed Aug 13, 2024
1 parent cf7c3f4 commit 3a1d8ab
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions packages/vantui/src/button/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,26 +77,26 @@ import {

### ButtonProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/button.d.ts)

| 参数 | 说明 | 类型 | 默认值 | 必填 |
| ----------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- |
| icon | 传入 Icon 的 name 值 | _&nbsp;&nbsp;string<br/>_ | - | `false` |
| classPrefix | - | _&nbsp;&nbsp;string<br/>_ | - | `false` |
| type | - | _&nbsp;&nbsp;attr:<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"default"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"primary"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"info"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"warning"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"danger"<br/>_ | - | `false` |
| size | - | _&nbsp;&nbsp;attr:<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"small"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"normal"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"large"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"mini"<br/>_ | - | `false` |
| block | - | _&nbsp;&nbsp;boolean<br/>_ | - | `false` |
| round | - | _&nbsp;&nbsp;boolean<br/>_ | - | `false` |
| square | - | _&nbsp;&nbsp;boolean<br/>_ | - | `false` |
| loading | - | _&nbsp;&nbsp;boolean<br/>_ | - | `false` |
| hairline | - | _&nbsp;&nbsp;boolean<br/>_ | - | `false` |
| disabled | - | _&nbsp;&nbsp;boolean<br/>_ | - | `false` |
| loadingText | loading 的文案 | _&nbsp;&nbsp;ReactNode<br/>_ | 加载中 | `false` |
| loadingSize | - | _&nbsp;&nbsp;string<br/>_ | - | `false` |
| loadingType | - | _&nbsp;&nbsp;attr:<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"spinner"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"circular"<br/>_ | - | `false` |
| loadingMode | loading 的模式，按钮内 loading 或 Toast.loading | _&nbsp;&nbsp;"normal"&nbsp;&brvbar;&nbsp;"toast"<br/>_ | normal | `false` |
| loadingMask | loading 的蒙层,默认开启 | _&nbsp;&nbsp;boolean<br/>_ | true | `false` |
| color | - | _&nbsp;&nbsp;string<br/>_ | - | `false` |
| children | - | _&nbsp;&nbsp;ReactNode<br/>_ | - | `false` |
| onClick | - | _&nbsp;&nbsp;(<br/>&nbsp;&nbsp;&nbsp;&nbsp;event:&nbsp;ITouchEvent<br/>&nbsp;&nbsp;)&nbsp;=>&nbsp;void&nbsp;&brvbar;&nbsp;Promise<any><br/>_ | - | `false` |
| 参数 | 说明 | 类型 | 默认值 | 必填 |
| ----------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- |
| icon | 传入 Icon 的 name 值 | _&nbsp;&nbsp;string<br/>_ | - | `false` |
| classPrefix | 图标类名前缀 | _&nbsp;&nbsp;string<br/>_ | van-icon | `false` |
| type | 类型，可选值为 `primary` `info` `warning` `danger` | _&nbsp;&nbsp;attr:<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"default"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"primary"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"info"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"warning"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"danger"<br/>_ | default | `false` |
| size | 尺寸 | _&nbsp;&nbsp;attr:<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"small"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"normal"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"large"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"mini"<br/>_ | normal | `false` |
| block | 是否为块级元素 | _&nbsp;&nbsp;boolean<br/>_ | false | `false` |
| round | 是否为圆形按钮 | _&nbsp;&nbsp;boolean<br/>_ | false | `false` |
| square | 是否为方形按钮 | _&nbsp;&nbsp;boolean<br/>_ | false | `false` |
| loading | 是否显示为加载状态 | _&nbsp;&nbsp;boolean<br/>_ | false | `false` |
| hairline | 是否使用 0.5px 边框 | _&nbsp;&nbsp;boolean<br/>_ | false | `false` |
| disabled | 是否禁用按钮 | _&nbsp;&nbsp;boolean<br/>_ | false | `false` |
| loadingText | loading 的文案 | _&nbsp;&nbsp;ReactNode<br/>_ | 加载中 | `false` |
| loadingSize | 加载图标大小，默认单位为 px | _&nbsp;&nbsp;string<br/>_ | 20px | `false` |
| loadingType | 加载图标类型，可选值为 spinner | _&nbsp;&nbsp;attr:<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"spinner"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"circular"<br/>_ | circular | `false` |
| loadingMode | loading 的模式，按钮内 loading 或 Toast.loading | _&nbsp;&nbsp;"normal"&nbsp;&brvbar;&nbsp;"toast"<br/>_ | normal | `false` |
| loadingMask | loading 的蒙层,默认开启 | _&nbsp;&nbsp;boolean<br/>_ | true | `false` |
| color | 按钮颜色 | _&nbsp;&nbsp;string<br/>_ | - | `false` |
| children | - | _&nbsp;&nbsp;ReactNode<br/>_ | - | `false` |
| onClick | 点击按钮，且按钮状态不为加载或禁用时触发 | _&nbsp;&nbsp;(<br/>&nbsp;&nbsp;&nbsp;&nbsp;event:&nbsp;ITouchEvent<br/>&nbsp;&nbsp;)&nbsp;=>&nbsp;void&nbsp;&brvbar;&nbsp;Promise<any><br/>_ | - | `false` |

### 样式变量

Expand Down

0 comments on commit 3a1d8ab

Please sign in to comment.