@antsoo-lib/components 0.1.2 → 0.1.4

package/src/select/index.en-US.md

@@ -0,0 +1,128 @@
+---
+category: Components
+type: Data Entry
+title: Select
+cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*zo76T7KQx2UAAAAAAAAAAAAADrJ8AQ/original
+coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*5oPiTqPxGAUAAAAAAAAAAAAADrJ8AQ/original
+---
+
+Select component to select value from options.
+
+## When To Use
+
+- A dropdown menu for displaying choices - an elegant alternative to the native `<select>` element.
+- Utilizing [Radio](/components/radio/) is recommended when there are fewer total options (less than 5).
+
+## API
+
+```html
+<a-select>
+  <a-select-option value="lucy">lucy</a-select-option>
+</a-select>
+```
+
+### Select props
+
+| Property                 | Description                                                                                                                                                                                                                                                                                            | Type                                                   | Default                                                | Version |
+| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------- |
+| allowClear               | Show clear button.                                                                                                                                                                                                                                                                                     | boolean                                                | false                                                  |         |
+| autoClearSearchValue     | Whether the current search will be cleared on selecting an item. Only applies when `mode` is set to `multiple` or `tags`.                                                                                                                                                                              | boolean                                                | true                                                   |         |
+| autofocus                | Get focus by default                                                                                                                                                                                                                                                                                   | boolean                                                | false                                                  |         |
+| bordered                 | Whether has border style                                                                                                                                                                                                                                                                               | boolean                                                | true                                                   |         |
+| clearIcon                | The custom clear icon                                                                                                                                                                                                                                                                                  | VNode \| slot                                          | -                                                      |         |
+| defaultActiveFirstOption | Whether active first option by default                                                                                                                                                                                                                                                                 | boolean                                                | true                                                   |         |
+| defaultOpen              | Initial open state of dropdown                                                                                                                                                                                                                                                                         | boolean                                                | -                                                      |         |
+| disabled                 | Whether disabled select                                                                                                                                                                                                                                                                                | boolean                                                | false                                                  |         |
+| popupClassName           | className of dropdown menu                                                                                                                                                                                                                                                                             | string                                                 | -                                                      | 4.0     |
+| dropdownMatchSelectWidth | Determine whether the dropdown menu and the select input are the same width. Default set `min-width` same as input. Will ignore when value less than select width. `false` will disable virtual scroll                                                                                                 | boolean \| number                                      | true                                                   |         |
+| dropdownMenuStyle        | additional style applied to dropdown menu                                                                                                                                                                                                                                                              | object                                                 | -                                                      |         |
+| dropdownRender           | Customize dropdown content                                                                                                                                                                                                                                                                             | ({menuNode: VNode, props}) => VNode \| v-slot          | -                                                      |         |
+| dropdownStyle            | style of dropdown menu                                                                                                                                                                                                                                                                                 | object                                                 | -                                                      |         |
+| fieldNames               | Customize node label, value, options field name                                                                                                                                                                                                                                                        | object                                                 | { label: `label`, value: `value`, options: `options` } | 3.0     |
+| filterOption             | If true, filter options by input, if function, filter options against it. The function will receive two arguments, `inputValue` and `option`, if the function returns `true`, the option will be included in the filtered set; Otherwise, it will be excluded.                                         | `boolean` \| `function(inputValue, option)`            | true                                                   |         |
+| filterSort               | Sort function for search options sorting, see [Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)'s compareFunction                                                                                                                              | (optionA: Option, optionB: Option) => number           | -                                                      | 3.0     |
+| firstActiveValue         | Value of action option by default                                                                                                                                                                                                                                                                      | string \| string\[]                                    | -                                                      |         |
+| getPopupContainer        | Parent Node which the selector should be rendered to. Default to `body`. When position issues happen, try to modify it into scrollable content and position it relative.                                                                                                                               | function(triggerNode)                                  | () => document.body                                    |         |
+| labelInValue             | whether to embed label in value, turn the format of value from `string` to `{key: string, label: vNodes, originLabel: any}`, originLabel (3.1) maintains the original type. If the node is constructed through a-select-option children, the value is a function (the default slot of a-select-option) | boolean                                                | false                                                  |         |
+| listHeight               | Config popup height                                                                                                                                                                                                                                                                                    | number                                                 | 256                                                    |         |
+| loading                  | indicate loading state                                                                                                                                                                                                                                                                                 | boolean                                                | false                                                  |         |
+| maxTagCount              | Max tag count to show                                                                                                                                                                                                                                                                                  | number                                                 | -                                                      |         |
+| maxTagPlaceholder        | Placeholder for not showing tags                                                                                                                                                                                                                                                                       | slot \| function(omittedValues)                        | -                                                      |         |
+| maxTagTextLength         | Max text length to show                                                                                                                                                                                                                                                                                | number                                                 | -                                                      |         |
+| menuItemSelectedIcon     | The custom menuItemSelected icon                                                                                                                                                                                                                                                                       | VNode \| slot                                          | -                                                      |         |
+| mode                     | Set mode of Select                                                                                                                                                                                                                                                                                     | 'multiple' \| 'tags'                                   | -                                                      |         |
+| notFoundContent          | Specify content to show when no result matches..                                                                                                                                                                                                                                                       | string\|slot                                           | `Not Found`                                            |         |
+| open                     | Controlled open state of dropdown                                                                                                                                                                                                                                                                      | boolean                                                | -                                                      |         |
+| option                   | custom render option by slot                                                                                                                                                                                                                                                                           | v-slot:option="{value, label, [disabled, key, title]}" | -                                                      | 2.2.5   |
+| optionFilterProp         | Which prop value of option will be used for filter if filterOption is true                                                                                                                                                                                                                             | string                                                 | value                                                  |         |
+| optionLabelProp          | Which prop value of option will render as content of select.                                                                                                                                                                                                                                           | string                                                 | `children` \| `label`(when use options)                |         |
+| options                  | Data of the selectOption, manual construction work is no longer needed if this property has been set                                                                                                                                                                                                   | Array&lt;{value, label, [disabled, key, title]}>       | \[]                                                    |         |
+| placeholder              | Placeholder of select                                                                                                                                                                                                                                                                                  | string\|slot                                           | -                                                      |         |
+| placement                | The position where the selection box pops up                                                                                                                                                                                                                                                           | `bottomLeft` `bottomRight` `topLeft` `topRight`        | bottomLeft                                             | 3.3.0   |
+| removeIcon               | The custom remove icon                                                                                                                                                                                                                                                                                 | VNode \| slot                                          | -                                                      |         |
+| searchValue              | The current input "search" text                                                                                                                                                                                                                                                                        | string                                                 | -                                                      |         |
+| showArrow                | Whether to show the drop-down arrow                                                                                                                                                                                                                                                                    | boolean                                                | single:true, multiple:false                            |         |
+| showSearch               | Whether select is searchable                                                                                                                                                                                                                                                                           | boolean                                                | single:false, multiple:true                            |         |
+| size                     | Size of Select input. `middle` `large` `small`                                                                                                                                                                                                                                                         | string                                                 | middle                                                 |         |
+| status                   | Set validation status                                                                                                                                                                                                                                                                                  | 'error' \| 'warning'                                   | -                                                      | 3.3.0   |
+| suffixIcon               | The custom suffix icon                                                                                                                                                                                                                                                                                 | VNode \| slot                                          | -                                                      |         |
+| tagRender                | Customize tag render, only applies when `mode` is set to `multiple` or `tags`                                                                                                                                                                                                                          | slot \| (props) => any                                 | -                                                      |         |
+| tokenSeparators          | Separator used to tokenize, only applies when `mode="tags"`                                                                                                                                                                                                                                            | string\[]                                              | -                                                      |         |
+| value(v-model)           | Current selected option.                                                                                                                                                                                                                                                                               | string\|number\|string\[]\|number\[]                   | -                                                      |         |
+| virtual                  | Disable virtual scroll when set to false                                                                                                                                                                                                                                                               | boolean                                                | true                                                   | 3.0     |
+
+> Note, if you find that the drop-down menu scrolls with the page, or you need to trigger Select in other popup layers, please try to use `getPopupContainer={triggerNode => triggerNode.parentElement}` to fix the drop-down popup rendering node in the parent element of the trigger .
+
+### events
+
+| Events Name           | Description                                                                                                                                             | Arguments                                          |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
+| blur                  | Called when blur                                                                                                                                        | function                                           |
+| change                | Called when select an option or input value change, or value of input is changed in combobox mode                                                       | function(value, option:Option \| Array&lt;Option>) |
+| deselect              | Called when a option is deselected, the params are option's value (or key) . only called for multiple or tags, effective in multiple or tags mode only. | function(value, option:Option)                     |
+| dropdownVisibleChange | Call when dropdown open                                                                                                                                 | function(open)                                     |
+| focus                 | Called when focus                                                                                                                                       | function                                           |
+| inputKeyDown          | Called when key pressed                                                                                                                                 | function                                           |
+| mouseenter            | Called when mouse enter                                                                                                                                 | function                                           |
+| mouseleave            | Called when mouse leave                                                                                                                                 | function                                           |
+| popupScroll           | Called when dropdown scrolls                                                                                                                            | function                                           |
+| search                | Callback function that is fired when input changed.                                                                                                     | function(value: string)                            |
+| select                | Called when a option is selected, the params are option's value (or key) and option instance.                                                           | function(value, option:Option)                     |
+
+### Select Methods
+
+| Name    | Description  |
+| ------- | ------------ |
+| blur()  | Remove focus |
+| focus() | Get focus    |
+
+### Option props
+
+| Property | Description                                                                                                                      | Type           | Default |
+| -------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------- |
+| class    | additional class to option                                                                                                       | string         | -       |
+| disabled | Disable this option                                                                                                              | boolean        | false   |
+| key      | Same usage as `value`. If Vue request you to set this property, you can set it to value of option, and then omit value property. | string         |         |
+| title    | `title` of Select after select this Option                                                                                       | string         | -       |
+| value    | default to filter with this property                                                                                             | string\|number | -       |
+
+### OptGroup props
+
+| Property | Description | Type         | Default |
+| -------- | ----------- | ------------ | ------- |
+| key      |             | string       | -       |
+| label    | Group label | string\|slot | -       |
+
+## FAQ
+
+### The dropdown is closed when click `dropdownRender` area?
+
+Dropdown menu will be closed if click `dropdownRender` area, you can prevent the default behavior of a click event, See the [dropdownRender example](#components-select-demo-custom-dropdown-menu).
+
+### Why is `placeholder` not displayed?
+
+`placeholder` will only be displayed when `value = undefined`, and other values such as null, 0,'', etc. are meaningful values for the JS language.
+
+You can check [JS Language Specification](https://262.ecma-international.org/5.1/#sec-4.3.9) for further details.
+
+You can also check [antd issue](https://github.com/ant-design/ant-design/issues/2367) to view the discussion.

package/src/select/index.tsx

@@ -0,0 +1,318 @@
+import type { App, ExtractPropTypes, Plugin } from 'vue'
+import { computed, defineComponent, ref } from 'vue'
+
+import classNames from '../_util/classNames'
+import omit from '../_util/omit'
+import { initDefaultProps } from '../_util/props-util'
+import type { InputStatus } from '../_util/statusUtils'
+import { getMergedStatus, getStatusClassNames } from '../_util/statusUtils'
+import type { SelectCommonPlacement } from '../_util/transition'
+import { getTransitionDirection, getTransitionName } from '../_util/transition'
+import { booleanType, functionType, someType, stringType } from '../_util/type'
+import type { CustomSlotsType } from '../_util/type'
+import PropTypes from '../_util/vue-types'
+import type { SizeType } from '../config-provider'
+import { useInjectDisabled } from '../config-provider/DisabledContext'
+import useConfigInject from '../config-provider/hooks/useConfigInject'
+import { DefaultRenderEmpty } from '../config-provider/renderEmpty'
+import { FormItemInputContext, useInjectFormItemContext } from '../form/FormItemContext'
+import { useCompactItemContext } from '../space/Compact'
+import type { BaseSelectRef } from '../vc-select'
+import RcSelect, { OptGroup, Option, selectProps as vcSelectProps } from '../vc-select'
+import type { OptionProps } from '../vc-select/Option'
+import type { BaseOptionType, DefaultOptionType } from '../vc-select/Select'
+import devWarning from '../vc-util/devWarning'
+// CSSINJS
+import useStyle from './style'
+import getIcons from './utils/iconUtil'
+
+type RawValue = string | number
+
+export type OptionType = typeof Option
+export type { BaseOptionType, DefaultOptionType, OptionProps, BaseSelectRef as RefSelectProps }
+
+export interface LabeledValue {
+  key?: string
+  value: RawValue
+  label?: any
+}
+export type SelectValue = RawValue | RawValue[] | LabeledValue | LabeledValue[] | undefined
+
+export const selectProps = () => ({
+  ...omit(vcSelectProps<SelectValue>(), [
+    'inputIcon',
+    'mode',
+    'getInputElement',
+    'getRawInputElement',
+    'backfill',
+  ]),
+  value: someType<SelectValue>([Array, Object, String, Number]),
+  defaultValue: someType<SelectValue>([Array, Object, String, Number]),
+  notFoundContent: PropTypes.any,
+  suffixIcon: PropTypes.any,
+  itemIcon: PropTypes.any,
+  size: stringType<SizeType>(),
+  mode: stringType<'multiple' | 'tags' | 'SECRET_COMBOBOX_MODE_DO_NOT_USE'>(),
+  bordered: booleanType(true),
+  transitionName: String,
+  choiceTransitionName: stringType(''),
+  popupClassName: String,
+  /** @deprecated Please use `popupClassName` instead */
+  dropdownClassName: String,
+  placement: stringType<SelectCommonPlacement>(),
+  status: stringType<InputStatus>(),
+  'onUpdate:value': functionType<(val: SelectValue) => void>(),
+})
+
+export type SelectProps = Partial<ExtractPropTypes<ReturnType<typeof selectProps>>>
+
+const SECRET_COMBOBOX_MODE_DO_NOT_USE = 'SECRET_COMBOBOX_MODE_DO_NOT_USE'
+const Select = defineComponent({
+  compatConfig: { MODE: 3 },
+  name: 'ASelect',
+  Option,
+  OptGroup,
+  inheritAttrs: false,
+  props: initDefaultProps(selectProps(), {
+    listHeight: 256,
+    listItemHeight: 24,
+  }),
+  SECRET_COMBOBOX_MODE_DO_NOT_USE,
+  slots: Object as CustomSlotsType<{
+    notFoundContent: any
+    suffixIcon: any
+    itemIcon: any
+    removeIcon: any
+    clearIcon: any
+    dropdownRender: any
+    option: any
+    placeholder: any
+    tagRender: any
+    maxTagPlaceholder: any
+    optionLabel: any
+    default: any
+  }>,
+  setup(props, { attrs, emit, slots, expose }) {
+    const selectRef = ref<BaseSelectRef>()
+    const formItemContext = useInjectFormItemContext()
+    const formItemInputContext = FormItemInputContext.useInject()
+    const mergedStatus = computed(() => getMergedStatus(formItemInputContext.status, props.status))
+    const focus = () => {
+      selectRef.value?.focus()
+    }
+
+    const blur = () => {
+      selectRef.value?.blur()
+    }
+
+    const scrollTo: BaseSelectRef['scrollTo'] = (arg) => {
+      selectRef.value?.scrollTo(arg)
+    }
+
+    const mode = computed(() => {
+      const { mode } = props
+
+      if ((mode as any) === 'combobox') {
+        return undefined
+      }
+
+      if (mode === SECRET_COMBOBOX_MODE_DO_NOT_USE) {
+        return 'combobox'
+      }
+
+      return mode
+    })
+
+    // ====================== Warning ======================
+    if (process.env.NODE_ENV !== 'production') {
+      devWarning(
+        !props.dropdownClassName,
+        'Select',
+        '`dropdownClassName` is deprecated. Please use `popupClassName` instead.',
+      )
+    }
+    const {
+      prefixCls,
+      direction,
+      configProvider,
+      renderEmpty,
+      size: contextSize,
+      getPrefixCls,
+      getPopupContainer,
+      disabled,
+      select,
+    } = useConfigInject('select', props)
+    const { compactSize, compactItemClassnames } = useCompactItemContext(prefixCls, direction)
+    const mergedSize = computed(() => compactSize.value || contextSize.value)
+    const contextDisabled = useInjectDisabled()
+    const mergedDisabled = computed(() => disabled.value ?? contextDisabled.value)
+    // style
+    const [wrapSSR, hashId] = useStyle(prefixCls)
+
+    const rootPrefixCls = computed(() => getPrefixCls())
+    // ===================== Placement =====================
+    const placement = computed(() => {
+      if (props.placement !== undefined) {
+        return props.placement
+      }
+      return direction.value === 'rtl'
+        ? ('bottomRight' as SelectCommonPlacement)
+        : ('bottomLeft' as SelectCommonPlacement)
+    })
+    const transitionName = computed(() =>
+      getTransitionName(
+        rootPrefixCls.value,
+        getTransitionDirection(placement.value),
+        props.transitionName,
+      ),
+    )
+    const mergedClassName = computed(() =>
+      classNames(
+        {
+          [`${prefixCls.value}-lg`]: mergedSize.value === 'large',
+          [`${prefixCls.value}-sm`]: mergedSize.value === 'small',
+          [`${prefixCls.value}-rtl`]: direction.value === 'rtl',
+          [`${prefixCls.value}-borderless`]: !props.bordered,
+          [`${prefixCls.value}-in-form-item`]: formItemInputContext.isFormItemInput,
+        },
+        getStatusClassNames(prefixCls.value, mergedStatus.value, formItemInputContext.hasFeedback),
+        compactItemClassnames.value,
+        hashId.value,
+      ),
+    )
+    const triggerChange: SelectProps['onChange'] = (...args) => {
+      emit('update:value', args[0])
+      emit('change', ...args)
+      formItemContext.onFieldChange()
+    }
+    const handleBlur: SelectProps['onBlur'] = (e) => {
+      emit('blur', e)
+      formItemContext.onFieldBlur()
+    }
+    expose({
+      blur,
+      focus,
+      scrollTo,
+    })
+    const isMultiple = computed(() => mode.value === 'multiple' || mode.value === 'tags')
+    const mergedShowArrow = computed(() =>
+      props.showArrow !== undefined
+        ? props.showArrow
+        : props.loading || !(isMultiple.value || mode.value === 'combobox'),
+    )
+
+    return () => {
+      const {
+        notFoundContent,
+        listHeight = 256,
+        listItemHeight = 24,
+        popupClassName,
+        dropdownClassName,
+        virtual,
+        dropdownMatchSelectWidth,
+        id = formItemContext.id.value,
+        placeholder = slots.placeholder?.(),
+        showArrow,
+      } = props
+      const { hasFeedback, feedbackIcon } = formItemInputContext
+      const {} = configProvider
+
+      // ===================== Empty =====================
+      let mergedNotFound: any
+      if (notFoundContent !== undefined) {
+        mergedNotFound = notFoundContent
+      } else if (slots.notFoundContent) {
+        mergedNotFound = slots.notFoundContent()
+      } else if (mode.value === 'combobox') {
+        mergedNotFound = null
+      } else {
+        mergedNotFound = renderEmpty?.('Select') || <DefaultRenderEmpty componentName="Select" />
+      }
+
+      // ===================== Icons =====================
+      const { suffixIcon, itemIcon, removeIcon, clearIcon } = getIcons(
+        {
+          ...props,
+          multiple: isMultiple.value,
+          prefixCls: prefixCls.value,
+          hasFeedback,
+          feedbackIcon,
+          showArrow: mergedShowArrow.value,
+        },
+        slots,
+      )
+
+      const selectProps = omit(props, [
+        'prefixCls',
+        'suffixIcon',
+        'itemIcon',
+        'removeIcon',
+        'clearIcon',
+        'size',
+        'bordered',
+        'status',
+      ])
+
+      const rcSelectRtlDropdownClassName = classNames(
+        popupClassName || dropdownClassName,
+        {
+          [`${prefixCls.value}-dropdown-${direction.value}`]: direction.value === 'rtl',
+        },
+        hashId.value,
+      )
+
+      return wrapSSR(
+        <RcSelect
+          ref={selectRef}
+          virtual={virtual}
+          dropdownMatchSelectWidth={dropdownMatchSelectWidth}
+          {...selectProps}
+          {...attrs}
+          showSearch={props.showSearch ?? select?.value?.showSearch}
+          placeholder={placeholder}
+          listHeight={listHeight}
+          listItemHeight={listItemHeight}
+          mode={mode.value}
+          prefixCls={prefixCls.value}
+          direction={direction.value}
+          inputIcon={suffixIcon}
+          menuItemSelectedIcon={itemIcon}
+          removeIcon={removeIcon}
+          clearIcon={clearIcon}
+          notFoundContent={mergedNotFound}
+          class={[mergedClassName.value, attrs.class]}
+          getPopupContainer={getPopupContainer?.value}
+          dropdownClassName={rcSelectRtlDropdownClassName}
+          onChange={triggerChange}
+          onBlur={handleBlur}
+          id={id}
+          dropdownRender={selectProps.dropdownRender || slots.dropdownRender}
+          v-slots={{ option: slots.option }}
+          transitionName={transitionName.value}
+          children={slots.default?.()}
+          tagRender={props.tagRender || slots.tagRender}
+          optionLabelRender={slots.optionLabel}
+          maxTagPlaceholder={props.maxTagPlaceholder || slots.maxTagPlaceholder}
+          showArrow={hasFeedback || showArrow}
+          disabled={mergedDisabled.value}
+        ></RcSelect>,
+      )
+    }
+  },
+})
+/* istanbul ignore next */
+Select.install = function (app: App) {
+  app.component(Select.name, Select)
+  app.component(Select.Option.displayName, Select.Option)
+  app.component(Select.OptGroup.displayName, Select.OptGroup)
+  return app
+}
+
+export const SelectOption = Select.Option
+export const SelectOptGroup = Select.OptGroup
+export default Select as typeof Select &
+  Plugin & {
+    readonly Option: typeof Option
+    readonly OptGroup: typeof OptGroup
+    readonly SECRET_COMBOBOX_MODE_DO_NOT_USE: 'SECRET_COMBOBOX_MODE_DO_NOT_USE'
+  }

package/src/select/index.zh-CN.md

@@ -0,0 +1,128 @@
+---
+category: Components
+subtitle: 选择器
+type: 数据录入
+title: Select
+cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*zo76T7KQx2UAAAAAAAAAAAAADrJ8AQ/original
+coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*5oPiTqPxGAUAAAAAAAAAAAAADrJ8AQ/original
+---
+
+下拉选择器。
+
+## 何时使用
+
+- 弹出一个下拉菜单给用户选择操作，用于代替原生的选择器，或者需要一个更优雅的多选器时。
+- 当选项少时（少于 5 项），建议直接将选项平铺，使用 [Radio](/components/radio/) 是更好的选择。
+
+## API
+
+```html
+<a-select>
+  <a-select-option value="lucy">lucy</a-select-option>
+</a-select>
+```
+
+### Select props
+
+| 参数                     | 说明                                                                                                                                                                                                                                                                      | 类型                                                   | 默认值                                                 | 版本  |
+| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ------------------------------------------------------ | ----- |
+| allowClear               | 支持清除                                                                                                                                                                                                                                                                  | boolean                                                | false                                                  |       |
+| autoClearSearchValue     | 是否在选中项后清空搜索框，只在 `mode` 为 `multiple` 或 `tags` 时有效。                                                                                                                                                                                                    | boolean                                                | true                                                   |       |
+| autofocus                | 默认获取焦点                                                                                                                                                                                                                                                              | boolean                                                | false                                                  |       |
+| bordered                 | 是否有边框                                                                                                                                                                                                                                                                | boolean                                                | true                                                   |       |
+| clearIcon                | 自定义的多选框清空图标                                                                                                                                                                                                                                                    | VNode \| slot                                          | -                                                      |       |
+| defaultActiveFirstOption | 是否默认高亮第一个选项。                                                                                                                                                                                                                                                  | boolean                                                | true                                                   |       |
+| defaultOpen              | 是否默认展开下拉菜单                                                                                                                                                                                                                                                      | boolean                                                | -                                                      |       |
+| disabled                 | 是否禁用                                                                                                                                                                                                                                                                  | boolean                                                | false                                                  |       |
+| popupClassName           | 下拉菜单的 className 属性                                                                                                                                                                                                                                                 | string                                                 | -                                                      | 4.0   |
+| dropdownMatchSelectWidth | 下拉菜单和选择器同宽。默认将设置 `min-width`，当值小于选择框宽度时会被忽略。false 时会关闭虚拟滚动                                                                                                                                                                        | boolean \| number                                      | true                                                   |       |
+| dropdownMenuStyle        | dropdown 菜单自定义样式                                                                                                                                                                                                                                                   | object                                                 | -                                                      |       |
+| dropdownRender           | 自定义下拉框内容                                                                                                                                                                                                                                                          | ({menuNode: VNode, props}) => VNode \| v-slot          | -                                                      |       |
+| dropdownStyle            | 下拉菜单的 style 属性                                                                                                                                                                                                                                                     | object                                                 | -                                                      |       |
+| fieldNames               | 自定义节点 label、value、options 的字段                                                                                                                                                                                                                                   | object                                                 | { label: `label`, value: `value`, options: `options` } | 3.0   |
+| filterOption             | 是否根据输入项进行筛选。当其为一个函数时，会接收 `inputValue` `option` 两个参数，当 `option` 符合筛选条件时，应返回 `true`，反之则返回 `false`。                                                                                                                          | `boolean` \| `function(inputValue, option)`            | true                                                   |       |
+| filterSort               | 搜索时对筛选结果项的排序函数, 类似[Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)里的 compareFunction                                                                                                           | (optionA: Option, optionB: Option) => number           | -                                                      | 3.0   |
+| firstActiveValue         | 默认高亮的选项                                                                                                                                                                                                                                                            | string \| string\[]                                    | -                                                      |       |
+| getPopupContainer        | 菜单渲染父节点。默认渲染到 body 上，如果你遇到菜单滚动定位问题，试试修改为滚动的区域，并相对其定位。                                                                                                                                                                      | function(triggerNode)                                  | () => document.body                                    |       |
+| labelInValue             | 是否把每个选项的 label 包装到 value 中，会把 Select 的 value 类型从 `string` 变为 `{key: string, label: vNodes, originLabel: any}` 的格式, originLabel（3.1） 保持原始类型，如果通过 a-select-option children 构造的节点，该值是是个函数（即 a-select-option 的默认插槽） | boolean                                                | false                                                  |       |
+| listHeight               | 设置弹窗滚动高度                                                                                                                                                                                                                                                          | number                                                 | 256                                                    |       |
+| maxTagCount              | 最多显示多少个 tag                                                                                                                                                                                                                                                        | number                                                 | -                                                      |       |
+| maxTagPlaceholder        | 隐藏 tag 时显示的内容                                                                                                                                                                                                                                                     | slot \| function(omittedValues)                        | -                                                      |       |
+| maxTagTextLength         | 最大显示的 tag 文本长度                                                                                                                                                                                                                                                   | number                                                 | -                                                      |       |
+| menuItemSelectedIcon     | 自定义当前选中的条目图标                                                                                                                                                                                                                                                  | VNode \| slot                                          | -                                                      |       |
+| mode                     | 设置 Select 的模式为多选或标签                                                                                                                                                                                                                                            | 'multiple' \| 'tags' \| 'combobox'                     | -                                                      |       |
+| notFoundContent          | 当下拉列表为空时显示的内容                                                                                                                                                                                                                                                | string\|slot                                           | `Not Found`                                            |       |
+| open                     | 是否展开下拉菜单                                                                                                                                                                                                                                                          | boolean                                                | -                                                      |       |
+| option                   | 通过 option 插槽，自定义节点                                                                                                                                                                                                                                              | v-slot:option="{value, label, [disabled, key, title]}" | -                                                      | 2.2.5 |
+| optionFilterProp         | 搜索时过滤对应的 option 属性，不支持 children                                                                                                                                                                                                                             | string                                                 | value                                                  |       |
+| optionLabelProp          | 回填到选择框的 Option 的属性值，默认是 Option 的子元素。比如在子元素需要高亮效果时，此值可以设为 `value`。                                                                                                                                                                | string                                                 | `children` \| `label`(设置 options 时)                 |       |
+| options                  | options 数据，如果设置则不需要手动构造 selectOption 节点                                                                                                                                                                                                                  | Array&lt;{value, label, [disabled, key, title]}>       | \[]                                                    |       |
+| placeholder              | 选择框默认文字                                                                                                                                                                                                                                                            | string\|slot                                           | -                                                      |       |
+| placement                | 选择框弹出的位置                                                                                                                                                                                                                                                          | `bottomLeft` `bottomRight` `topLeft` `topRight`        | bottomLeft                                             | 3.3.0 |
+| removeIcon               | 自定义的多选框清除图标                                                                                                                                                                                                                                                    | VNode \| slot                                          | -                                                      |       |
+| searchValue              | 控制搜索文本                                                                                                                                                                                                                                                              | string                                                 | -                                                      |       |
+| showArrow                | 是否显示下拉小箭头                                                                                                                                                                                                                                                        | boolean                                                | 单选为 true,多选为 false                               |       |
+| showSearch               | 配置是否可搜索                                                                                                                                                                                                                                                            | boolean                                                | 单选为 false,多选为 true                               |       |
+| size                     | 选择框大小，可选 `middle` `large` `small`                                                                                                                                                                                                                                 | string                                                 | middle                                                 |       |
+| status                   | 设置校验状态                                                                                                                                                                                                                                                              | 'error' \| 'warning'                                   | -                                                      | 3.3.0 |
+| suffixIcon               | 自定义的选择框后缀图标                                                                                                                                                                                                                                                    | VNode \| slot                                          | -                                                      |       |
+| tagRender                | 自定义 tag 内容 render，仅在 `mode` 为 `multiple` 或 `tags` 时生效                                                                                                                                                                                                        | slot \| (props) => any                                 | -                                                      | 3.0   |
+| tokenSeparators          | 自动分词的分隔符，仅在 `mode="tags"` 时生效                                                                                                                                                                                                                               | string\[]                                              | -                                                      |       |
+| value(v-model)           | 指定当前选中的条目                                                                                                                                                                                                                                                        | string\|string\[]\|number\|number\[]                   | -                                                      |       |
+| virtual                  | 设置 false 时关闭虚拟滚动                                                                                                                                                                                                                                                 | boolean                                                | true                                                   | 3.0   |
+
+> 注意，如果发现下拉菜单跟随页面滚动，或者需要在其他弹层中触发 Select，请尝试使用 `getPopupContainer={triggerNode => triggerNode.parentNode}` 将下拉弹层渲染节点固定在触发器的父元素中。
+
+### 事件
+
+| 事件名称              | 说明                                                                               | 回调参数                                           |
+| --------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------- |
+| blur                  | 失去焦点的时回调                                                                   | function                                           |
+| change                | 选中 option，或 input 的 value 变化（combobox 模式下）时，调用此函数               | function(value, option:Option \| Array&lt;Option>) |
+| deselect              | 取消选中时调用，参数为选中项的 value (或 key) 值，仅在 multiple 或 tags 模式下生效 | function(value，option:Option)                     |
+| dropdownVisibleChange | 展开下拉菜单的回调                                                                 | function(open)                                     |
+| focus                 | 获得焦点时回调                                                                     | function                                           |
+| inputKeyDown          | 键盘按下时回调                                                                     | function                                           |
+| mouseenter            | 鼠标移入时回调                                                                     | function                                           |
+| mouseleave            | 鼠标移出时回调                                                                     | function                                           |
+| popupScroll           | 下拉列表滚动时的回调                                                               | function                                           |
+| search                | 文本框值变化时回调                                                                 | function(value: string)                            |
+| select                | 被选中时调用，参数为选中项的 value (或 key) 值                                     | function(value, option:Option)                     |
+
+### Select Methods
+
+| 名称    | 说明     |
+| ------- | -------- |
+| blur()  | 取消焦点 |
+| focus() | 获取焦点 |
+
+### Option props
+
+| 参数     | 说明                                                                                         | 类型           | 默认值 |
+| -------- | -------------------------------------------------------------------------------------------- | -------------- | ------ |
+| class    | Option 器类名                                                                                | string         | -      |
+| disabled | 是否禁用                                                                                     | boolean        | false  |
+| key      | 和 value 含义一致。如果 Vue 需要你设置此项，此项值与 value 的值相同，然后可以省略 value 设置 | string         |        |
+| title    | 选中该 Option 后，Select 的 title                                                            | string         | -      |
+| value    | 默认根据此属性值进行筛选                                                                     | string\|number | -      |
+
+### OptGroup props
+
+| 参数  | 说明 | 类型                      | 默认值 |
+| ----- | ---- | ------------------------- | ------ |
+| key   |      | string                    | -      |
+| label | 组名 | string\|function(h)\|slot | -      |
+
+## FAQ
+
+### 点击 `dropdownRender` 里的内容浮层关闭怎么办？
+
+自定义内容点击时会关闭浮层，如果不喜欢关闭，可以通过取消点击事件的默认行为进行阻止。 看下 [dropdownRender 例子](#components-select-demo-custom-dropdown-menu) 里的说明。
+
+### 为什么 `placeholder` 不显示 ？
+
+`placeholder` 只有在 value = undefined 才会显示，对于其它的 null、0、'' 等等对于 JS 语言都是有意义的值。
+
+你可以查看 [JS 语言规范](https://262.ecma-international.org/5.1/#sec-4.3.9) 进一步了解详情。
+
+也可以查看 [antd issue](https://github.com/ant-design/ant-design/issues/2367) 查看讨论情况。