Files
vxe-table/packages/select/src/select.ts
2021-08-12 23:22:48 +08:00

819 lines
27 KiB
TypeScript

import { defineComponent, h, Teleport, PropType, ref, Ref, VNode, resolveComponent, ComponentOptions, computed, provide, onUnmounted, reactive, nextTick, watch, onMounted } from 'vue'
import XEUtils from 'xe-utils'
import GlobalConfig from '../../v-x-e-table/src/conf'
import { useSize } from '../../hooks/size'
import { getEventTargetNode, getAbsolutePos } from '../../tools/dom'
import { getLastZIndex, nextZIndex, getFuncText, formatText } from '../../tools/utils'
import { GlobalEvent, hasEventKey, EVENT_KEYS } from '../../tools/event'
import { VxeSelectPropTypes, VxeSelectConstructor, SelectReactData, VxeSelectEmits, SelectMethods, SelectPrivateRef, VxeSelectMethods, VxeInputConstructor, VxeOptgroupProps, VxeOptionProps } from '../../../types/all'
function isOptionVisible (option: any) {
return option.visible !== false
}
function getOptUniqueId () {
return XEUtils.uniqueId('opt_')
}
export default defineComponent({
name: 'VxeSelect',
props: {
modelValue: null,
clearable: Boolean as PropType<VxeSelectPropTypes.Clearable>,
placeholder: String as PropType<VxeSelectPropTypes.Placeholder>,
loading: Boolean as PropType<VxeSelectPropTypes.Loading>,
disabled: Boolean as PropType<VxeSelectPropTypes.Disabled>,
multiple: Boolean as PropType<VxeSelectPropTypes.Multiple>,
multiCharOverflow: { type: [Number, String] as PropType<VxeSelectPropTypes.MultiCharOverflow>, default: () => GlobalConfig.select.multiCharOverflow },
prefixIcon: String as PropType<VxeSelectPropTypes.PrefixIcon>,
placement: String as PropType<VxeSelectPropTypes.Placement>,
options: Array as PropType<VxeSelectPropTypes.Options>,
optionProps: Object as PropType<VxeSelectPropTypes.OptionProps>,
optionGroups: Array as PropType<VxeSelectPropTypes.OptionGroups>,
optionGroupProps: Object as PropType<VxeSelectPropTypes.OptionGroupProps>,
className: [String, Function] as PropType<VxeSelectPropTypes.ClassName>,
size: { type: String as PropType<VxeSelectPropTypes.Size>, default: () => GlobalConfig.select.size || GlobalConfig.size },
emptyText: String as PropType<VxeSelectPropTypes.EmptyText>,
optionId: { type: String as PropType<VxeSelectPropTypes.OptionId>, default: () => GlobalConfig.select.optionId },
optionKey: Boolean as PropType<VxeSelectPropTypes.OptionKey>,
transfer: { type: Boolean as PropType<VxeSelectPropTypes.Transfer>, default: () => GlobalConfig.select.transfer }
},
emits: [
'update:modelValue',
'change',
'clear'
] as VxeSelectEmits,
setup (props, context) {
const { slots, emit } = context
const xID = XEUtils.uniqueId()
const computeSize = useSize(props)
const reactData = reactive<SelectReactData>({
inited: false,
staticOptions: [],
fullGroupList: [],
fullOptionList: [],
visibleGroupList: [],
visibleOptionList: [],
panelIndex: 0,
panelStyle: {},
panelPlacement: null,
currentValue: null,
visiblePanel: false,
animatVisible: false,
isActivated: false
})
const refElem = ref() as Ref<HTMLDivElement>
const refInput = ref() as Ref<VxeInputConstructor>
const refOptionWrapper = ref() as Ref<HTMLDivElement>
const refOptionPanel = ref() as Ref<HTMLDivElement>
const refMaps: SelectPrivateRef = {
refElem
}
const $xeselect = {
xID,
props,
context,
reactData,
getRefMaps: () => refMaps
} as unknown as VxeSelectConstructor & VxeSelectMethods
let selectMethods = {} as SelectMethods
const computePropsOpts = computed(() => {
return props.optionProps || {}
})
const computeGroupPropsOpts = computed(() => {
return props.optionGroupProps || {}
})
const computeLabelField = computed(() => {
const propsOpts = computePropsOpts.value
return propsOpts.label || 'label'
})
const computeValueField = computed(() => {
const propsOpts = computePropsOpts.value
return propsOpts.value || 'value'
})
const computeGroupLabelField = computed(() => {
const groupPropsOpts = computeGroupPropsOpts.value
return groupPropsOpts.label || 'label'
})
const computeGroupOptionsField = computed(() => {
const groupPropsOpts = computeGroupPropsOpts.value
return groupPropsOpts.options || 'options'
})
const computeIsGroup = computed(() => {
return reactData.fullGroupList.some((item) => item.options && item.options.length)
})
const computeMultiMaxCharNum = computed(() => {
return XEUtils.toNumber(props.multiCharOverflow)
})
const callSlot = <T>(slotFunc: ((params: T) => JSX.Element[] | VNode[] | string[]) | string | null, params: T) => {
if (slotFunc) {
if (XEUtils.isString(slotFunc)) {
slotFunc = slots[slotFunc] || null
}
if (XEUtils.isFunction(slotFunc)) {
return slotFunc(params)
}
}
return []
}
const findOption = (optionValue: any) => {
const { fullOptionList, fullGroupList } = reactData
const isGroup = computeIsGroup.value
const valueField = computeValueField.value as 'value'
if (isGroup) {
for (let gIndex = 0; gIndex < fullGroupList.length; gIndex++) {
const group = fullGroupList[gIndex]
if (group.options) {
for (let index = 0; index < group.options.length; index++) {
const option = group.options[index]
if (optionValue === option[valueField]) {
return option
}
}
}
}
}
return fullOptionList.find((item) => optionValue === item[valueField])
}
const getSelectLabel = (value: any) => {
const labelField = computeLabelField.value
const item = findOption(value)
return XEUtils.toValueString(item ? item[labelField as 'label'] : value)
}
const computeSelectLabel = computed(() => {
const { modelValue, multiple } = props
const multiMaxCharNum = computeMultiMaxCharNum.value
if (modelValue && multiple) {
return (XEUtils.isArray(modelValue) ? modelValue : [modelValue]).map((val) => {
const label = getSelectLabel(val)
if (multiMaxCharNum > 0 && label.length > multiMaxCharNum) {
return `${label.substring(0, multiMaxCharNum)}...`
}
return label
}).join(', ')
}
return getSelectLabel(modelValue)
})
const getOptkey = () => {
return props.optionId || '_XID'
}
const getOptid = (option: any) => {
const optid = option[getOptkey()]
return optid ? encodeURIComponent(optid) : ''
}
/**
* 刷新选项,当选项被动态显示/隐藏时可能会用到
*/
const refreshOption = () => {
const { fullOptionList, fullGroupList } = reactData
const isGroup = computeIsGroup.value
if (isGroup) {
reactData.visibleGroupList = fullGroupList.filter(isOptionVisible)
} else {
reactData.visibleOptionList = fullOptionList.filter(isOptionVisible)
}
return nextTick()
}
const updateCache = () => {
const { fullOptionList, fullGroupList } = reactData
const groupOptionsField = computeGroupOptionsField.value
const key = getOptkey()
const handleOptis = (item: any) => {
if (!getOptid(item)) {
item[key] = getOptUniqueId()
}
}
if (fullGroupList.length) {
fullGroupList.forEach((group: any) => {
handleOptis(group)
if (group[groupOptionsField]) {
group[groupOptionsField].forEach(handleOptis)
}
})
} else if (fullOptionList.length) {
fullOptionList.forEach(handleOptis)
}
refreshOption()
}
const setCurrentOption = (option: any) => {
const valueField = computeValueField.value
if (option) {
reactData.currentValue = option[valueField]
}
}
const scrollToOption = (option: any, isAlignBottom?: boolean) => {
return nextTick().then(() => {
if (option) {
const optWrapperElem = refOptionWrapper.value
const panelElem = refOptionPanel.value
const optElem = panelElem.querySelector(`[optid='${getOptid(option)}']`) as HTMLElement
if (optWrapperElem && optElem) {
const wrapperHeight = optWrapperElem.offsetHeight
const offsetPadding = 5
if (isAlignBottom) {
if (optElem.offsetTop + optElem.offsetHeight - optWrapperElem.scrollTop > wrapperHeight) {
optWrapperElem.scrollTop = optElem.offsetTop + optElem.offsetHeight - wrapperHeight
}
} else {
if (optElem.offsetTop + offsetPadding < optWrapperElem.scrollTop || optElem.offsetTop + offsetPadding > optWrapperElem.scrollTop + optWrapperElem.clientHeight) {
optWrapperElem.scrollTop = optElem.offsetTop - offsetPadding
}
}
}
}
})
}
const updateZindex = () => {
if (reactData.panelIndex < getLastZIndex()) {
reactData.panelIndex = nextZIndex()
}
}
const updatePlacement = () => {
return nextTick().then(() => {
const { transfer, placement } = props
const { panelIndex } = reactData
const el = refElem.value
const panelElem = refOptionPanel.value
if (panelElem && el) {
const targetHeight = el.offsetHeight
const targetWidth = el.offsetWidth
const panelHeight = panelElem.offsetHeight
const panelWidth = panelElem.offsetWidth
const marginSize = 5
const panelStyle: { [key: string]: any } = {
zIndex: panelIndex
}
const { boundingTop, boundingLeft, visibleHeight, visibleWidth } = getAbsolutePos(el)
let panelPlacement = 'bottom'
if (transfer) {
let left = boundingLeft
let top = boundingTop + targetHeight
if (placement === 'top') {
panelPlacement = 'top'
top = boundingTop - panelHeight
} else if (!placement) {
// 如果下面不够放,则向上
if (top + panelHeight + marginSize > visibleHeight) {
panelPlacement = 'top'
top = boundingTop - panelHeight
}
// 如果上面不够放,则向下(优先)
if (top < marginSize) {
panelPlacement = 'bottom'
top = boundingTop + targetHeight
}
}
// 如果溢出右边
if (left + panelWidth + marginSize > visibleWidth) {
left -= left + panelWidth + marginSize - visibleWidth
}
// 如果溢出左边
if (left < marginSize) {
left = marginSize
}
Object.assign(panelStyle, {
left: `${left}px`,
top: `${top}px`,
minWidth: `${targetWidth}px`
})
} else {
if (placement === 'top') {
panelPlacement = 'top'
panelStyle.bottom = `${targetHeight}px`
} else if (!placement) {
// 如果下面不够放,则向上
if (boundingTop + targetHeight + panelHeight > visibleHeight) {
// 如果上面不够放,则向下(优先)
if (boundingTop - targetHeight - panelHeight > marginSize) {
panelPlacement = 'top'
panelStyle.bottom = `${targetHeight}px`
}
}
}
}
reactData.panelStyle = panelStyle
reactData.panelPlacement = panelPlacement
return nextTick()
}
})
}
let hidePanelTimeout: number
const showOptionPanel = () => {
const { loading, disabled } = props
if (!loading && !disabled) {
clearTimeout(hidePanelTimeout)
if (!reactData.inited) {
reactData.inited = true
}
reactData.isActivated = true
reactData.animatVisible = true
setTimeout(() => {
const { modelValue, multiple } = props
const currOption = findOption(multiple && modelValue ? modelValue[0] : modelValue)
reactData.visiblePanel = true
if (currOption) {
setCurrentOption(currOption)
scrollToOption(currOption)
}
}, 10)
updateZindex()
updatePlacement()
}
}
const hideOptionPanel = () => {
reactData.visiblePanel = false
hidePanelTimeout = window.setTimeout(() => {
reactData.animatVisible = false
}, 350)
}
const changeEvent = (evnt: Event, selectValue: any) => {
if (selectValue !== props.modelValue) {
emit('update:modelValue', selectValue)
selectMethods.dispatchEvent('change', { value: selectValue }, evnt)
}
}
const clearValueEvent = (evnt: Event, selectValue: any) => {
changeEvent(evnt, selectValue)
selectMethods.dispatchEvent('clear', { value: selectValue }, evnt)
}
const clearEvent = (params: any, evnt: Event) => {
clearValueEvent(evnt, null)
hideOptionPanel()
}
const changeOptionEvent = (evnt: Event, selectValue: any) => {
const { modelValue, multiple } = props
if (multiple) {
let multipleValue
if (modelValue) {
if (modelValue.indexOf(selectValue) === -1) {
multipleValue = modelValue.concat([selectValue])
} else {
multipleValue = (modelValue as any[]).filter((val) => val !== selectValue)
}
} else {
multipleValue = [selectValue]
}
changeEvent(evnt, multipleValue)
} else {
changeEvent(evnt, selectValue)
hideOptionPanel()
}
}
const handleGlobalMousewheelEvent = (evnt: MouseEvent) => {
const { disabled } = props
const { visiblePanel } = reactData
if (!disabled) {
if (visiblePanel) {
const panelElem = refOptionPanel.value
if (getEventTargetNode(evnt, panelElem).flag) {
updatePlacement()
} else {
hideOptionPanel()
}
}
}
}
const handleGlobalMousedownEvent = (evnt: MouseEvent) => {
const { disabled } = props
const { visiblePanel } = reactData
if (!disabled) {
const el = refElem.value
const panelElem = refOptionPanel.value
reactData.isActivated = getEventTargetNode(evnt, el).flag || getEventTargetNode(evnt, panelElem).flag
if (visiblePanel && !reactData.isActivated) {
hideOptionPanel()
}
}
}
const findOffsetOption = (optionValue: any, isUpArrow: boolean) => {
const { visibleOptionList, visibleGroupList } = reactData
const isGroup = computeIsGroup.value
const valueField = computeValueField.value as 'value'
const groupOptionsField = computeGroupOptionsField.value as 'options'
let firstOption
let prevOption
let nextOption
let currOption
if (isGroup) {
for (let gIndex = 0; gIndex < visibleGroupList.length; gIndex++) {
const group = visibleGroupList[gIndex]
const groupOptionList = group[groupOptionsField]
const isGroupDisabled = group.disabled
if (groupOptionList) {
for (let index = 0; index < groupOptionList.length; index++) {
const option = groupOptionList[index]
const isVisible = isOptionVisible(option)
const isDisabled = isGroupDisabled || option.disabled
if (!firstOption && !isDisabled) {
firstOption = option
}
if (currOption) {
if (isVisible && !isDisabled) {
nextOption = option
if (!isUpArrow) {
return { offsetOption: nextOption }
}
}
}
if (optionValue === option[valueField]) {
currOption = option
if (isUpArrow) {
return { offsetOption: prevOption }
}
} else {
if (isVisible && !isDisabled) {
prevOption = option
}
}
}
}
}
} else {
for (let index = 0; index < visibleOptionList.length; index++) {
const option = visibleOptionList[index]
const isDisabled = option.disabled
if (!firstOption && !isDisabled) {
firstOption = option
}
if (currOption) {
if (!isDisabled) {
nextOption = option
if (!isUpArrow) {
return { offsetOption: nextOption }
}
}
}
if (optionValue === option[valueField]) {
currOption = option
if (isUpArrow) {
return { offsetOption: prevOption }
}
} else {
if (!isDisabled) {
prevOption = option
}
}
}
}
return { firstOption }
}
const handleGlobalKeydownEvent = (evnt: KeyboardEvent) => {
const { clearable, disabled } = props
const { visiblePanel, currentValue } = reactData
if (!disabled) {
const isTab = hasEventKey(evnt, EVENT_KEYS.TAB)
const isEnter = hasEventKey(evnt, EVENT_KEYS.ENTER)
const isEsc = hasEventKey(evnt, EVENT_KEYS.ESCAPE)
const isUpArrow = hasEventKey(evnt, EVENT_KEYS.ARROW_UP)
const isDwArrow = hasEventKey(evnt, EVENT_KEYS.ARROW_DOWN)
const isDel = hasEventKey(evnt, EVENT_KEYS.DELETE)
const isSpacebar = hasEventKey(evnt, EVENT_KEYS.SPACEBAR)
if (isTab) {
reactData.isActivated = false
}
if (visiblePanel) {
if (isEsc || isTab) {
hideOptionPanel()
} else if (isEnter) {
evnt.preventDefault()
evnt.stopPropagation()
changeOptionEvent(evnt, currentValue)
} else if (isUpArrow || isDwArrow) {
evnt.preventDefault()
let { firstOption, offsetOption } = findOffsetOption(currentValue, isUpArrow)
if (!offsetOption && !findOption(currentValue)) {
offsetOption = firstOption
}
setCurrentOption(offsetOption)
scrollToOption(offsetOption, isDwArrow)
} else if (isSpacebar) {
evnt.preventDefault()
}
} else if ((isUpArrow || isDwArrow || isEnter || isSpacebar) && reactData.isActivated) {
evnt.preventDefault()
showOptionPanel()
}
if (reactData.isActivated) {
if (isDel && clearable) {
clearValueEvent(evnt, null)
}
}
}
}
const handleGlobalBlurEvent = () => {
hideOptionPanel()
}
const focusEvent = () => {
if (!props.disabled) {
reactData.isActivated = true
}
}
const blurEvent = () => {
reactData.isActivated = false
}
const togglePanelEvent = (params: any) => {
const { $event } = params
$event.preventDefault()
if (reactData.visiblePanel) {
hideOptionPanel()
} else {
showOptionPanel()
}
}
const renderOption = (list: VxeOptionProps[], group?: VxeOptgroupProps) => {
const { optionKey, modelValue, multiple } = props
const { currentValue } = reactData
const labelField = computeLabelField.value
const valueField = computeValueField.value
const isGroup = computeIsGroup.value
return list.map((option, cIndex) => {
const { slots, className } = option
const isVisible = !isGroup || isOptionVisible(option)
const isDisabled = (group && group.disabled) || option.disabled
const optionValue = option[valueField as 'value']
const optid = getOptid(option)
const defaultSlot = slots ? slots.default : null
return isVisible ? h('div', {
key: optionKey ? optid : cIndex,
class: ['vxe-select-option', className ? (XEUtils.isFunction(className) ? className({ option, $select: $xeselect }) : className) : '', {
'is--disabled': isDisabled,
'is--selected': multiple ? (modelValue && modelValue.indexOf(optionValue) > -1) : modelValue === optionValue,
'is--hover': currentValue === optionValue
}],
// attrs
optid: optid,
// event
onMousedown: (evnt: MouseEvent) => {
const isLeftBtn = evnt.button === 0
if (isLeftBtn) {
evnt.stopPropagation()
}
},
onClick: (evnt: MouseEvent) => {
if (!isDisabled) {
changeOptionEvent(evnt, optionValue)
}
},
onMouseenter: () => {
if (!isDisabled) {
setCurrentOption(option)
}
}
}, defaultSlot ? callSlot(defaultSlot, { option, $select: $xeselect }) : formatText(getFuncText(option[labelField as 'label']))) : null
})
}
const renderOptgroup = () => {
const { optionKey } = props
const { visibleGroupList } = reactData
const groupLabelField = computeGroupLabelField.value
const groupOptionsField = computeGroupOptionsField.value
return visibleGroupList.map((group, gIndex) => {
const { slots, className } = group
const optid = getOptid(group)
const isGroupDisabled = group.disabled
const defaultSlot = slots ? slots.default : null
return h('div', {
key: optionKey ? optid : gIndex,
class: ['vxe-optgroup', className ? (XEUtils.isFunction(className) ? className({ option: group, $select: $xeselect }) : className) : '', {
'is--disabled': isGroupDisabled
}],
// attrs
optid: optid
}, [
h('div', {
class: 'vxe-optgroup--title'
}, defaultSlot ? callSlot(defaultSlot, { option: group, $select: $xeselect }) : getFuncText(group[groupLabelField as 'label'])),
h('div', {
class: 'vxe-optgroup--wrapper'
}, renderOption(group[groupOptionsField as 'options'] || [], group))
])
})
}
const renderOpts = () => {
const { visibleGroupList, visibleOptionList } = reactData
const isGroup = computeIsGroup.value
if (isGroup) {
if (visibleGroupList.length) {
return renderOptgroup()
}
} else {
if (visibleOptionList.length) {
return renderOption(visibleOptionList)
}
}
return [
h('div', {
class: 'vxe-select--empty-placeholder'
}, props.emptyText || GlobalConfig.i18n('vxe.select.emptyText'))
]
}
selectMethods = {
dispatchEvent (type, params, evnt) {
emit(type, Object.assign({ $select: $xeselect, $event: evnt }, params))
},
isPanelVisible () {
return reactData.visiblePanel
},
togglePanel () {
if (reactData.visiblePanel) {
hideOptionPanel()
} else {
showOptionPanel()
}
return nextTick()
},
hidePanel () {
if (reactData.visiblePanel) {
hideOptionPanel()
}
return nextTick()
},
showPanel () {
if (!reactData.visiblePanel) {
showOptionPanel()
}
return nextTick()
},
refreshOption,
focus () {
const $input = refInput.value
reactData.isActivated = true
$input.blur()
return nextTick()
},
blur () {
const $input = refInput.value
$input.blur()
reactData.isActivated = false
return nextTick()
}
}
Object.assign($xeselect, selectMethods)
watch(() => reactData.staticOptions, (value) => {
if (value.some((item) => item.options && item.options.length)) {
reactData.fullOptionList = []
reactData.fullGroupList = value
} else {
reactData.fullGroupList = []
reactData.fullOptionList = value || []
}
updateCache()
})
watch(() => props.options, (value) => {
reactData.fullGroupList = []
reactData.fullOptionList = value || []
updateCache()
})
watch(() => props.optionGroups, (value) => {
reactData.fullOptionList = []
reactData.fullGroupList = value || []
updateCache()
})
onMounted(() => {
nextTick(() => {
const { options, optionGroups } = props
if (optionGroups) {
reactData.fullGroupList = optionGroups
} else if (options) {
reactData.fullOptionList = options
}
updateCache()
})
GlobalEvent.on($xeselect, 'mousewheel', handleGlobalMousewheelEvent)
GlobalEvent.on($xeselect, 'mousedown', handleGlobalMousedownEvent)
GlobalEvent.on($xeselect, 'keydown', handleGlobalKeydownEvent)
GlobalEvent.on($xeselect, 'blur', handleGlobalBlurEvent)
})
onUnmounted(() => {
GlobalEvent.off($xeselect, 'mousewheel')
GlobalEvent.off($xeselect, 'mousedown')
GlobalEvent.off($xeselect, 'keydown')
GlobalEvent.off($xeselect, 'blur')
})
const renderVN = () => {
const { className, transfer, disabled, loading } = props
const { inited, isActivated, visiblePanel } = reactData
const vSize = computeSize.value
const selectLabel = computeSelectLabel.value
const prefixSlot = slots.prefix
return h('div', {
ref: refElem,
class: ['vxe-select', className ? (XEUtils.isFunction(className) ? className({ $select: $xeselect }) : className) : '', {
[`size--${vSize}`]: vSize,
'is--visivle': visiblePanel,
'is--disabled': disabled,
'is--loading': loading,
'is--active': isActivated
}]
}, [
h('div', {
class: 'vxe-select-slots',
ref: 'hideOption'
}, slots.default ? slots.default({}) : []),
h(resolveComponent('vxe-input') as ComponentOptions, {
ref: refInput,
clearable: props.clearable,
placeholder: props.placeholder,
readonly: true,
disabled: disabled,
type: 'text',
prefixIcon: props.prefixIcon,
suffixIcon: loading ? GlobalConfig.icon.SELECT_LOADED : (visiblePanel ? GlobalConfig.icon.SELECT_OPEN : GlobalConfig.icon.SELECT_CLOSE),
modelValue: selectLabel,
onClear: clearEvent,
onClick: togglePanelEvent,
onFocus: focusEvent,
onBlur: blurEvent,
onSuffixClick: togglePanelEvent
}, prefixSlot ? {
prefix: () => prefixSlot({})
} : {}),
h(Teleport, {
to: 'body',
disabled: transfer ? !inited : true
}, [
h('div', {
ref: refOptionPanel,
class: ['vxe-table--ignore-clear vxe-select--panel', {
[`size--${vSize}`]: vSize,
'is--transfer': transfer,
'animat--leave': !loading && reactData.animatVisible,
'animat--enter': !loading && visiblePanel
}],
placement: reactData.panelPlacement,
style: reactData.panelStyle
}, inited ? [
h('div', {
ref: refOptionWrapper,
class: 'vxe-select-option--wrapper'
}, renderOpts())
] : [])
])
])
}
$xeselect.renderVN = renderVN
provide('$xeselect', $xeselect)
return $xeselect
},
render () {
return this.renderVN()
}
})