-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e06549c
commit 577cd02
Showing
7 changed files
with
479 additions
and
277 deletions.
There are no files selected for viewing
264 changes: 7 additions & 257 deletions
264
packages/kotti-ui/source/kotti-field-select/KtFieldSingleSelectRemote.vue
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,276 +1,26 @@ | ||
| <template> | ||
| <div> | ||
| <div ref="tippyTriggerRef"> | ||
| <KtField | ||
| v-bind="{ field }" | ||
| class="kt-field-select kt-field-select--single-remote" | ||
| :getEmptyValue="() => null" | ||
| :helpTextSlot="$slots.helpText" | ||
| > | ||
| <input | ||
| v-bind="inputProps" | ||
| @blur="handleInputBlur" | ||
| @click="handleInputClick" | ||
| @focus="handleInputFocus" | ||
| @input="updateQuery" | ||
| /> | ||
|
|
||
| <template v-slot:actionIcon="{ classes, handleClear, showClear }"> | ||
| <ActionIconNext | ||
| v-bind="{ | ||
| classes, | ||
| handleClear, | ||
| isDropdownOpen, | ||
| showClear, | ||
| }" | ||
| /> | ||
| </template> | ||
| </KtField> | ||
| </div> | ||
|
|
||
| <div ref="tippyContentRef" class="kt-field-select--single-remote__tippy"> | ||
| <IconTextItem | ||
| v-for="(option, index) in modifiedOptions" | ||
| :key="index" | ||
| :dataTest="option.dataTest" | ||
| :isDisabled="option.isDisabled" | ||
| :isSelected="option.isSelected" | ||
| :label="option.label" | ||
| @click.stop="() => selectOption(option)" | ||
| /> | ||
| </div> | ||
| </div> | ||
| <GenericSelectField v-bind="props" isRemote /> | ||
| </template> | ||
|
|
||
| <script lang="ts"> | ||
| import { useTippy } from '@3yourmind/vue-use-tippy' | ||
| import { computed, defineComponent, ref, watch } from '@vue/composition-api' | ||
| import { castArray } from 'lodash' | ||
| import { roundArrow } from 'tippy.js' | ||
| import { defineComponent } from '@vue/composition-api' | ||
| import { KtField } from '../kotti-field' | ||
| import { useField } from '../kotti-field/hooks' | ||
| import { useForceUpdate } from '../kotti-field/hooks' | ||
| import { useTranslationNamespace } from '../kotti-i18n/hooks' | ||
| import IconTextItem from '../kotti-popover/components/IconTextItem.vue' | ||
| import { makeProps } from '../make-props' | ||
| import ActionIconNext from './components/ActionIconNext.vue' | ||
| import { KOTTI_FIELD_REMOTE_SELECT_SUPPORTS } from './constants' | ||
| import { KottiFieldSingleSelectRemote, Shared } from './types' | ||
| import { sameWidth } from './utils/tippy-utils' | ||
| const ARROW_HEIGHT = 7 | ||
| const NO_DATA = Symbol('NO_DATA') | ||
| const UPDATE_QUERY = 'update:query' | ||
| const isTippyOrInTippy = (element: Element, tippy: Element | null): boolean => { | ||
| if (tippy === null) return false | ||
| let currentElement = element | ||
| while (currentElement) { | ||
| if (currentElement.isSameNode(tippy)) return true | ||
| currentElement = currentElement?.parentElement | ||
| } | ||
| return false | ||
| } | ||
| const isEqualValue = ( | ||
| currentValue: KottiFieldSingleSelectRemote.Value, | ||
| newValue: KottiFieldSingleSelectRemote.Value, | ||
| ) => currentValue === newValue | ||
| type ModifiedOptions = Array< | ||
| Omit<Shared.Entry, 'value'> & { | ||
| isSelected: boolean | ||
| value: KottiFieldSingleSelectRemote.Value | symbol | ||
| } | ||
| > | ||
| import GenericSelectField from './components/GenericSelectField.vue' | ||
| import { KottiFieldSingleSelectRemote } from './types' | ||
| export default defineComponent<KottiFieldSingleSelectRemote.PropsInternal>({ | ||
| name: 'KtFieldSingleSelectRemote', | ||
| components: { | ||
| ActionIconNext, | ||
| IconTextItem, | ||
| KtField, | ||
| GenericSelectField, | ||
| }, | ||
| props: makeProps(KottiFieldSingleSelectRemote.propsSchema), | ||
| setup(props, { emit }) { | ||
| const field = useField<KottiFieldSingleSelectRemote.Value>({ | ||
| emit, | ||
| isEmpty: (value) => value === null, | ||
| props, | ||
| supports: KOTTI_FIELD_REMOTE_SELECT_SUPPORTS, | ||
| }) | ||
| const translations = useTranslationNamespace('KtFieldSelects') | ||
| const tippyTriggerRef = ref<Element | null>(null) | ||
| const tippyContentRef = ref<Element | null>(null) | ||
| // track in a ref because the `tippy.state.isShown` doesn’t immediately update | ||
| const isDropdownOpen = ref(false) | ||
| const { tippy } = useTippy( | ||
| tippyTriggerRef, | ||
| computed(() => ({ | ||
| appendTo: () => document.body, | ||
| arrow: roundArrow, | ||
| content: tippyContentRef.value, | ||
| // hides the tippy if we click-away from the tippy | ||
| hideOnClick: true, | ||
| interactive: true, | ||
| maxWidth: 'none', | ||
| offset: [0, ARROW_HEIGHT], | ||
| onShow: () => { | ||
| isDropdownOpen.value = true | ||
| }, | ||
| onHide: () => { | ||
| isDropdownOpen.value = false | ||
| }, | ||
| placement: 'bottom', | ||
| popperOptions: { | ||
| modifiers: [sameWidth], | ||
| }, | ||
| theme: 'light-border', | ||
| trigger: 'manual', | ||
| })), | ||
| ) | ||
| const isInputFocused = ref(false) | ||
| const selectedLabel = computed((): string | null => { | ||
| if (field.currentValue === null) return null | ||
| return ( | ||
| props.options.find((option) => option.value === field.currentValue) | ||
| ?.label ?? null | ||
| ) | ||
| }) | ||
| const { forceUpdateKey, forceUpdate } = useForceUpdate() | ||
| const setIsDropdownOpen = (showTippy: boolean) => { | ||
| if (!tippy.value) return | ||
| const tippys = castArray(tippy.value) | ||
| for (const tippy of tippys) { | ||
| if (showTippy) tippy.show() | ||
| else tippy.hide() | ||
| } | ||
| } | ||
| const isUserInteracting = computed( | ||
| () => isInputFocused.value || isDropdownOpen.value, | ||
| ) | ||
| watch(isUserInteracting, (newValue) => { | ||
| if (!newValue) emit(UPDATE_QUERY, null) | ||
| }) | ||
| return { | ||
| field, | ||
| handleInputBlur: (event: { relatedTarget: HTMLElement }) => { | ||
| const blurToElement = event.relatedTarget | ||
| if (!isTippyOrInTippy(blurToElement, tippyContentRef.value)) { | ||
| setIsDropdownOpen(false) | ||
| } | ||
| isInputFocused.value = false | ||
| }, | ||
| handleInputClick: () => { | ||
| // always show the dropdown if the input was clicked | ||
| setIsDropdownOpen(true) | ||
| }, | ||
| handleInputFocus: () => { | ||
| // always show the dropdown if the input was focused | ||
| setIsDropdownOpen(true) | ||
| isInputFocused.value = true | ||
| }, | ||
| inputProps: computed(() => ({ | ||
| class: ['kt-field-select--single-remote__wrapper'], | ||
| forceUpdateKey: forceUpdateKey.value, | ||
| placeholder: props.placeholder ?? undefined, | ||
| size: 1, | ||
| type: 'text', | ||
| value: (() => { | ||
| if (isUserInteracting.value) return props.query ?? undefined | ||
| return selectedLabel.value ?? undefined | ||
| })(), | ||
| })), | ||
| isDropdownOpen, | ||
| modifiedOptions: computed<ModifiedOptions>(() => | ||
| props.options.length > 0 | ||
| ? props.options.map((option) => ({ | ||
| // Vetur parses Shared.Entry['value'] as optional | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| ...(option as any), | ||
| isDisabled: (field.isDisabled || option.isDisabled) ?? false, | ||
| isSelected: isEqualValue(field.currentValue, option.value), | ||
| })) | ||
| : [ | ||
| { | ||
| dataTest: String(NO_DATA), | ||
| isDisabled: true, | ||
| isSelected: false, | ||
| label: translations.value.noDataText, | ||
| value: NO_DATA, | ||
| }, | ||
| ], | ||
| ), | ||
| tippyTriggerRef, | ||
| tippyContentRef, | ||
| selectOption: ( | ||
| option: KottiFieldSingleSelectRemote.Props['options'][number], | ||
| ) => { | ||
| // ignore disabled options | ||
| if (option.isDisabled) return | ||
| // optimization: no need to change the value if it’s already set | ||
| if (!isEqualValue(field.currentValue, option.value)) | ||
| field.setValue(option.value) | ||
| // close the tippy instance whenever a selection is made | ||
| setIsDropdownOpen(false) | ||
| // when a selection is made, intentionally reset the query | ||
| // so that the api-call (for example) can already trigger | ||
| // and load the non-filtered options | ||
| emit(UPDATE_QUERY, null) | ||
| }, | ||
| updateQuery: (event: { target: HTMLInputElement }) => { | ||
| const newValue = event.target.value | ||
| emit(UPDATE_QUERY, newValue === '' ? null : newValue) | ||
| forceUpdate() | ||
| }, | ||
| onEmit: emit, | ||
| props, | ||
| } | ||
| }, | ||
| }) | ||
| </script> | ||
|
|
||
| <style lang="scss" scoped> | ||
| .kt-field-select--single-remote { | ||
| &__wrapper { | ||
| display: flex; | ||
| width: 100%; | ||
| padding: 0; | ||
| margin: 0; | ||
| line-height: 1.6; | ||
| border: 0; | ||
| } | ||
| &__tippy { | ||
| max-height: 40vh; | ||
| /* | ||
| undo padding from theme, | ||
| alternatively fork theme and remove the left/right padding | ||
| */ | ||
| margin-right: -9px; | ||
| margin-left: -9px; | ||
| overflow-y: auto; | ||
| } | ||
| } | ||
| </style> |
Oops, something went wrong.