import { placements } from '@popperjs/core' import { scrollbarEmits } from '@element-plus/components/scrollbar' import { useAriaProps, useEmptyValuesProps, useSizeProp, } from '@element-plus/hooks' import { buildProps, definePropType, iconPropType } from '@element-plus/utils' import { useTooltipContentProps } from '@element-plus/components/tooltip' import { ArrowDown, CircleClose } from '@element-plus/icons-vue' import { tagProps } from '@element-plus/components/tag' import { CHANGE_EVENT, UPDATE_MODEL_EVENT } from '@element-plus/constants' import { defaultProps } from '@element-plus/components/select-v2/src/useProps' import type { EmitFn } from '@element-plus/utils' import type { CSSProperties, ExtractPropTypes, __ExtractPublicPropTypes, } from 'vue' import type Select from './select.vue' import type { Options, Placement, PopperEffect, } from '@element-plus/components/popper' import type { OptionValue } from './type' import type { Props } from '@element-plus/components/select-v2/src/useProps' export const selectProps = buildProps({ /** * @description the name attribute of select input */ name: String, /** * @description native input id */ id: String, /** * @description binding value */ modelValue: { type: definePropType([ Array, String, Number, Boolean, Object, ]), default: undefined, }, /** * @description the autocomplete attribute of select input */ autocomplete: { type: String, default: 'off', }, /** * @description for non-filterable Select, this prop decides if the option menu pops up when the input is focused */ automaticDropdown: Boolean, /** * @description size of Input */ size: useSizeProp, /** * @description tooltip theme, built-in theme: `dark` / `light` */ effect: { type: definePropType(String), default: 'light', }, /** * @description whether Select is disabled */ disabled: Boolean, /** * @description whether select can be cleared */ clearable: Boolean, /** * @description whether Select is filterable */ filterable: Boolean, /** * @description whether creating new items is allowed. To use this, `filterable` must be true */ allowCreate: Boolean, /** * @description whether Select is loading data from server */ loading: Boolean, /** * @description custom class name for Select's dropdown */ popperClass: { type: String, default: '', }, /** * @description custom style for Select's dropdown */ popperStyle: { type: definePropType([String, Object]), }, /** * @description [popper.js](https://popper.js.org/docs/v2/) parameters */ popperOptions: { type: definePropType>(Object), default: () => ({}) as Partial, }, /** * @description whether options are loaded from server */ remote: Boolean, /** * @description displayed text while loading data from server, default is 'Loading' */ loadingText: String, /** * @description displayed text when no data matches the filtering query, you can also use slot `empty`, default is 'No matching data' */ noMatchText: String, /** * @description displayed text when there is no options, you can also use slot `empty`, default is 'No data' */ noDataText: String, /** * @description function that gets called when the input value changes. Its parameter is the current input value. To use this, `filterable` must be true */ remoteMethod: { type: definePropType<(query: string) => void>(Function), }, /** * @description custom filter method, the first parameter is the current input value. To use this, `filterable` must be true */ filterMethod: { type: definePropType<(query: string) => void>(Function), }, /** * @description whether multiple-select is activated */ multiple: Boolean, /** * @description maximum number of options user can select when `multiple` is `true`. No limit when set to 0 */ multipleLimit: { type: Number, default: 0, }, /** * @description placeholder, default is 'Select' */ placeholder: { type: String, }, /** * @description select first matching option on enter key. Use with `filterable` or `remote` */ defaultFirstOption: Boolean, /** * @description when `multiple` and `filter` is true, whether to reserve current keyword after selecting an option */ reserveKeyword: { type: Boolean, default: true, }, /** * @description unique identity key name for value, required when value is an object */ valueKey: { type: String, default: 'value', }, /** * @description whether to collapse tags to a text when multiple selecting */ collapseTags: Boolean, /** * @description whether show all selected tags when mouse hover text of collapse-tags. To use this, `collapse-tags` must be true */ collapseTagsTooltip: Boolean, /** * @description the max tags number to be shown. To use this, `collapse-tags` must be true */ maxCollapseTags: { type: Number, default: 1, }, /** * @description whether select dropdown is teleported, if `true` it will be teleported to where `append-to` sets */ teleported: useTooltipContentProps.teleported, /** * @description when select dropdown is inactive and `persistent` is `false`, select dropdown will be destroyed */ persistent: { type: Boolean, default: true, }, /** * @description custom clear icon component */ clearIcon: { type: iconPropType, default: CircleClose, }, /** * @description whether the width of the dropdown is the same as the input */ fitInputWidth: Boolean, /** * @description custom suffix icon component */ suffixIcon: { type: iconPropType, default: ArrowDown, }, /** * @description tag type */ tagType: { ...tagProps.type, default: 'info' }, /** * @description tag effect */ tagEffect: { ...tagProps.effect, default: 'light' }, /** * @description whether to trigger form validation */ validateEvent: { type: Boolean, default: true, }, /** * @description in remote search method show suffix icon */ remoteShowSuffix: Boolean, /** * @description determines whether the arrow is displayed */ showArrow: { type: Boolean, default: true, }, /** * @description offset of the dropdown */ offset: { type: Number, default: 12, }, /** * @description position of dropdown */ placement: { type: definePropType(String), values: placements, default: 'bottom-start', }, /** * @description list of possible positions for dropdown */ fallbackPlacements: { type: definePropType(Array), default: ['bottom-start', 'top-start', 'right', 'left'], }, /** * @description tabindex for input */ tabindex: { type: [String, Number], default: 0, }, /** * @description which element the selection dropdown appends to */ appendTo: useTooltipContentProps.appendTo, options: { type: definePropType[]>(Array), }, props: { type: definePropType(Object), default: () => defaultProps, }, ...useEmptyValuesProps, ...useAriaProps(['ariaLabel']), }) /* eslint-disable @typescript-eslint/no-unused-vars */ export const selectEmits = { [UPDATE_MODEL_EVENT]: (val: SelectProps['modelValue']) => true, [CHANGE_EVENT]: (val: SelectProps['modelValue']) => true, 'popup-scroll': scrollbarEmits.scroll, 'remove-tag': (val: unknown) => true, 'visible-change': (visible: boolean) => true, focus: (evt: FocusEvent) => evt instanceof FocusEvent, blur: (evt: FocusEvent) => evt instanceof FocusEvent, clear: () => true, } /* eslint-enable @typescript-eslint/no-unused-vars */ export type SelectProps = ExtractPropTypes export type SelectPropsPublic = __ExtractPublicPropTypes export type SelectEmits = EmitFn export type SelectInstance = InstanceType & unknown export type SelectOptionProps = Props