Skip to content

Commit b1ca268

Browse files
betavsbetavs
authored
docs: label the new features of version 1.8.6 (#3508)
1 parent 5a806b5 commit b1ca268

File tree

6 files changed

+80
-78
lines changed

6 files changed

+80
-78
lines changed

‎src/input/README.en-US.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ style | Object | - | CSS(Cascading Style Sheets) | N
1010
custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N
1111
adjust-position | Boolean | true | \- | N
1212
align | String | left | text align type。options: left/center/right | N
13-
allow-input-over-max | Boolean | false | allow to continue input on value length is over `maxlength` or `maxcharacter` | N
13+
allow-input-over-max | Boolean | false | `1.8.6`. allow to continue input on value length is over `maxlength` or `maxcharacter` | N
1414
always-embed | Boolean | false | \- | N
1515
auto-focus | Boolean | false | \- | N
1616
borderless | Boolean | false | input without border | N
@@ -83,28 +83,29 @@ t-class-tips | \-
8383
### CSS Variables
8484

8585
The component provides the following CSS variables, which can be used to customize styles.
86-
Name | Default Value | Description
86+
87+
Name | Default Value | Description
8788
-- | -- | --
88-
--td-input-align-items | center | -
89-
--td-input-bg-color | @bg-color-container | -
90-
--td-input-border-color | @component-stroke | -
91-
--td-input-border-left-space | 32rpx | -
92-
--td-input-border-right-space | 0 | -
93-
--td-input-default-text-color | @text-color-primary | -
94-
--td-input-default-tips-color | @text-color-placeholder | -
95-
--td-input-disabled-text-color | @text-color-disabled | -
96-
--td-input-error-text-color | @error-color | -
97-
--td-input-error-tips-color | @error-color | -
98-
--td-input-label-max-width | 5em | -
99-
--td-input-label-min-width | 2em | -
100-
--td-input-label-text-color | @text-color-primary | -
101-
--td-input-placeholder-text-color | @text-color-placeholder | -
102-
--td-input-placeholder-text-font-size | @font-size-m | -
103-
--td-input-prefix-icon-color | @text-color-primary | -
104-
--td-input-success-text-color | @success-color | -
105-
--td-input-success-tips-color | @success-color | -
106-
--td-input-suffix-icon-color | @text-color-placeholder | -
107-
--td-input-suffix-text-color | @text-color-primary | -
108-
--td-input-vertical-padding | 32rpx | -
109-
--td-input-warning-text-color | @warning-color | -
110-
--td-input-warning-tips-color | @warning-color | -
89+
--td-input-align-items | center | -
90+
--td-input-bg-color | @bg-color-container | -
91+
--td-input-border-color | @component-stroke | -
92+
--td-input-border-left-space | 32rpx | -
93+
--td-input-border-right-space | 0 | -
94+
--td-input-default-text-color | @text-color-primary | -
95+
--td-input-default-tips-color | @text-color-placeholder | -
96+
--td-input-disabled-text-color | @text-color-disabled | -
97+
--td-input-error-text-color | @error-color | -
98+
--td-input-error-tips-color | @error-color | -
99+
--td-input-label-max-width | 5em | -
100+
--td-input-label-min-width | 2em | -
101+
--td-input-label-text-color | @text-color-primary | -
102+
--td-input-placeholder-text-color | @text-color-placeholder | -
103+
--td-input-placeholder-text-font-size | @font-size-m | -
104+
--td-input-prefix-icon-color | @text-color-primary | -
105+
--td-input-success-text-color | @success-color | -
106+
--td-input-success-tips-color | @success-color | -
107+
--td-input-suffix-icon-color | @text-color-placeholder | -
108+
--td-input-suffix-text-color | @text-color-primary | -
109+
--td-input-vertical-padding | 32rpx | -
110+
--td-input-warning-text-color | @warning-color | -
111+
--td-input-warning-tips-color | @warning-color | -

‎src/input/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ style | Object | - | 样式 | N
8989
custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
9090
adjust-position | Boolean | true | 键盘弹起时，是否自动上推页面 | N
9191
align | String | left | 文本内容位置，居左/居中/居右。可选项：left/center/right | N
92-
allow-input-over-max | Boolean | false | 超出 `maxlength` 或 `maxcharacter` 之后是否允许继续输入 | N
92+
allow-input-over-max | Boolean | false | `1.8.6`。超出 `maxlength` 或 `maxcharacter` 之后是否允许继续输入 | N
9393
always-embed | Boolean | false | 强制 input 处于同层状态，默认 focus 时 input 会切到非同层状态 (仅在 iOS 下生效) | N
9494
auto-focus | Boolean | false | (即将废弃，请直接使用 focus )自动聚焦，拉起键盘 | N
9595
borderless | Boolean | false | 是否开启无边框模式 | N

‎src/radio/README.en-US.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ max-content-row | Number | 5 | \- | N
2121
max-label-row | Number | 3 | \- | N
2222
name | String | - | \- | N
2323
placement | String | - | options: left/right | N
24-
readonly | Boolean | undefined | \- | N
24+
readonly | Boolean | undefined | `1.8.6` | N
2525
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
2626

2727
### Radio Events
@@ -40,7 +40,6 @@ t-class-content | \-
4040
t-class-icon | \-
4141
t-class-label | \-
4242

43-
4443
### RadioGroup Props
4544

4645
name | type | default | description | required
@@ -55,7 +54,7 @@ keys | Object | - | Typescript：`KeysType`。[see more ts definition](https://g
5554
name | String | - | \- | N
5655
options | Array | - | Typescript：`Array<RadioOption>` `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
5756
placement | String | left | options: left/right | N
58-
readonly | Boolean | undefined | \- | N
57+
readonly | Boolean | undefined | `1.8.6` | N
5958
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
6059
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
6160

@@ -68,23 +67,24 @@ change | `(value: RadioValue)` | \-
6867
### CSS Variables
6968

7069
The component provides the following CSS variables, which can be used to customize styles.
71-
Name | Default Value | Description
70+
71+
Name | Default Value | Description
7272
-- | -- | --
73-
--td-radio-bg-color | @bg-color-container | -
74-
--td-radio-border-color | @component-stroke | -
75-
--td-radio-content-checked-color | @font-gray-2 | -
76-
--td-radio-content-color | @font-gray-2 | -
77-
--td-radio-content-disabled-color | @font-gray-4 | -
78-
--td-radio-content-font-size | 28rpx | -
79-
--td-radio-content-line-height | 44rpx | -
80-
--td-radio-font-size | 32rpx | -
81-
--td-radio-icon-checked-color | @brand-color | -
82-
--td-radio-icon-color | @component-border | -
83-
--td-radio-icon-disabled-bg-color | @bg-color-component-disabled | -
84-
--td-radio-icon-disabled-color | @brand-color-disabled | -
85-
--td-radio-icon-size | 48rpx | -
86-
--td-radio-label-checked-color | @font-gray-1 | -
87-
--td-radio-label-color | @font-gray-1 | -
88-
--td-radio-label-disabled-color | @font-gray-4 | -
89-
--td-radio-label-line-height | 48rpx | -
90-
--td-radio-vertical-padding | 32rpx | -
73+
--td-radio-bg-color | @bg-color-container | -
74+
--td-radio-border-color | @component-stroke | -
75+
--td-radio-content-checked-color | @font-gray-2 | -
76+
--td-radio-content-color | @font-gray-2 | -
77+
--td-radio-content-disabled-color | @font-gray-4 | -
78+
--td-radio-content-font-size | 28rpx | -
79+
--td-radio-content-line-height | 44rpx | -
80+
--td-radio-font-size | 32rpx | -
81+
--td-radio-icon-checked-color | @brand-color | -
82+
--td-radio-icon-color | @component-border | -
83+
--td-radio-icon-disabled-bg-color | @bg-color-component-disabled | -
84+
--td-radio-icon-disabled-color | @brand-color-disabled | -
85+
--td-radio-icon-size | 48rpx | -
86+
--td-radio-label-checked-color | @font-gray-1 | -
87+
--td-radio-label-color | @font-gray-1 | -
88+
--td-radio-label-disabled-color | @font-gray-4 | -
89+
--td-radio-label-line-height | 48rpx | -
90+
--td-radio-vertical-padding | 32rpx | -

‎src/radio/README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ isComponent: true
66
---
77

88
<span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20lines-98%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20functions-100%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20statements-99%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20branches-88%25-blue" /></span>
9+
910
## 引入
1011

1112
全局引入，在 miniprogram 根目录下的`app.json`中配置，局部引入，在需要引入的页面或组件的`index.json`中配置。
@@ -74,7 +75,7 @@ max-content-row | Number | 5 | 内容最大行数限制 | N
7475
max-label-row | Number | 3 | 主文案最大行数限制 | N
7576
name | String | - | HTML 元素原生属性 | N
7677
placement | String | - | 复选框和内容相对位置。优先级高于 RadioGroup.placement。Radio 单独存在时，默认值为 left。如果父组件存在 RadioGroup，默认值便由 RadioGroup.placement 决定。可选项：left/right | N
77-
readonly | Boolean | undefined | 只读状态 | N
78+
readonly | Boolean | undefined | `1.8.6`。只读状态 | N
7879
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
7980

8081
### Radio Events
@@ -93,7 +94,6 @@ t-class-content | 内容样式类
9394
t-class-icon | 图标样式类
9495
t-class-label | 标签样式类
9596

96-
9797
### RadioGroup Props
9898

9999
名称 | 类型 | 默认值 | 描述 | 必传
@@ -108,7 +108,7 @@ keys | Object | - | 用来定义 value / label 在 `options` 中对应的字段
108108
name | String | - | HTML 元素原生属性 | N
109109
options | Array | - | 单选组件按钮形式。RadioOption 数据类型为 string 或 number 时，表示 label 和 value 值相同。TS 类型：`Array<RadioOption>` `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
110110
placement | String | left | 复选框和内容相对位置。优先级低于 Radio.placement。可选项：left/right | N
111-
readonly | Boolean | undefined | 只读状态 | N
111+
readonly | Boolean | undefined | `1.8.6`。只读状态 | N
112112
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
113113
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
114114

@@ -121,23 +121,24 @@ change | `(value: RadioValue)` | 选中值发生变化时触发
121121
### CSS Variables
122122

123123
组件提供了下列 CSS 变量，可用于自定义样式。
124-
名称 | 默认值 | 描述
124+
125+
名称 | 默认值 | 描述
125126
-- | -- | --
126-
--td-radio-bg-color | @bg-color-container | -
127-
--td-radio-border-color | @component-stroke | -
128-
--td-radio-content-checked-color | @font-gray-2 | -
129-
--td-radio-content-color | @font-gray-2 | -
130-
--td-radio-content-disabled-color | @font-gray-4 | -
131-
--td-radio-content-font-size | 28rpx | -
132-
--td-radio-content-line-height | 44rpx | -
133-
--td-radio-font-size | 32rpx | -
134-
--td-radio-icon-checked-color | @brand-color | -
135-
--td-radio-icon-color | @component-border | -
136-
--td-radio-icon-disabled-bg-color | @bg-color-component-disabled | -
137-
--td-radio-icon-disabled-color | @brand-color-disabled | -
138-
--td-radio-icon-size | 48rpx | -
139-
--td-radio-label-checked-color | @font-gray-1 | -
140-
--td-radio-label-color | @font-gray-1 | -
141-
--td-radio-label-disabled-color | @font-gray-4 | -
142-
--td-radio-label-line-height | 48rpx | -
143-
--td-radio-vertical-padding | 32rpx | -
127+
--td-radio-bg-color | @bg-color-container | -
128+
--td-radio-border-color | @component-stroke | -
129+
--td-radio-content-checked-color | @font-gray-2 | -
130+
--td-radio-content-color | @font-gray-2 | -
131+
--td-radio-content-disabled-color | @font-gray-4 | -
132+
--td-radio-content-font-size | 28rpx | -
133+
--td-radio-content-line-height | 44rpx | -
134+
--td-radio-font-size | 32rpx | -
135+
--td-radio-icon-checked-color | @brand-color | -
136+
--td-radio-icon-color | @component-border | -
137+
--td-radio-icon-disabled-bg-color | @bg-color-component-disabled | -
138+
--td-radio-icon-disabled-color | @brand-color-disabled | -
139+
--td-radio-icon-size | 48rpx | -
140+
--td-radio-label-checked-color | @font-gray-1 | -
141+
--td-radio-label-color | @font-gray-1 | -
142+
--td-radio-label-disabled-color | @font-gray-4 | -
143+
--td-radio-label-line-height | 48rpx | -
144+
--td-radio-vertical-padding | 32rpx | -

‎src/textarea/README.en-US.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@
22

33
## API
44

5-
65
### Textarea Props
76

87
name | type | default | description | required
98
-- | -- | -- | -- | --
109
style | Object | - | CSS(Cascading Style Sheets) | N
1110
custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N
1211
adjust-position | Boolean | true | \- | N
13-
allow-input-over-max | Boolean | false | \- | N
12+
allow-input-over-max | Boolean | false | `1.8.6` | N
1413
autofocus | Boolean | false | \- | N
1514
autosize | Boolean / Object | false | Typescript：`boolean \| { maxHeight?: number, minHeight?: number }` | N
1615
bordered | Boolean | false | \- | N
@@ -30,7 +29,7 @@ maxlength | Number | -1 | \- | N
3029
placeholder | String | undefined | \- | N
3130
placeholder-class | String | textarea-placeholder | \- | N
3231
placeholder-style | String | - | \- | N
33-
readonly | Boolean | undefined | \- | N
32+
readonly | Boolean | undefined | `1.8.6` | N
3433
selection-end | Number | -1 | \- | N
3534
selection-start | Number | -1 | \- | N
3635
show-confirm-bar | Boolean | true | \- | N
@@ -60,6 +59,7 @@ t-class-textarea | \-
6059
### CSS Variables
6160

6261
The component provides the following CSS variables, which can be used to customize styles.
62+
6363
Name | Default Value | Description
6464
-- | -- | --
6565
--td-textarea-background-color | @bg-color-container | -
@@ -69,4 +69,4 @@ Name | Default Value | Description
6969
--td-textarea-indicator-text-color | @font-gray-3 | -
7070
--td-textarea-label-color | @font-gray-1 | -
7171
--td-textarea-placeholder-color | @font-gray-3 | -
72-
--td-textarea-text-color | @font-gray-1 | -
72+
--td-textarea-text-color | @font-gray-1 | -

‎src/textarea/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,14 @@ isComponent: true
6565

6666
## API
6767

68-
6968
### Textarea Props
7069

7170
名称 | 类型 | 默认值 | 描述 | 必传
7271
-- | -- | -- | -- | --
7372
style | Object | - | 样式 | N
7473
custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
7574
adjust-position | Boolean | true | 键盘弹起时，是否自动上推页面 | N
76-
allow-input-over-max | Boolean | false | 超出maxlength或maxcharacter之后是否还允许输入 | N
75+
allow-input-over-max | Boolean | false | `1.8.6`。 超出maxlength或maxcharacter之后是否还允许输入 | N
7776
autofocus | Boolean | false | 自动聚焦，拉起键盘 | N
7877
autosize | Boolean / Object | false | 是否自动增高，值为 true 时，style.height 不生效。支持传入对象，如 { maxHeight: 120, minHeight: 20 }。TS 类型：`boolean \| { maxHeight?: number, minHeight?: number }` | N
7978
bordered | Boolean | false | 是否显示外边框 | N
@@ -93,7 +92,7 @@ maxlength | Number | -1 | 用户最多可以输入的字符个数，值为 -1
9392
placeholder | String | undefined | 占位符 | N
9493
placeholder-class | String | textarea-placeholder | 指定 placeholder 的样式类，目前仅支持color,font-size和font-weight | N
9594
placeholder-style | String | - | 指定 placeholder 的样式，目前仅支持 color ,font-size和font-weight | N
96-
readonly | Boolean | undefined | 只读状态 | N
95+
readonly | Boolean | undefined | `1.8.6`。只读状态 | N
9796
selection-end | Number | -1 | 光标结束位置，自动聚集时有效，需与 selection-start 搭配使用 | N
9897
selection-start | Number | -1 | 光标起始位置，自动聚集时有效，需与 selection-end 搭配使用 | N
9998
show-confirm-bar | Boolean | true | 是否显示键盘上方带有”完成“按钮那一栏 | N
@@ -123,6 +122,7 @@ t-class-textarea | 多行文本框样式类
123122
### CSS Variables
124123

125124
组件提供了下列 CSS 变量，可用于自定义样式。
125+
126126
名称 | 默认值 | 描述
127127
-- | -- | --
128128
--td-textarea-background-color | @bg-color-container | -
@@ -132,4 +132,4 @@ t-class-textarea | 多行文本框样式类
132132
--td-textarea-indicator-text-color | @font-gray-3 | -
133133
--td-textarea-label-color | @font-gray-1 | -
134134
--td-textarea-placeholder-color | @font-gray-3 | -
135-
--td-textarea-text-color | @font-gray-1 | -
135+
--td-textarea-text-color | @font-gray-1 | -

0 commit comments

Comments
 (0)