Skip to content

Commit e9bc49d

Browse files
committed
Modified README.md
Modified src/ListBox.js
1 parent 95046fa commit e9bc49d

File tree

2 files changed

+23
-37
lines changed

2 files changed

+23
-37
lines changed

README.md

Lines changed: 22 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -18,73 +18,59 @@
1818
| className | 组件className属性 | string | - |
1919
| style | 组件style属性 | React.CSSProperties | - |
2020
| tabIndex | 组件tabIndex属性 | number | - |
21-
| options | 组件数据 | Array\<Option> | false |
22-
| inline | 内联组件 | boolean | true |
23-
| emptyLabel | 下拉框无内容时显示 | ReactNode | no data. |
24-
| searchComponent | 自定义搜索输入框组件 | ReactNode | input |
21+
| items | 组件数据 | Array\<ItemData | ItemGroupData> | false |
22+
| headerStyle | - | - | - |
23+
| footerStyle | - | - | - |
24+
| bodyStyle | - | - | - |
2525
| valueField | 设置取值字段 | string | value |
2626
| labelField | 设置显示字段 | string | label |
2727
| childrenField | 设置子节点字段 | string | children |
28+
| headerStyle | - | - | - |
29+
| headerStyle | - | - | - |
30+
| headerStyle | - | - | - |
31+
| emptyLabel | 下拉框无内容时显示 | ReactNode | no data. |
32+
| multiple | - | - | - |
33+
2834
| labelInValue | 是否把每个选项的 label 包装到 value 中,会把 Select 的 value 类型从 `string` 变为 `{key: string, label: ReactNode}` 的格式 | boolean | false |
29-
| allowClear | 支持清除 | boolean | false |
3035
| autoFocus | 默认获取焦点 | boolean | false |
3136
| defaultValue | 指定默认选中的条目 | string|number | - |
3237
| value | 指定默认选中的条目 `受控` | string|number | - |
3338
| disabled | 是否禁用 | boolean | false |
34-
| readOnly | 是否只读 | boolean | false |
35-
| placeholder | 选择框默认文字 | string | - |
36-
| showArrow | 是否显示下拉小箭头 | boolean | true |
37-
| showSearch | 显示下拉框的搜索输入框 | boolean | false |
38-
| optionFilterField | 搜索时过滤对应的 option 属性 | string | label |
39-
| filterOption | 是否根据输入项进行筛选。当其为一个函数时,会接收 `searchText` `option` 两个参数,当 `option` 符合筛选条件时,应返回 `true`,反之则返回 `false`| boolean or function(inputValue, option) | true |
40-
| dropdownClassName | 下拉菜单的 className 属性 | string | - |
41-
| dropdownMatchSelectWidth | 下拉菜单和选择器同宽 | boolean | true |
42-
| dropdownStyle | 下拉菜单的 style 属性 | object | - |
43-
| dropdownProps | 下拉菜单扩展属性,参考`ListBox` | object | - |
44-
| placement | dropdown出现位置<`PlacementType`> | string | bottomLeft |
45-
| offset | dropdown位置偏移量 | Array<number> | [0, 0] |
46-
| popupClassName | dropdown弹出层的className属性 | string | - |
47-
| popupRootComponent | dropdown弹出层自定义组件类型 | ReactNode | div |
48-
| getPopupContainer | popup渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域。 | Function(triggerNode) | () => document.body |
49-
| destroyPopupOnHide | dropdown隐藏时删除DOM节点 | boolean | true |
50-
| defaultOpen | 是否默认展开下拉菜单 | boolean | - |
51-
| open | 是否展开下拉菜单`受控` | boolean | - |
52-
| onResizeToHideDropDown | 浏览器大小改变时隐藏下拉框 | boolean | true |
53-
| onScrollToHideDropDown | 浏览器触发滚动时隐藏下拉框 | boolean | false |
39+
5440
| renderValue | 自定义渲染被选中的选项 | (menu: ReactNode, option: Option) => ReactNode | - |
5541
| renderMenu | 自定义下拉框内容 | (menu: ReactNode, props) => ReactNode | - |
5642
| renderMenuItem | 自定义下拉选项内容 | (label:React.Node, option:Option) => ReactNode | - |
5743
| renderMenuGroupTitle | 自定义下拉分组标题内容 | (label:React.Node, option:Option) => ReactNode | - |
5844
| onBlur | 失去焦点的时回调 | function | - |
5945
| onFocus | 获得焦点时回调 | function | - |
6046
| onChange | 选中 option 时调用此函数 | function(value, option:Option) | - |
61-
| onSearch | 搜索输入框值变化时回调 | function(value: string) | |
62-
| onSelect | 被选中时调用,参数为选中项的 value (或 key) 值 | function(value, option:Option) | - |
63-
| onDropDownVisibleChange | 展开/隐藏下拉菜单的回调 | function(open) | - |
64-
| onMouseEnter | 鼠标移入时回调 | function | - |
65-
| onMouseLeave | 鼠标移出时回调 | function | - |
66-
47+
| onItemClick | 搜- | |
48+
| onItemGroupClick | - | - |
49+
| onKeyDown | - | function(open) | - |
50+
| wrapperComponent | - | function | - |
51+
| headerWrapperComponent | - | function | - |
52+
| bodyWrapperComponent | -- | function | - |
53+
| footerWrapperComponent | - | function | - |
6754

68-
> 注意,如果发现下拉菜单跟随页面滚动,或者需要在其他弹层中触发 Select,请尝试使用 `getPopupContainer={triggerNode => triggerNode.parentNode}` 将下拉弹层渲染节点固定在触发器的父元素中。
6955

70-
### Select Methods
56+
### ListBox Methods
7157

7258
| 名称 | 说明 |
7359
| --- | --- |
7460
| blur() | 取消焦点 |
7561
| focus() | 获取焦点 |
7662

77-
### ListItem props
63+
### ItemData props
7864

7965
| 参数 | 说明 | 类型 | 默认值 |
8066
| --- | --- | --- | --- |
8167
| disabled | 是否禁用 | boolean | false |
8268
| label | 选中该 Option 后,Select 的 title | ReactNode | - |
8369
| value | 默认根据此属性值进行筛选 | string\|number | - |
8470

85-
### ListGroup props
71+
### ItemGroupData props
8672

8773
| 参数 | 说明 | 类型 | 默认值 |
8874
| --- | --- | --- | --- |
89-
| children | 子节点 | Array\<Option> | - |
75+
| children | 子节点 | Array\<ItemData> | - |
9076
| label | 组名 | string\|React.Element ||

src/ListBox.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export default class ListBox extends React.Component {
2828
labelField: PropTypes.string,
2929
childrenField: PropTypes.string,
3030
items: PropTypes.array,
31-
itemsMap: PropTypes.object,
31+
//itemsMap: PropTypes.object,
3232
defaultValue: PropTypes.oneOfType([PropTypes.string, PropTypes.number, PropTypes.array]),
3333
value: PropTypes.oneOfType([PropTypes.string, PropTypes.number, PropTypes.array]),
3434
emptyLabel: PropTypes.any,

0 commit comments

Comments
 (0)