Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
anlyyao committed Jan 3, 2025
1 parent 1dc7911 commit 2489e10
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 20 deletions.
2 changes: 1 addition & 1 deletion src/color-picker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ style | Object | - | 样式 | N
custom-style | Object | - | 样式,一般用于开启虚拟化组件节点场景 | N
auto-close | Boolean | true | 自动关闭。在点击遮罩层时自动关闭,不需要手动设置 visible | N
enable-alpha | Boolean | false | 是否开启透明通道 | N
fixed | Boolean | false | `1.8.5`。如果 color-picker 是在一个 `position:fixed` 的区域,需要显示指定属性 fixed 为 true | N
fixed | Boolean | false | `1.8.5`。如果 color-picker 是在一个 `position:fixed` 的区域,需要显式指定属性 fixed 为 true | N
footer | Slot | - | 底部插槽,仅在 `usePopup``true` 时有效。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N
format | String | RGB | 格式化色值。`enableAlpha` 为真时,`RGBA/HSLA/HSVA` 等值有效。可选项:RGB/RGBA/HSL/HSLA/HSB/HSV/HSVA/HEX/CMYK/CSS | N
header | Slot | - | 顶部插槽,仅在 `usePopup``true` 时有效。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N
Expand Down
2 changes: 1 addition & 1 deletion src/color-picker/props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const props: TdColorPickerProps = {
type: Boolean,
value: false,
},
/** 如果 color-picker 是在一个 `position:fixed` 的区域,需要显示指定属性 fixed 为 true */
/** 如果 color-picker 是在一个 `position:fixed` 的区域,需要显式指定属性 fixed 为 true */
fixed: {
type: Boolean,
value: false,
Expand Down
2 changes: 1 addition & 1 deletion src/color-picker/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export interface TdColorPickerProps {
value?: boolean;
};
/**
* 如果 color-picker 是在一个 `position:fixed` 的区域,需要显示指定属性 fixed 为 true
* 如果 color-picker 是在一个 `position:fixed` 的区域,需要显式指定属性 fixed 为 true
* @default false
*/
fixed?: {
Expand Down
1 change: 1 addition & 0 deletions src/textarea/README.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ enter | `(value: TextareaValue)` | \-
focus | `(value: TextareaValue)` | \-
keyboardheightchange | `(height: number, duration: number)` | \-
line-change | `(value: TextareaValue)` | \-

### Textarea External Classes

className | Description
Expand Down
3 changes: 2 additions & 1 deletion src/textarea/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ cursor | Number | -1 | 指定 focus 时的光标位置 | N
cursor-spacing | Number | 0 | 指定光标与键盘的距离。取textarea距离底部的距离和cursor-spacing指定的距离的最小值作为光标与键盘的距离 | N
disable-default-padding | Boolean | false | 是否去掉 iOS 下的默认内边距 | N
disabled | Boolean | undefined | 是否禁用文本框 | N
fixed | Boolean | false | 如果 textarea 是在一个 `position:fixed` 的区域,需要显示指定属性 fixed 为 true | N
fixed | Boolean | false | 如果 textarea 是在一个 `position:fixed` 的区域,需要显式指定属性 fixed 为 true | N
focus | Boolean | false | 自动聚焦 | N
hold-keyboard | Boolean | false | focus时,点击页面的时候不收起键盘 | N
indicator | Boolean | false | 显示文本计数器,如 0/140。当 `maxlength < 0 && maxcharacter < 0` 成立时, indicator无效 | N
Expand All @@ -106,6 +106,7 @@ enter | `(value: TextareaValue)` | 点击完成时触发
focus | `(value: TextareaValue)` | 获得焦点时触发
keyboardheightchange | `(height: number, duration: number)` | 键盘高度发生变化的时候触发此事件
line-change | `(value: TextareaValue)` | 行高发生变化时触发

### Textarea External Classes

类名 | 描述
Expand Down
2 changes: 1 addition & 1 deletion src/textarea/__test__/__snapshots__/index.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ exports[`textarea slots : label 1`] = `
cursorSpacing="{{0}}"
disabled="{{null}}"
disableDefaultPadding="{{false}}"
fixed="{{null}}"
fixed="{{false}}"
focus="{{false}}"
holdKeyboard="{{false}}"
maxlength="{{-1}}"
Expand Down
7 changes: 1 addition & 6 deletions src/textarea/props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,8 @@ const props: TdTextareaProps = {
type: null,
value: undefined,
},
/** 如果 textarea 是在一个 `position:fixed` 的区域,需要显示指定属性 fixed 为 true */
/** 如果 textarea 是在一个 `position:fixed` 的区域,需要显式指定属性 fixed 为 true */
fixed: {
type: Boolean,
value: null,
},
/** 如果 textarea 是在一个 `position:fixed` 的区域,需要显示指定属性 fixed 为 true,非受控属性 */
defaultFixed: {
type: Boolean,
value: false,
},
Expand Down
10 changes: 1 addition & 9 deletions src/textarea/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,21 +85,13 @@ export interface TdTextareaProps {
value?: boolean;
};
/**
* 如果 textarea 是在一个 `position:fixed` 的区域,需要显示指定属性 fixed 为 true
* 如果 textarea 是在一个 `position:fixed` 的区域,需要显式指定属性 fixed 为 true
* @default false
*/
fixed?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 如果 textarea 是在一个 `position:fixed` 的区域,需要显示指定属性 fixed 为 true,非受控属性
* @default false
*/
defaultFixed?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 自动聚焦
* @default false
Expand Down

0 comments on commit 2489e10

Please sign in to comment.