diff --git a/src/input/README.en-US.md b/src/input/README.en-US.md index e9f0d2b68..83d7f8f03 100644 --- a/src/input/README.en-US.md +++ b/src/input/README.en-US.md @@ -10,7 +10,7 @@ style | Object | - | CSS(Cascading Style Sheets) | N custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N adjust-position | Boolean | true | \- | N align | String | left | text align type。options: left/center/right | N -allow-input-over-max | Boolean | false | allow to continue input on value length is over `maxlength` or `maxcharacter` | N +allow-input-over-max | Boolean | false | `1.8.6`. allow to continue input on value length is over `maxlength` or `maxcharacter` | N always-embed | Boolean | false | \- | N auto-focus | Boolean | false | \- | N borderless | Boolean | false | input without border | N @@ -83,28 +83,29 @@ t-class-tips | \- ### CSS Variables The component provides the following CSS variables, which can be used to customize styles. -Name | Default Value | Description + +Name | Default Value | Description -- | -- | -- ---td-input-align-items | center | - ---td-input-bg-color | @bg-color-container | - ---td-input-border-color | @component-stroke | - ---td-input-border-left-space | 32rpx | - ---td-input-border-right-space | 0 | - ---td-input-default-text-color | @text-color-primary | - ---td-input-default-tips-color | @text-color-placeholder | - ---td-input-disabled-text-color | @text-color-disabled | - ---td-input-error-text-color | @error-color | - ---td-input-error-tips-color | @error-color | - ---td-input-label-max-width | 5em | - ---td-input-label-min-width | 2em | - ---td-input-label-text-color | @text-color-primary | - ---td-input-placeholder-text-color | @text-color-placeholder | - ---td-input-placeholder-text-font-size | @font-size-m | - ---td-input-prefix-icon-color | @text-color-primary | - ---td-input-success-text-color | @success-color | - ---td-input-success-tips-color | @success-color | - ---td-input-suffix-icon-color | @text-color-placeholder | - ---td-input-suffix-text-color | @text-color-primary | - ---td-input-vertical-padding | 32rpx | - ---td-input-warning-text-color | @warning-color | - ---td-input-warning-tips-color | @warning-color | - \ No newline at end of file +--td-input-align-items | center | - +--td-input-bg-color | @bg-color-container | - +--td-input-border-color | @component-stroke | - +--td-input-border-left-space | 32rpx | - +--td-input-border-right-space | 0 | - +--td-input-default-text-color | @text-color-primary | - +--td-input-default-tips-color | @text-color-placeholder | - +--td-input-disabled-text-color | @text-color-disabled | - +--td-input-error-text-color | @error-color | - +--td-input-error-tips-color | @error-color | - +--td-input-label-max-width | 5em | - +--td-input-label-min-width | 2em | - +--td-input-label-text-color | @text-color-primary | - +--td-input-placeholder-text-color | @text-color-placeholder | - +--td-input-placeholder-text-font-size | @font-size-m | - +--td-input-prefix-icon-color | @text-color-primary | - +--td-input-success-text-color | @success-color | - +--td-input-success-tips-color | @success-color | - +--td-input-suffix-icon-color | @text-color-placeholder | - +--td-input-suffix-text-color | @text-color-primary | - +--td-input-vertical-padding | 32rpx | - +--td-input-warning-text-color | @warning-color | - +--td-input-warning-tips-color | @warning-color | - diff --git a/src/input/README.md b/src/input/README.md index 0d2add9f5..518544848 100644 --- a/src/input/README.md +++ b/src/input/README.md @@ -89,7 +89,7 @@ style | Object | - | 样式 | N custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N adjust-position | Boolean | true | 键盘弹起时，是否自动上推页面 | N align | String | left | 文本内容位置，居左/居中/居右。可选项：left/center/right | N -allow-input-over-max | Boolean | false | 超出 `maxlength` 或 `maxcharacter` 之后是否允许继续输入 | N +allow-input-over-max | Boolean | false | `1.8.6`。超出 `maxlength` 或 `maxcharacter` 之后是否允许继续输入 | N always-embed | Boolean | false | 强制 input 处于同层状态，默认 focus 时 input 会切到非同层状态 (仅在 iOS 下生效) | N auto-focus | Boolean | false | (即将废弃，请直接使用 focus )自动聚焦，拉起键盘 | N borderless | Boolean | false | 是否开启无边框模式 | N diff --git a/src/radio/README.en-US.md b/src/radio/README.en-US.md index 638511aa8..4620c3a04 100644 --- a/src/radio/README.en-US.md +++ b/src/radio/README.en-US.md @@ -21,7 +21,7 @@ max-content-row | Number | 5 | \- | N max-label-row | Number | 3 | \- | N name | String | - | \- | N placement | String | - | options: left/right | N -readonly | Boolean | undefined | \- | N +readonly | Boolean | undefined | `1.8.6` | N value | String / Number / Boolean | false | Typescript：`T` `type RadioValue = string \| number \| boolean`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/radio/type.ts) | N ### Radio Events @@ -40,7 +40,6 @@ t-class-content | \- t-class-icon | \- t-class-label | \- - ### RadioGroup Props name | type | default | description | required @@ -55,7 +54,7 @@ keys | Object | - | Typescript：`KeysType`。[see more ts definition](https://g name | String | - | \- | N options | Array | - | Typescript：`Array` `type RadioOption = string \| number \| RadioOptionObj` `interface RadioOptionObj { label?: string; value?: string \| number; readonly?: boolean; disabled?: boolean; allowUncheck?: boolean; }`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/radio-group/type.ts) | N placement | String | left | options: left/right | N -readonly | Boolean | undefined | \- | N +readonly | Boolean | undefined | `1.8.6` | N value | String / Number / Boolean | - | Typescript：`T` `type RadioValue = string \| number \| boolean`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/radio-group/type.ts) | N default-value | String / Number / Boolean | undefined | uncontrolled property。Typescript：`T` `type RadioValue = string \| number \| boolean`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/radio-group/type.ts) | N @@ -68,23 +67,24 @@ change | `(value: RadioValue)` | \- ### CSS Variables The component provides the following CSS variables, which can be used to customize styles. -Name | Default Value | Description + +Name | Default Value | Description -- | -- | -- ---td-radio-bg-color | @bg-color-container | - ---td-radio-border-color | @component-stroke | - ---td-radio-content-checked-color | @font-gray-2 | - ---td-radio-content-color | @font-gray-2 | - ---td-radio-content-disabled-color | @font-gray-4 | - ---td-radio-content-font-size | 28rpx | - ---td-radio-content-line-height | 44rpx | - ---td-radio-font-size | 32rpx | - ---td-radio-icon-checked-color | @brand-color | - ---td-radio-icon-color | @component-border | - ---td-radio-icon-disabled-bg-color | @bg-color-component-disabled | - ---td-radio-icon-disabled-color | @brand-color-disabled | - ---td-radio-icon-size | 48rpx | - ---td-radio-label-checked-color | @font-gray-1 | - ---td-radio-label-color | @font-gray-1 | - ---td-radio-label-disabled-color | @font-gray-4 | - ---td-radio-label-line-height | 48rpx | - ---td-radio-vertical-padding | 32rpx | - \ No newline at end of file +--td-radio-bg-color | @bg-color-container | - +--td-radio-border-color | @component-stroke | - +--td-radio-content-checked-color | @font-gray-2 | - +--td-radio-content-color | @font-gray-2 | - +--td-radio-content-disabled-color | @font-gray-4 | - +--td-radio-content-font-size | 28rpx | - +--td-radio-content-line-height | 44rpx | - +--td-radio-font-size | 32rpx | - +--td-radio-icon-checked-color | @brand-color | - +--td-radio-icon-color | @component-border | - +--td-radio-icon-disabled-bg-color | @bg-color-component-disabled | - +--td-radio-icon-disabled-color | @brand-color-disabled | - +--td-radio-icon-size | 48rpx | - +--td-radio-label-checked-color | @font-gray-1 | - +--td-radio-label-color | @font-gray-1 | - +--td-radio-label-disabled-color | @font-gray-4 | - +--td-radio-label-line-height | 48rpx | - +--td-radio-vertical-padding | 32rpx | - diff --git a/src/radio/README.md b/src/radio/README.md index 90ede13d7..637217d33 100644 --- a/src/radio/README.md +++ b/src/radio/README.md @@ -6,6 +6,7 @@ isComponent: true --- + ## 引入 全局引入，在 miniprogram 根目录下的`app.json`中配置，局部引入，在需要引入的页面或组件的`index.json`中配置。 @@ -74,7 +75,7 @@ max-content-row | Number | 5 | 内容最大行数限制 | N max-label-row | Number | 3 | 主文案最大行数限制 | N name | String | - | HTML 元素原生属性 | N placement | String | - | 复选框和内容相对位置。优先级高于 RadioGroup.placement。Radio 单独存在时，默认值为 left。如果父组件存在 RadioGroup，默认值便由 RadioGroup.placement 决定。可选项：left/right | N -readonly | Boolean | undefined | 只读状态 | N +readonly | Boolean | undefined | `1.8.6`。只读状态 | N value | String / Number / Boolean | false | 单选按钮的值。TS 类型：`T` `type RadioValue = string \| number \| boolean`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/radio/type.ts) | N ### Radio Events @@ -93,7 +94,6 @@ t-class-content | 内容样式类 t-class-icon | 图标样式类 t-class-label | 标签样式类 - ### RadioGroup Props 名称 | 类型 | 默认值 | 描述 | 必传 @@ -108,7 +108,7 @@ keys | Object | - | 用来定义 value / label 在 `options` 中对应的字段 name | String | - | HTML 元素原生属性 | N options | Array | - | 单选组件按钮形式。RadioOption 数据类型为 string 或 number 时，表示 label 和 value 值相同。TS 类型：`Array` `type RadioOption = string \| number \| RadioOptionObj` `interface RadioOptionObj { label?: string; value?: string \| number; readonly?: boolean; disabled?: boolean; allowUncheck?: boolean; }`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/radio-group/type.ts) | N placement | String | left | 复选框和内容相对位置。优先级低于 Radio.placement。可选项：left/right | N -readonly | Boolean | undefined | 只读状态 | N +readonly | Boolean | undefined | `1.8.6`。只读状态 | N value | String / Number / Boolean | - | 选中的值。TS 类型：`T` `type RadioValue = string \| number \| boolean`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/radio-group/type.ts) | N default-value | String / Number / Boolean | undefined | 选中的值。非受控属性。TS 类型：`T` `type RadioValue = string \| number \| boolean`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/radio-group/type.ts) | N @@ -121,23 +121,24 @@ change | `(value: RadioValue)` | 选中值发生变化时触发 ### CSS Variables 组件提供了下列 CSS 变量，可用于自定义样式。 -名称 | 默认值 | 描述 + +名称 | 默认值 | 描述 -- | -- | -- ---td-radio-bg-color | @bg-color-container | - ---td-radio-border-color | @component-stroke | - ---td-radio-content-checked-color | @font-gray-2 | - ---td-radio-content-color | @font-gray-2 | - ---td-radio-content-disabled-color | @font-gray-4 | - ---td-radio-content-font-size | 28rpx | - ---td-radio-content-line-height | 44rpx | - ---td-radio-font-size | 32rpx | - ---td-radio-icon-checked-color | @brand-color | - ---td-radio-icon-color | @component-border | - ---td-radio-icon-disabled-bg-color | @bg-color-component-disabled | - ---td-radio-icon-disabled-color | @brand-color-disabled | - ---td-radio-icon-size | 48rpx | - ---td-radio-label-checked-color | @font-gray-1 | - ---td-radio-label-color | @font-gray-1 | - ---td-radio-label-disabled-color | @font-gray-4 | - ---td-radio-label-line-height | 48rpx | - ---td-radio-vertical-padding | 32rpx | - \ No newline at end of file +--td-radio-bg-color | @bg-color-container | - +--td-radio-border-color | @component-stroke | - +--td-radio-content-checked-color | @font-gray-2 | - +--td-radio-content-color | @font-gray-2 | - +--td-radio-content-disabled-color | @font-gray-4 | - +--td-radio-content-font-size | 28rpx | - +--td-radio-content-line-height | 44rpx | - +--td-radio-font-size | 32rpx | - +--td-radio-icon-checked-color | @brand-color | - +--td-radio-icon-color | @component-border | - +--td-radio-icon-disabled-bg-color | @bg-color-component-disabled | - +--td-radio-icon-disabled-color | @brand-color-disabled | - +--td-radio-icon-size | 48rpx | - +--td-radio-label-checked-color | @font-gray-1 | - +--td-radio-label-color | @font-gray-1 | - +--td-radio-label-disabled-color | @font-gray-4 | - +--td-radio-label-line-height | 48rpx | - +--td-radio-vertical-padding | 32rpx | - diff --git a/src/textarea/README.en-US.md b/src/textarea/README.en-US.md index a62b4edac..e4500f203 100644 --- a/src/textarea/README.en-US.md +++ b/src/textarea/README.en-US.md @@ -2,7 +2,6 @@ ## API - ### Textarea Props name | type | default | description | required @@ -10,7 +9,7 @@ name | type | default | description | required style | Object | - | CSS(Cascading Style Sheets) | N custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N adjust-position | Boolean | true | \- | N -allow-input-over-max | Boolean | false | \- | N +allow-input-over-max | Boolean | false | `1.8.6` | N autofocus | Boolean | false | \- | N autosize | Boolean / Object | false | Typescript：`boolean \| { maxHeight?: number, minHeight?: number }` | N bordered | Boolean | false | \- | N @@ -30,7 +29,7 @@ maxlength | Number | -1 | \- | N placeholder | String | undefined | \- | N placeholder-class | String | textarea-placeholder | \- | N placeholder-style | String | - | \- | N -readonly | Boolean | undefined | \- | N +readonly | Boolean | undefined | `1.8.6` | N selection-end | Number | -1 | \- | N selection-start | Number | -1 | \- | N show-confirm-bar | Boolean | true | \- | N @@ -60,6 +59,7 @@ t-class-textarea | \- ### CSS Variables The component provides the following CSS variables, which can be used to customize styles. + Name | Default Value | Description -- | -- | -- --td-textarea-background-color | @bg-color-container | - @@ -69,4 +69,4 @@ Name | Default Value | Description --td-textarea-indicator-text-color | @font-gray-3 | - --td-textarea-label-color | @font-gray-1 | - --td-textarea-placeholder-color | @font-gray-3 | - ---td-textarea-text-color | @font-gray-1 | - \ No newline at end of file +--td-textarea-text-color | @font-gray-1 | - diff --git a/src/textarea/README.md b/src/textarea/README.md index 289d5091a..5a8bdab5c 100644 --- a/src/textarea/README.md +++ b/src/textarea/README.md @@ -65,7 +65,6 @@ isComponent: true ## API - ### Textarea Props 名称 | 类型 | 默认值 | 描述 | 必传 @@ -73,7 +72,7 @@ isComponent: true style | Object | - | 样式 | N custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N adjust-position | Boolean | true | 键盘弹起时，是否自动上推页面 | N -allow-input-over-max | Boolean | false | 超出maxlength或maxcharacter之后是否还允许输入 | N +allow-input-over-max | Boolean | false | `1.8.6`。 超出maxlength或maxcharacter之后是否还允许输入 | N autofocus | Boolean | false | 自动聚焦，拉起键盘 | N autosize | Boolean / Object | false | 是否自动增高，值为 true 时，style.height 不生效。支持传入对象，如 { maxHeight: 120, minHeight: 20 }。TS 类型：`boolean \| { maxHeight?: number, minHeight?: number }` | N bordered | Boolean | false | 是否显示外边框 | N @@ -93,7 +92,7 @@ maxlength | Number | -1 | 用户最多可以输入的字符个数，值为 -1 placeholder | String | undefined | 占位符 | N placeholder-class | String | textarea-placeholder | 指定 placeholder 的样式类，目前仅支持color,font-size和font-weight | N placeholder-style | String | - | 指定 placeholder 的样式，目前仅支持 color ,font-size和font-weight | N -readonly | Boolean | undefined | 只读状态 | N +readonly | Boolean | undefined | `1.8.6`。只读状态 | N selection-end | Number | -1 | 光标结束位置，自动聚集时有效，需与 selection-start 搭配使用 | N selection-start | Number | -1 | 光标起始位置，自动聚集时有效，需与 selection-end 搭配使用 | N show-confirm-bar | Boolean | true | 是否显示键盘上方带有”完成“按钮那一栏 | N @@ -123,6 +122,7 @@ t-class-textarea | 多行文本框样式类 ### CSS Variables 组件提供了下列 CSS 变量，可用于自定义样式。 + 名称 | 默认值 | 描述 -- | -- | -- --td-textarea-background-color | @bg-color-container | - @@ -132,4 +132,4 @@ t-class-textarea | 多行文本框样式类 --td-textarea-indicator-text-color | @font-gray-3 | - --td-textarea-label-color | @font-gray-1 | - --td-textarea-placeholder-color | @font-gray-3 | - ---td-textarea-text-color | @font-gray-1 | - \ No newline at end of file +--td-textarea-text-color | @font-gray-1 | -