Skip to content

Commit 0e8286d

Browse files
afc163afc163
committed
docs: fix Chinese README API names
1 parent c435b22 commit 0e8286d

1 file changed

Lines changed: 39 additions & 41 deletions

File tree

‎README.zh-CN.md‎

Lines changed: 39 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66

77
<p align="center"><a href="./README.md">English</a> | 简体中文</p>
88

9-
109
<div align="center">
1110

1211
[![NPM version][npm-image]][npm-url]
@@ -18,7 +17,6 @@
1817

1918
</div>
2019

21-
2220
## 特性
2321

2422
- 提供可组合的 `Input`、`TextArea` 和 `BaseInput` 基础组件。
@@ -62,50 +60,50 @@ npm start
6260

6361
### Input
6462

65-
| 参数 | 类型 | 默认值 | 说明 |
66-
| ------------ | ---------------------------------------------------------- | ---------- | --------------------------------------------------------------- |
67-
| addonAfter | `ReactNode` | - | 输入后显示的元素。 |
63+
| 参数 | 类型 | 默认值 | 说明 |
64+
| ------------ | ---------------------------------------------------------- | ---------- | ------------------------------------------------ |
65+
| addonAfter | `ReactNode` | - | 输入后显示的元素。 |
6866
| addonBefore | `ReactNode` | - | 输入之前显示的元素。 |
69-
| allowClear | `boolean \| { disabled?: boolean; clearIcon?: ReactNode }` | `false` | 显示当前值的清除按钮。 |
70-
| className | `string` | - | 输入元素的className称。 |
71-
| classNames | `InputProps['classNames']` | - | 输入槽的语义className称。 |
72-
| count | `CountConfig` | - | 自定义计数策略、限制、可见性和超出格式化程序。 |
73-
| defaultValue | `string \| number \| readonly string[] \| bigint` | - | 初始输入值。 |
74-
| disabled | `boolean` | `false` | 禁用输入。 |
75-
| htmlSize | `number` | - | 本机输入 `size` 属性。 |
76-
| maxLength | `number` | - | 本机输入 `maxLength` 属性。 |
77-
| 前缀 | `ReactNode` | - | 输入包装器内的前缀内容。 |
78-
| prefixCls | `string` | `rc-input` | className前缀。 |
79-
| showCount | `boolean \| { formatter: ShowCountFormatter }` | `false` | 显示字符数。新代码首选 `count.show`。 |
80-
| styles | `InputProps['styles']` | - | 输入槽的语义样式。 |
81-
| 后缀 | `ReactNode` | - | 输入包装器内的后缀内容。 |
82-
| type | `InputProps['type']` | `text` | 本机输入类型。使用 `TextArea` 进行文本区域行为。 |
83-
| 价值 | `string \| number \| readonly string[] \| bigint` | - | 受控输入值。 |
84-
| onChange | `React.ChangeEventHandler<HTMLInputElement>` | - | 当值改变时触发。 |
85-
| onClear | `() => void` | - | 单击清除按钮时触发。 |
86-
| onPressEnter | `React.KeyboardEventHandler<HTMLInputElement>` | - | 当按下 Enter 时触发。 |
67+
| allowClear | `boolean \| { disabled?: boolean; clearIcon?: ReactNode }` | `false` | 显示当前值的清除按钮。 |
68+
| className | `string` | - | 输入元素的className称。 |
69+
| classNames | `InputProps['classNames']` | - | 输入槽的语义className称。 |
70+
| count | `CountConfig` | - | 自定义计数策略、限制、可见性和超出格式化程序。 |
71+
| defaultValue | `string \| number \| readonly string[] \| bigint` | - | 初始输入值。 |
72+
| disabled | `boolean` | `false` | 禁用输入。 |
73+
| htmlSize | `number` | - | 本机输入 `size` 属性。 |
74+
| maxLength | `number` | - | 本机输入 `maxLength` 属性。 |
75+
| prefix | `ReactNode` | - | 输入包装器内的前缀内容。 |
76+
| prefixCls | `string` | `rc-input` | className前缀。 |
77+
| showCount | `boolean \| { formatter: ShowCountFormatter }` | `false` | 显示字符数。新代码首选 `count.show`。 |
78+
| styles | `InputProps['styles']` | - | 输入槽的语义样式。 |
79+
| suffix | `ReactNode` | - | 输入包装器内的后缀内容。 |
80+
| type | `InputProps['type']` | `text` | 本机输入类型。使用 `TextArea` 进行文本区域行为。 |
81+
| value | `string \| number \| readonly string[] \| bigint` | - | 受控输入值。 |
82+
| onChange | `React.ChangeEventHandler<HTMLInputElement>` | - | 当值改变时触发。 |
83+
| onClear | `() => void` | - | 单击清除按钮时触发。 |
84+
| onPressEnter | `React.KeyboardEventHandler<HTMLInputElement>` | - | 当按下 Enter 时触发。 |
8785

