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

docs: type highlight (#4264)

Browse Source
This commit is contained in:
neverland
2019-08-27 22:09:21 +08:00
committed by GitHub
parent a79750d00c
commit ecbdc2bede
129 changed files with 1493 additions and 1484 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/action-sheet/README.md
+18 -18
View File
@@ -95,18 +95,18 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| actions | Options | `Action[]` | `[]` | - |
| title | Title | `string` | - | - |
| cancel-text | Text of cancel button | `string` | - | - |
| overlay | Whether to show overlay | `boolean` | `true` | - |
| round | Whether to show round corner | `boolean` | `false` | 2.0.9 |
| close-on-click-action | Whether to close when click action | `boolean` | `false` | - |
| close-on-click-overlay | Whether to close when click overlay | `boolean` | `true` | - |
| lazy-render | Whether to lazy render util appeared | `boolean` | `true` | - |
| lock-scroll | Whether to lock background scroll | `boolean` | `true` | - |
| duration | Transition duration, unit second | `number` | `0.3` | 2.0.3 |
| get-container | Return the mount node for action-sheet | `string | () => HTMLElement` | - | - |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | `boolean` | `false` | - |
| actions | Options | *Action[]* | `[]` | - |
| title | Title | *string* | - | - |
| cancel-text | Text of cancel button | *string* | - | - |
| overlay | Whether to show overlay | *boolean* | `true` | - |
| round | Whether to show round corner | *boolean* | `false` | 2.0.9 |
| close-on-click-action | Whether to close when click action | *boolean* | `false` | - |
| close-on-click-overlay | Whether to close when click overlay | *boolean* | `true` | - |
| lazy-render | Whether to lazy render util appeared | *boolean* | `true` | - |
| lock-scroll | Whether to lock background scroll | *boolean* | `true` | - |
| duration | Transition duration, unit second | *number* | `0.3` | 2.0.3 |
| get-container | Return the mount node for action-sheet | *string \| () => HTMLElement* | - | - |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | *boolean* | `false` | - |
### Events
@@ -124,9 +124,9 @@ export default {
| Key | Description | Type |
|------|------|------|
| name | Title | `string` |
| subname | Subtitle | `string` |
| color | Text color | `string` |
| className | className for the option | `any` |
| loading | Whether to be loading status | `boolean` |
| disabled | Whether to be disabled | `boolean` |
| name | Title | *string* |
| subname | Subtitle | *string* |
| color | Text color | *string* |
| className | className for the option | *any* |
| loading | Whether to be loading status | *boolean* |
| disabled | Whether to be disabled | *boolean* |
src/action-sheet/README.zh-CN.md
+18 -18
View File
@@ -109,18 +109,18 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| actions | 菜单选项 | `Action[]` | `[]` | - |
| title | 标题 | `string` | - | - |
| cancel-text | 取消按钮文字 | `string` | - | - |
| overlay | 是否显示遮罩层 | `boolean` | `true` | - |
| round | 是否显示圆角 | `boolean` | `false` | 2.0.9 |
| close-on-click-action | 是否在点击选项后关闭 | `boolean` | `false` | - |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | `boolean` | `true` | - |
| lazy-render | 是否在显示弹层时才渲染节点 | `boolean` | `true` | - |
| lock-scroll | 是否锁定背景滚动 | `boolean` | `true` | - |
| duration | 动画时长，单位秒 | `number` | `0.3` | 2.0.3 |
| get-container | 指定挂载的节点，可以传入选择器，<br>或一个返回节点的函数 | `string | () => HTMLElement` | - | - |
| safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `boolean` | `false` | - |
| actions | 菜单选项 | *Action[]* | `[]` | - |
| title | 标题 | *string* | - | - |
| cancel-text | 取消按钮文字 | *string* | - | - |
| overlay | 是否显示遮罩层 | *boolean* | `true` | - |
| round | 是否显示圆角 | *boolean* | `false` | 2.0.9 |
| close-on-click-action | 是否在点击选项后关闭 | *boolean* | `false` | - |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `true` | - |
| lazy-render | 是否在显示弹层时才渲染节点 | *boolean* | `true` | - |
| lock-scroll | 是否锁定背景滚动 | *boolean* | `true` | - |
| duration | 动画时长，单位秒 | *number* | `0.3` | 2.0.3 |
| get-container | 指定挂载的节点，可以传入选择器，<br>或一个返回节点的函数 | *string \| () => HTMLElement* | - | - |
| safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | *boolean* | `false` | - |
### Events
@@ -140,9 +140,9 @@ export default {
| 键名 | 说明 | 类型 |
|------|------|------|
| name | 标题 | `string` |
| subname | 二级标题 | `string` |
| color | 选项文字颜色 | `string` |
| className | 为对应列添加额外的 class | `any` |
| loading | 是否为加载状态 | `boolean` |
| disabled | 是否为禁用状态 | `boolean` |
| name | 标题 | *string* |
| subname | 二级标题 | *string* |
| color | 选项文字颜色 | *string* |
| className | 为对应列添加额外的 class | *any* |
| loading | 是否为加载状态 | *boolean* |
| disabled | 是否为禁用状态 | *boolean* |