docs: type highlight (#4264)

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
+24 -24
View File
@@ -122,30 +122,30 @@ Use button slot to insert button
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| value | Field value | `string | number` | - | - |
| label | Field label | `string` | - | - |
| type | Input type, can be set to `tel` `number`<br>`textarea` `password` | `string` | `text` | - |
| size | Sizecan be set to `large` | `string` | - | - |
| maxlength | Max length of value | `string | number` | - | - |
| placeholder | Placeholder | `string` | - | - |
| border | Whether to show inner border | `boolean` | `true` | - |
| disabled | Whether to disable field | `boolean` | `false` | - |
| readonly | Whether to be readonly | `boolean` | `false` | - |
| required | Whether to show required mark | `boolean` | `false` | - |
| clearable | Whether to be clearable | `boolean` | `false` | - |
| clickable | Whether to show click feedback when clicked | `boolean` | `false` | - |
| is-link | Whether to show link icon | `boolean` | `false` | - |
| error | Whether to show error info | `boolean` | `false` | - |
| arrow-direction | Can be set to `left` `up` `down` | `string` | - | 2.0.4 |
| error-message | Error message | `string` | `''` | - |
| label-class | Label className | `any` | - | - |
| label-width | Label width | `string | number` | `90px` | - |
| label-align | Label text align, can be set to `center` `right` | `string` | `left` | - |
| input-align | Input text align, can be set to `center` `right` | `string` | `left` | - |
| error-message-align | Error message text align, can be set to `center` `right` | `string` | `left` | - |
| autosize | Textarea auto resizecan accpet an object,<br>e.g. { maxHeight: 100, minHeight: 50 } | `boolean | object` | `false` | - |
| left-icon | Left side icon name | `string` | - | - |
| right-icon | Right side icon name | `string` | - | - |
| value | Field value | *string \| number* | - | - |
| label | Field label | *string* | - | - |
| type | Input type, can be set to `tel` *number*<br>`textarea` `password` | *string* | `text` | - |
| size | Sizecan be set to `large` | *string* | - | - |
| maxlength | Max length of value | *string \| number* | - | - |
| placeholder | Placeholder | *string* | - | - |
| border | Whether to show inner border | *boolean* | `true` | - |
| disabled | Whether to disable field | *boolean* | `false` | - |
| readonly | Whether to be readonly | *boolean* | `false` | - |
| required | Whether to show required mark | *boolean* | `false` | - |
| clearable | Whether to be clearable | *boolean* | `false` | - |
| clickable | Whether to show click feedback when clicked | *boolean* | `false` | - |
| is-link | Whether to show link icon | *boolean* | `false` | - |
| error | Whether to show error info | *boolean* | `false` | - |
| arrow-direction | Can be set to `left` `up` `down` | *string* | - | 2.0.4 |
| error-message | Error message | *string* | `''` | - |
| label-class | Label className | *any* | - | - |
| label-width | Label width | *string \| number* | `90px` | - |
| label-align | Label text align, can be set to `center` `right` | *string* | `left` | - |
| input-align | Input text align, can be set to `center` `right` | *string* | `left` | - |
| error-message-align | Error message text align, can be set to `center` `right` | *string* | `left` | - |
| autosize | Textarea auto resizecan accpet an object,<br>e.g. { maxHeight: 100, minHeight: 50 } | *boolean \| object* | `false` | - |
| left-icon | Left side icon name | *string* | - | - |
| right-icon | Right side icon name | *string* | - | - |
### Events
+24 -24
View File
@@ -126,30 +126,30 @@ Vue.use(Field);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| label | 输入框左侧文本 | `string` | - | - |
| value | 当前输入的值 | `string | number` | - | - |
| type | 输入框类型, 可选值为 `tel` `number`<br>`textarea` `password` 等 | `string` | `text` | - |
| size | 大小,可选值为 `large` | `string` | - | - |
| maxlength | 输入的最大字符数 | `string | number` | - | - |
| placeholder | 占位提示文字 | `string` | - | - |
| border | 是否显示内边框 | `boolean` | `true` | - |
| disabled | 是否禁用输入框 | `boolean` | `false` | - |
| readonly | 是否只读 | `boolean` | `false` | - |
| required | 是否显示表单必填星号 | `boolean` | `false` | - |
| clearable | 是否启用清除控件 | `boolean` | `false` | - |
| clickable | 是否开启点击反馈 | `boolean` | `false` | - |
| is-link | 是否展示右侧箭头并开启点击反馈 | `boolean` | `false` | - |
| error | 是否将输入内容标红 | `boolean` | `false` | - |
| arrow-direction | 箭头方向,可选值为 `left` `up` `down` | `string` | - | 2.0.4 |
| error-message | 底部错误提示文案,为空时不展示 | `string` | `''` | -
| label-class | 左侧文本额外类名 | `any` | - | - |
| label-width | 左侧文本宽度,可指定单位,默认为 px | `string | number` | `90px` | - |
| label-align | 左侧文本对齐方式,可选值为 `center` `right` | `string` | `left` | - |
| input-align | 输入框内容对齐方式,可选值为 `center` `right` | `string` | `left` | - |
| error-message-align | 错误提示文案对齐方式,可选值为 `center` `right` | `string` | `left` | - |
| autosize | 自适应内容高度,只对 textarea 有效,可传入对象,<br>如 { maxHeight: 100, minHeight: 50 },单位为 px | `boolean | object` | `false` | - |
| left-icon | 输入框左侧图标名称或图片链接,可选值见 Icon 组件 | `string` | - | - |
| right-icon | 输入框尾部图标名称或图片链接,可选值见 Icon 组件 | `string` | - | - |
| label | 输入框左侧文本 | *string* | - | - |
| value | 当前输入的值 | *string \| number* | - | - |
| type | 输入框类型, 可选值为 `tel` *number*<br>`textarea` `password` 等 | *string* | `text` | - |
| size | 大小,可选值为 `large` | *string* | - | - |
| maxlength | 输入的最大字符数 | *string \| number* | - | - |
| placeholder | 占位提示文字 | *string* | - | - |
| border | 是否显示内边框 | *boolean* | `true` | - |
| disabled | 是否禁用输入框 | *boolean* | `false` | - |
| readonly | 是否只读 | *boolean* | `false` | - |
| required | 是否显示表单必填星号 | *boolean* | `false` | - |
| clearable | 是否启用清除控件 | *boolean* | `false` | - |
| clickable | 是否开启点击反馈 | *boolean* | `false` | - |
| is-link | 是否展示右侧箭头并开启点击反馈 | *boolean* | `false` | - |
| error | 是否将输入内容标红 | *boolean* | `false` | - |
| arrow-direction | 箭头方向,可选值为 `left` `up` `down` | *string* | - | 2.0.4 |
| error-message | 底部错误提示文案,为空时不展示 | *string* | `''` | -
| label-class | 左侧文本额外类名 | *any* | - | - |
| label-width | 左侧文本宽度,可指定单位,默认为 px | *string \| number* | `90px` | - |
| label-align | 左侧文本对齐方式,可选值为 `center` `right` | *string* | `left` | - |
| input-align | 输入框内容对齐方式,可选值为 `center` `right` | *string* | `left` | - |
| error-message-align | 错误提示文案对齐方式,可选值为 `center` `right` | *string* | `left` | - |
| autosize | 自适应内容高度,只对 textarea 有效,可传入对象,<br>如 { maxHeight: 100, minHeight: 50 },单位为 px | *boolean \| object* | `false` | - |
| left-icon | 输入框左侧图标名称或图片链接,可选值见 Icon 组件 | *string* | - | - |
| right-icon | 输入框尾部图标名称或图片链接,可选值见 Icon 组件 | *string* | - | - |
### Events