8886
### TextArea
8987

90-
| 参数 | 类型 | 默认值 | 说明 |
91-
| ------------ | ---------------------------------------------------------- | ------------- | --------------------------------------------------------------- |
92-
| allowClear | `boolean \| { disabled?: boolean; clearIcon?: ReactNode }` | `false` | 显示当前值的清除按钮。 |
93-
| autoSize | `boolean \| { minRows?: number; maxRows?: number }` | `false` | 根据内容自动调整高度。 |
94-
| className | `string` | - | 文本区域的className称。 |
95-
| classNames | `TextAreaProps['classNames']` | - | 文本区域槽的语义className称。 |
88+
| 参数 | 类型 | 默认值 | 说明 |
89+
| ------------ | ---------------------------------------------------------- | ------------- | ---------------------------------------------- |
90+
| allowClear | `boolean \| { disabled?: boolean; clearIcon?: ReactNode }` | `false` | 显示当前值的清除按钮。 |
91+
| autoSize | `boolean \| { minRows?: number; maxRows?: number }` | `false` | 根据内容自动调整高度。 |
92+
| className | `string` | - | 文本区域的className称。 |
93+
| classNames | `TextAreaProps['classNames']` | - | 文本区域槽的语义className称。 |
9694
| count | `CountConfig` | - | 自定义计数策略、限制、可见性和超出格式化程序。 |
97-
| defaultValue | `string \| number \| readonly string[] \| bigint` | - | 初始文本区域值。 |
98-
| maxLength | `number` | - | 本机文本区域 `maxLength` 属性。 |
99-
| prefixCls | `string` | `rc-textarea` | className前缀。 |
100-
| showCount | `boolean \| { formatter: ShowCountFormatter }` | `false` | 显示字符数。新代码首选 `count.show`。 |
101-
| 风格 | `React.CSSProperties` | - | 文本区域的内联样式。 |
102-
| styles | `TextAreaProps['styles']` | - | 文本区域槽的语义样式。 |
103-
| 后缀 | `ReactNode` | - | textarea 包装器内的后缀内容。 |
104-
| 价值 | `string \| number \| readonly string[] \| bigint` | - | 受控文本区域值。 |
95+
| defaultValue | `string \| number \| readonly string[] \| bigint` | - | 初始文本区域值。 |
96+
| maxLength | `number` | - | 本机文本区域 `maxLength` 属性。 |
97+
| prefixCls | `string` | `rc-textarea` | className前缀。 |
98+
| showCount | `boolean \| { formatter: ShowCountFormatter }` | `false` | 显示字符数。新代码首选 `count.show`。 |
99+
| style | `React.CSSProperties` | - | 文本区域的内联样式。 |
100+
| styles | `TextAreaProps['styles']` | - | 文本区域槽的语义样式。 |
101+
| suffix | `ReactNode` | - | textarea 包装器内的后缀内容。 |
102+
| value | `string \| number \| readonly string[] \| bigint` | - | 受控文本区域值。 |
105103
| onChange | `React.ChangeEventHandler<HTMLTextAreaElement>` | - | 当值改变时触发。 |
106-
| onClear | `() => void` | - | 单击清除按钮时触发。 |
107-
| onPressEnter | `React.KeyboardEventHandler<HTMLTextAreaElement>` | - | 当按下 Enter 时触发。 |
108-
| onResize | `(size: { width: number; height: number }) => void` | - | 当文本区域大小改变时触发。 |
104+
| onClear | `() => void` | - | 单击清除按钮时触发。 |
105+
| onPressEnter | `React.KeyboardEventHandler<HTMLTextAreaElement>` | - | 当按下 Enter 时触发。 |
106+
| onResize | `(size: { width: number; height: number }) => void` | - | 当文本区域大小改变时触发。 |
109107

110108
### Refs
111109

@@ -124,7 +122,7 @@ inputRef.current?.focus();
124122
textareaRef.current?.blur();
125123
```
126124

127-
| Ref | 方法 |
125+
| Ref | 方法 |
128126
| ------------- | --------------------------------------------------------------------------------------- |
129127
| `InputRef` | `focus(options)`, `blur()`, `select()`, `setSelectionRange()`, `input`, `nativeElement` |
130128
| `TextAreaRef` | `focus()`, `blur()`, `resizableTextArea`, `nativeElement` |

0 commit comments

Comments
 (0)