docs: update

Author: bplok20010

README.md

@@ -20,49 +20,55 @@
 
 | 参数 | 说明 | 类型 | 默认值 |
 | --- | --- | --- | --- |
+| prefixCls | 组件CSS样式前缀 | string | rw-select |
+| className | 组件className属性 | string | - |
+| style | 组件style属性 | React.CSSProperties | - |
+| tabIndex | 组件tabIndex属性 | number | - |
+| options | 组件数据 | Array\<Option> | false |
+| inline | 内联组件 | boolean | true |
+| emptyLabel | 下拉框无内容时显示 | ReactNode | no data. |
+| valueField | 设置取值字段 | string | value |
+| labelField | 设置显示字段 | string | label |
+| childrenField | 设置子节点字段 | string | children |
+| labelInValue | 是否把每个选项的 label 包装到 value 中，会把 Select 的 value 类型从 `string` 变为 `{key: string, label: ReactNode}` 的格式 | boolean | false |
 | allowClear | 支持清除 | boolean | false |
-| autoClearSearchValue | 是否在选中项后清空搜索框，只在 `mode` 为 `multiple` 或 `tags` 时有效。 | boolean | true |
 | autoFocus | 默认获取焦点 | boolean | false |
-| defaultActiveFirstOption | 是否默认高亮第一个选项。 | boolean | true |
-| defaultValue | 指定默认选中的条目 | string\|string\[]<br />number\|number\[] | - |
+| defaultValue | 指定默认选中的条目 | string|number | - |
+| value | 指定默认选中的条目 `受控` | string|number | - |
 | disabled | 是否禁用 | boolean | false |
+| readOnly | 是否只读 | boolean | false |
+| placeholder | 选择框默认文字 | string | - |
+| showArrow | 是否显示下拉小箭头 | boolean | true |
+| showSearch | 显示下拉框的搜索输入框 | boolean | false |
+| optionFilterField | 搜索时过滤对应的 option 属性 | string | label |
+| filterOption | 是否根据输入项进行筛选。当其为一个函数时，会接收 `searchText` `option` 两个参数，当 `option` 符合筛选条件时，应返回 `true`，反之则返回 `false`。 | boolean or function(inputValue, option) | true |
 | dropdownClassName | 下拉菜单的 className 属性 | string | - |
 | dropdownMatchSelectWidth | 下拉菜单和选择器同宽 | boolean | true |
-| dropdownRender | 自定义下拉框内容 | (menuNode: ReactNode, props) => ReactNode | - |
 | dropdownStyle | 下拉菜单的 style 属性 | object | - |
