Skip to content

Commit 15bf909

Browse files
committed
doc(SearchBar): 修改SearchBar api文档
1 parent 7bdd489 commit 15bf909

File tree

1 file changed

+22
-33
lines changed

1 file changed

+22
-33
lines changed

packages/core/src/SearchBar/README.md

Lines changed: 22 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -26,36 +26,25 @@ export default Demo
2626

2727
```
2828

29-
### props
30-
31-
```ts
32-
interface OptionsState {
33-
label: string;
34-
value: string | number;
35-
}
36-
37-
interface SearchBarProps {
38-
/** 搜索框文字变化 */
39-
onChangeText?: (value: string) => void;
40-
/** 数据化配置选项内容,相比 jsx 定义会获得更好的渲染性能 */
41-
options?: Array<OptionsState>;
42-
/** 事件变化回调 */
43-
onChange?: (value: string | null) => void;
44-
/** 获得焦点时回调 */
45-
onFocus?: (e: any | string) => void;
46-
/** 是否把每个选项的 label 包装到 value 中,会把 Select 的 value 类型从 string 变为 { key: string, label: ReactNode } 的格式 */
47-
labelInValue?: Boolean;
48-
/** 是否禁用 */
49-
disabled?: Boolean;
50-
/***/
51-
value?: String;
52-
/** 加载中状态 */
53-
loading?: Boolean;
54-
/** 搜索框默认文本 */
55-
placeholder?: String;
56-
/** 图标 */
57-
extra?: JSX.Element;
58-
/** 是否展示清楚图标 */
59-
showClear?: boolean;
60-
}
61-
```
29+
### Props
30+
31+
| 参数 | 说明 | 类型 | 默认值 |
32+
|------|------|-----|------|
33+
| onChangeText | 搜索框文字变化 | (value: string) => void | - |
34+
| options | 数据化配置选项内容,相比 jsx 定义会获得更好的渲染性能 | Array<`OptionsStateProps`> | - |
35+
| onChange | 事件变化回调 | string | (value: string) => void |
36+
| onFocus | 获得焦点时回调 null = 永不显示 | (e: any) => void | - |
37+
| labelInValue | 是否把每个选项的 label 包装到 value 中,会把 Select 的 value 类型从 string 变为 { key: string, label: ReactNode } 的格式 | Boolean | - |
38+
| disabled | 是否禁用 | Boolean | - |
39+
| value || String | - |
40+
| loading | 加载中状态 | Boolean | - |
41+
| placeholder | 搜索框默认文本 | String | - |
42+
| extra | 图标 | JSX.Element | - |
43+
| showClear | 是否展示清楚图标 | boolean | - |
44+
45+
### OptionsStateProps
46+
47+
| 参数 | 说明 | 类型 | 默认值 |
48+
|------|------|-----|------|
49+
| label || string | - |
50+
| value || `string` \| `number` | - |

0 commit comments

Comments
 (0)