From 04f1f0538bd77ba03f1684b852a91539005e6298 Mon Sep 17 00:00:00 2001 From: lwl <1181102955@qq.com> Date: Fri, 3 Dec 2021 09:56:48 +0800 Subject: [PATCH 1/3] =?UTF-8?q?docs:=20=E5=A2=9E=E5=8A=A0input=E8=8B=B1?= =?UTF-8?q?=E6=96=87=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../devui-vue/docs/components/input/index.md | 37 ++++--- .../docs/en-US/components/input/index.md | 104 ++++++++++++++++++ 2 files changed, 127 insertions(+), 14 deletions(-) create mode 100644 packages/devui-vue/docs/en-US/components/input/index.md diff --git a/packages/devui-vue/docs/components/input/index.md b/packages/devui-vue/docs/components/input/index.md index 896a29fb..f6abd640 100644 --- a/packages/devui-vue/docs/components/input/index.md +++ b/packages/devui-vue/docs/components/input/index.md @@ -12,17 +12,17 @@ ```vue diff --git a/packages/devui-vue/docs/en-US/components/input/index.md b/packages/devui-vue/docs/en-US/components/input/index.md new file mode 100644 index 00000000..2d1ca167 --- /dev/null +++ b/packages/devui-vue/docs/en-US/components/input/index.md @@ -0,0 +1,104 @@ +# Input + +Text input box. + +### When To Use + +When you want to manually enter text. + +### Basic Usage + +:::demo + +```vue + + +``` + +::: + +### Size + +:::demo + +```vue + +``` + +::: + +### Password Input + +:::demo + +```vue + + +``` + +::: + +### API + +| Parameter | Type | Default | Description | Jump to Demo | +| :-------------------: | :--------------: | :---------------------: | :--------------------------------------------: | :-------------------: | +| id | `string` | -- | Optional, input ID | [Basic Usage](#BasicUsage) | +| v-model | `string` | '' | Optional, bound value | [Password Input](#PasswordInput) | +| placeholder | `string` | -- | Optional, input placeholder | [Basic Usage](#BasicUsage) | +| maxLength | `number` | Number.MAX_SAFE_INTEGER | Optional, the max-length of the input box | | +| disabled | `boolean` | false | Optional, whether the input box is disabled | [Basic Usage](#BasicUsage) | +| error | `boolean` | false | Optional, indicating whether an input error occurs in the input box. | [Basic Usage](#BasicUsage) | +| size | `'sm'\|''\|'lg'` | '' | Optional, size of the text box. The value can be 'lg','','sm' | [Size](#Size) | +| cssClass | `string` | '' | Optional, support to pass in the class name to the input box | | +| showPassword | `boolean` | false | Optional, password input box | [Password Input](#PasswordInput) | +| autoFocus | `boolean` | false | Optional, whether the input box is auto-focused | [Basic Usage](#BasicUsage) | + + -- Gitee From db0b2c3a03d9d63cd04918960451345340627991 Mon Sep 17 00:00:00 2001 From: lwl <1181102955@qq.com> Date: Fri, 3 Dec 2021 13:35:26 +0800 Subject: [PATCH 2/3] =?UTF-8?q?docs:=20=E4=BF=AE=E6=94=B9=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E8=B7=B3=E8=BD=AC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../docs/en-US/components/input/index.md | 16 +++++++------- .../docs/en-US/components/search/index.md | 22 +++++++++---------- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/packages/devui-vue/docs/en-US/components/input/index.md b/packages/devui-vue/docs/en-US/components/input/index.md index 2d1ca167..03b02a6e 100644 --- a/packages/devui-vue/docs/en-US/components/input/index.md +++ b/packages/devui-vue/docs/en-US/components/input/index.md @@ -83,16 +83,16 @@ export default defineComponent({ | Parameter | Type | Default | Description | Jump to Demo | | :-------------------: | :--------------: | :---------------------: | :--------------------------------------------: | :-------------------: | -| id | `string` | -- | Optional, input ID | [Basic Usage](#BasicUsage) | -| v-model | `string` | '' | Optional, bound value | [Password Input](#PasswordInput) | -| placeholder | `string` | -- | Optional, input placeholder | [Basic Usage](#BasicUsage) | +| id | `string` | -- | Optional, input ID | [Basic Usage](#basic-usage) | +| v-model | `string` | '' | Optional, bound value |[Password Input](#password-input) | +| placeholder | `string` | -- | Optional, input placeholder | [Basic Usage](#basic-usage) | | maxLength | `number` | Number.MAX_SAFE_INTEGER | Optional, the max-length of the input box | | -| disabled | `boolean` | false | Optional, whether the input box is disabled | [Basic Usage](#BasicUsage) | -| error | `boolean` | false | Optional, indicating whether an input error occurs in the input box. | [Basic Usage](#BasicUsage) | -| size | `'sm'\|''\|'lg'` | '' | Optional, size of the text box. The value can be 'lg','','sm' | [Size](#Size) | +| disabled | `boolean` | false | Optional, whether the input box is disabled | [Basic Usage](#basic-usage) | +| error | `boolean` | false | Optional, indicating whether an input error occurs in the input box. | [Basic Usage](#basic-usage) | +| size | `'sm'\|''\|'lg'` | '' | Optional, size of the text box. The value can be 'lg','','sm' | [Size](#size) | | cssClass | `string` | '' | Optional, support to pass in the class name to the input box | | -| showPassword | `boolean` | false | Optional, password input box | [Password Input](#PasswordInput) | -| autoFocus | `boolean` | false | Optional, whether the input box is auto-focused | [Basic Usage](#BasicUsage) | +| showPassword | `boolean` | false | Optional, password input box |[Password Input](#password-input) | +| autoFocus | `boolean` | false | Optional, whether the input box is auto-focused | [Basic Usage](#basic-usage) | diff --git a/packages/devui-vue/docs/components/search/index.md b/packages/devui-vue/docs/components/search/index.md index 56d2381f..b1127a8f 100644 --- a/packages/devui-vue/docs/components/search/index.md +++ b/packages/devui-vue/docs/components/search/index.md @@ -12,7 +12,7 @@ ```vue