-| filterOption | 是否根据输入项进行筛选。当其为一个函数时，会接收 `inputValue` `option` 两个参数，当 `option` 符合筛选条件时，应返回 `true`，反之则返回 `false`。 | boolean or function(inputValue, option) | true |
-| firstActiveValue | 默认高亮的选项 | string\|string\[] | - |
-| getPopupContainer | 菜单渲染父节点。默认渲染到 body 上，如果你遇到菜单滚动定位问题，试试修改为滚动的区域，并相对其定位。[示例](https://codesandbox.io/s/4j168r7jw0) | Function(triggerNode) | () => document.body |
-| labelInValue | 是否把每个选项的 label 包装到 value 中，会把 Select 的 value 类型从 `string` 变为 `{key: string, label: ReactNode}` 的格式 | boolean | false |
-| maxTagCount | 最多显示多少个 tag | number | - |
-| maxTagPlaceholder | 隐藏 tag 时显示的内容 | ReactNode/function(omittedValues) | - |
-| mode | 设置 Select 的模式为多选或标签 | 'multiple' \| 'tags' | - |
-| notFoundContent | 当下拉列表为空时显示的内容 | string | 'Not Found' |
-| optionFilterProp | 搜索时过滤对应的 option 属性，如设置为 children 表示对内嵌内容进行搜索 | string | value |
-| optionLabelProp | 回填到选择框的 Option 的属性值，默认是 Option 的子元素。比如在子元素需要高亮效果时，此值可以设为 `value`。 | string | `children` （combobox 模式下为 `value`） |
-| placeholder | 选择框默认文字 | string | - |
-| showArrow | 是否显示下拉小箭头 | boolean | true |
-| showSearch | 使单选模式可搜索 | boolean | false |
-| size | 选择框大小，可选 `large` `small` | string | default |
-| suffixIcon | 自定义的选择框后缀图标 | ReactNode | - |
-| removeIcon | 自定义的多选框清除图标 | ReactNode | - |
-| clearIcon | 自定义的多选框清空图标 | ReactNode | - |
-| menuItemSelectedIcon | 自定义当前选中的条目图标 | ReactNode | - |
-| tokenSeparators | 在 tags 和 multiple 模式下自动分词的分隔符 | string\[] |  |
-| value | 指定当前选中的条目 | string\|string\[]\|number\|number\[] | - |
+| dropdownProps | 下拉菜单扩展属性，参考`ListBox` | object | - |
+| placement | 	dropdown出现位置<`PlacementType`> | string | bottomLeft |
+| offset | 	dropdown位置偏移量 | Array<number> | [0, 0] |
+| popupClassName | 	dropdown弹出层的className属性 | string | - |
+| popupRootComponent | 	dropdown弹出层自定义组件类型 | ReactNode | div |
+| getPopupContainer | popup渲染父节点。默认渲染到 body 上，如果你遇到菜单滚动定位问题，试试修改为滚动的区域。 | Function(triggerNode) | () => document.body |
+| destroyPopupOnHide | 	dropdown隐藏时删除DOM节点 | boolean | true |
+| defaultOpen | 是否默认展开下拉菜单 | boolean | - |
+| open | 是否展开下拉菜单`受控` | boolean | - |
+| onResizeToHideDropDown | 浏览器大小改变时隐藏下拉框 | boolean | true |
+| onScrollToHideDropDown | 浏览器触发滚动时隐藏下拉框 | boolean | false |
+| renderValue | 自定义渲染被选中的选项 | (menu: ReactNode, option: Option) => ReactNode | - |
+| renderMenu | 自定义下拉框内容 | (menu: ReactNode, props) => ReactNode | - |
+| renderMenuItem | 自定义下拉选项内容 | (label:React.Node, option:Option) => ReactNode | - |
+| renderMenuGroupTitle | 自定义下拉分组标题内容 | (label:React.Node, option:Option) => ReactNode | - |
 | onBlur | 失去焦点的时回调 | function | - |
-| onChange | 选中 option，或 input 的 value 变化（combobox 模式下）时，调用此函数 | function(value, option:Option/Array&lt;Option>) | - |
-| onDeselect | 取消选中时调用，参数为选中项的 value (或 key) 值，仅在 multiple 或 tags 模式下生效 | function(value，option:Option) | - |
 | onFocus | 获得焦点时回调 | function | - |
+| onChange | 选中 option 时调用此函数 | function(value, option:Option) | - |
+| onSearch | 搜索输入框值变化时回调 | function(value: string) |  |
+| onSelect | 被选中时调用，参数为选中项的 value (或 key) 值 | function(value, option:Option) | - |
+| onDropDownVisibleChange | 展开/隐藏下拉菜单的回调 | function(open) | - |
 | onMouseEnter | 鼠标移入时回调 | function | - |
 | onMouseLeave | 鼠标移出时回调 | function | - |
-| onPopupScroll | 下拉列表滚动时的回调 | function | - |
-| onSearch | 文本框值变化时回调 | function(value: string) |  |
-| onSelect | 被选中时调用，参数为选中项的 value (或 key) 值 | function(value, option:Option) | - |
-| defaultOpen | 是否默认展开下拉菜单 | boolean | - |
-| open | 是否展开下拉菜单 | boolean | - |
-| onDropdownVisibleChange | 展开下拉菜单的回调 (3.9.0 后支持) | function(open) | - |
-| loading | 加载中状态 | Boolean | false |
+
 
 > 注意，如果发现下拉菜单跟随页面滚动，或者需要在其他弹层中触发 Select，请尝试使用 `getPopupContainer={triggerNode => triggerNode.parentNode}` 将下拉弹层渲染节点固定在触发器的父元素中。
 
@@ -78,14 +84,32 @@
 | 参数 | 说明 | 类型 | 默认值 |
 | --- | --- | --- | --- |
 | disabled | 是否禁用 | boolean | false |
-| key | 和 value 含义一致。如果 React 需要你设置此项，此项值与 value 的值相同，然后可以省略 value 设置 | string |  |
-| title | 选中该 Option 后，Select 的 title | string | - |
+| label | 选中该 Option 后，Select 的 title | ReactNode | - |
 | value | 默认根据此属性值进行筛选 | string\|number | - |
-| className | Option 器类名 | string | - |
 
 ### OptGroup props
 
 | 参数 | 说明 | 类型 | 默认值 |
 | --- | --- | --- | --- |
-| key |  | string | - |
+| children | 子节点 | Array\<Option> | - |
 | label | 组名 | string\|React.Element | 无 |
+
+### PlacementType
+
+```
+type PlacementType = 
+  | bottomLeft
+  | bottomCenter
+  | bottomRight
+  | topLeft
+  | topCenter
+  | topRight
+  | leftTop
+  | leftCenter
+  | leftBottom
+  | rightTop
+  | rightCenter
+  | rightBottom
+  | centerCenter
+
+```

docs/index.html

@@ -20,6 +20,6 @@
 <body style="background:#F5F5F5">
     <div class="demo" id="demo">
     </div>
-<script src="static\js\vendors.329b2ba2.chunk.js"></script><script src="static\js\index.a8940594.js"></script></body>
+<script src="static\js\vendors.329b2ba2.chunk.js"></script><script src="static\js\index.5ac55047.js"></script></body>
 
 </html>