mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-14 20:19:34 +01:00
321 lines
12 KiB
Vue
321 lines
12 KiB
Vue
<script lang="ts">
|
|
import type { InputHTMLAttributes } from 'vue'
|
|
import { tv, type VariantProps } from 'tailwind-variants'
|
|
import type { ComboboxRootProps, ComboboxRootEmits, ComboboxContentProps, ComboboxItemProps, ComboboxArrowProps } from 'radix-vue'
|
|
import type { AppConfig } from '@nuxt/schema'
|
|
import _appConfig from '#build/app.config'
|
|
import theme from '#build/ui/input-menu'
|
|
import type { UseComponentIconsProps } from '../composables/useComponentIcons'
|
|
import type { AvatarProps, ChipProps, InputProps } from '../types'
|
|
import type { AcceptableValue, ArrayOrWrapped } from '../types/utils'
|
|
|
|
const appConfig = _appConfig as AppConfig & { ui: { inputMenu: Partial<typeof theme> } }
|
|
|
|
const inputMenu = tv({ extend: tv(theme), ...(appConfig.ui?.inputMenu || {}) })
|
|
|
|
export interface InputMenuItem extends Pick<ComboboxItemProps, 'disabled'> {
|
|
label?: string
|
|
icon?: string
|
|
avatar?: AvatarProps
|
|
chip?: ChipProps
|
|
/**
|
|
* The item type.
|
|
* @defaultValue 'item'
|
|
*/
|
|
type?: 'label' | 'separator' | 'item'
|
|
}
|
|
|
|
type InputMenuVariants = VariantProps<typeof inputMenu>
|
|
|
|
export interface InputMenuProps<T> extends Pick<ComboboxRootProps<T>, 'modelValue' | 'defaultValue' | 'open' | 'defaultOpen' | 'searchTerm' | 'multiple' | 'disabled' | 'name' | 'resetSearchTermOnBlur'>, UseComponentIconsProps {
|
|
/**
|
|
* The element or component this component should render as.
|
|
* @defaultValue 'div'
|
|
*/
|
|
as?: any
|
|
id?: string
|
|
type?: InputHTMLAttributes['type']
|
|
/** The placeholder text when the input is empty. */
|
|
placeholder?: string
|
|
color?: InputMenuVariants['color']
|
|
variant?: InputMenuVariants['variant']
|
|
size?: InputMenuVariants['size']
|
|
required?: boolean
|
|
autofocus?: boolean
|
|
autofocusDelay?: number
|
|
/**
|
|
* The icon displayed to open the menu.
|
|
* @defaultValue appConfig.ui.icons.chevronDown
|
|
*/
|
|
trailingIcon?: string
|
|
/**
|
|
* The icon displayed when an item is selected.
|
|
* @defaultValue appConfig.ui.icons.check
|
|
*/
|
|
selectedIcon?: string
|
|
/**
|
|
* The icon displayed to delete a tag.
|
|
* Works only when `multiple` is `true`.
|
|
* @defaultValue appConfig.ui.icons.close
|
|
*/
|
|
deleteIcon?: string
|
|
/**
|
|
* The content of the menu.
|
|
* @defaultValue { side: 'bottom', sideOffset: 8, position: 'popper' }
|
|
*/
|
|
content?: Omit<ComboboxContentProps, 'as' | 'asChild' | 'forceMount'>
|
|
/**
|
|
* Display an arrow alongside the menu.
|
|
* @defaultValue false
|
|
*/
|
|
arrow?: boolean | Omit<ComboboxArrowProps, 'as' | 'asChild'>
|
|
/**
|
|
* Render the menu in a portal.
|
|
* @defaultValue true
|
|
*/
|
|
portal?: boolean
|
|
/**
|
|
* Whether to filter items or not, can be an array of fields to filter.
|
|
* When `false`, items will not be filtered which is useful for custom filtering.
|
|
* @defaultValue ['label']
|
|
*/
|
|
filter?: boolean | string[]
|
|
items?: T[] | T[][]
|
|
class?: any
|
|
ui?: Partial<typeof inputMenu.slots>
|
|
}
|
|
|
|
export type InputMenuEmits<T> = ComboboxRootEmits<T>
|
|
|
|
type SlotProps<T> = (props: { item: T, index: number }) => any
|
|
|
|
export type InputMenuSlots<T> = {
|
|
'leading'(props: { modelValue: T, open: boolean }): any
|
|
'trailing'(props: { modelValue: T, open: boolean }): any
|
|
'empty'(props: { searchTerm?: string }): any
|
|
'item': SlotProps<T>
|
|
'item-leading': SlotProps<T>
|
|
'item-label': SlotProps<T>
|
|
'item-trailing': SlotProps<T>
|
|
'tags-item-text': SlotProps<T>
|
|
'tags-item-delete': SlotProps<T>
|
|
}
|
|
</script>
|
|
|
|
<script setup lang="ts" generic="T extends InputMenuItem | AcceptableValue">
|
|
import { computed, ref, toRef, onMounted } from 'vue'
|
|
import { ComboboxRoot, ComboboxAnchor, ComboboxInput, ComboboxTrigger, ComboboxPortal, ComboboxContent, ComboboxViewport, ComboboxEmpty, ComboboxGroup, ComboboxLabel, ComboboxSeparator, ComboboxItem, ComboboxItemIndicator, TagsInputRoot, TagsInputItem, TagsInputItemText, TagsInputItemDelete, TagsInputInput, useForwardPropsEmits } from 'radix-vue'
|
|
import { defu } from 'defu'
|
|
import { reactivePick } from '@vueuse/core'
|
|
import { useAppConfig, useFormField, useButtonGroup, useComponentIcons } from '#imports'
|
|
import { UIcon, UChip, UAvatar } from '#components'
|
|
import { get } from '../utils'
|
|
|
|
defineOptions({ inheritAttrs: false })
|
|
|
|
const props = withDefaults(defineProps<InputMenuProps<T>>(), {
|
|
type: 'text',
|
|
autofocusDelay: 0,
|
|
portal: true,
|
|
filter: () => ['label']
|
|
})
|
|
const emits = defineEmits<InputMenuEmits<T>>()
|
|
const slots = defineSlots<InputMenuSlots<T>>()
|
|
|
|
const searchTerm = defineModel<string>('searchTerm', { default: '' })
|
|
|
|
const appConfig = useAppConfig()
|
|
const rootProps = useForwardPropsEmits(reactivePick(props, 'as', 'modelValue', 'defaultValue', 'open', 'defaultOpen', 'multiple', 'resetSearchTermOnBlur'), emits)
|
|
const contentProps = toRef(() => defu(props.content, { side: 'bottom', sideOffset: 8, position: 'popper' }) as ComboboxContentProps)
|
|
const { emitFormBlur, emitFormChange, size: formGroupSize, color, id, name, disabled } = useFormField<InputProps>(props)
|
|
const { orientation, size: buttonGroupSize } = useButtonGroup<InputProps>(props)
|
|
const { isLeading, isTrailing, leadingIconName, trailingIconName } = useComponentIcons(toRef(() => defu(props, { trailingIcon: appConfig.ui.icons.chevronDown })))
|
|
|
|
const inputSize = computed(() => buttonGroupSize.value || formGroupSize.value)
|
|
|
|
const ui = computed(() => tv({ extend: inputMenu, slots: props.ui })({
|
|
color: color.value,
|
|
variant: props.variant,
|
|
size: inputSize?.value,
|
|
loading: props.loading,
|
|
leading: isLeading.value || !!slots.leading,
|
|
trailing: isTrailing.value || !!slots.trailing,
|
|
multiple: props.multiple,
|
|
buttonGroup: orientation.value
|
|
}))
|
|
|
|
function displayValue(val: AcceptableValue) {
|
|
if (typeof val === 'object') {
|
|
return val.label
|
|
}
|
|
|
|
return val && String(val)
|
|
}
|
|
|
|
function filterFunction(items: ArrayOrWrapped<AcceptableValue>, searchTerm: string): ArrayOrWrapped<AcceptableValue> {
|
|
if (props.filter === false) {
|
|
return items
|
|
}
|
|
|
|
const fields = Array.isArray(props.filter) ? props.filter : ['label']
|
|
|
|
return items.filter((item) => {
|
|
if (typeof item !== 'object') {
|
|
return String(item).search(new RegExp(searchTerm, 'i')) !== -1
|
|
}
|
|
|
|
return fields.some((field) => {
|
|
const child = get(item, field)
|
|
|
|
return child !== null && child !== undefined && String(child).search(new RegExp(searchTerm, 'i')) !== -1
|
|
})
|
|
}) as ArrayOrWrapped<T>
|
|
}
|
|
|
|
const groups = computed(() => props.items?.length ? (Array.isArray(props.items[0]) ? props.items : [props.items]) as InputMenuItem[][] : [])
|
|
|
|
const inputRef = ref<InstanceType<typeof ComboboxInput> | null>(null)
|
|
|
|
function autoFocus() {
|
|
if (props.autofocus) {
|
|
inputRef.value?.$el?.focus()
|
|
}
|
|
}
|
|
|
|
onMounted(() => {
|
|
setTimeout(() => {
|
|
autoFocus()
|
|
}, props.autofocusDelay)
|
|
})
|
|
</script>
|
|
|
|
<template>
|
|
<ComboboxRoot
|
|
:id="id"
|
|
v-slot="{ modelValue, open }"
|
|
v-bind="rootProps"
|
|
v-model:search-term="searchTerm"
|
|
:name="name"
|
|
:disabled="disabled"
|
|
:display-value="displayValue"
|
|
:filter-function="filterFunction"
|
|
:class="ui.root({ class: props.class })"
|
|
:as-child="!!multiple"
|
|
@update:model-value="emitFormChange()"
|
|
@keydown.enter="$event.preventDefault()"
|
|
>
|
|
<ComboboxAnchor :as-child="!multiple" :class="ui.base()">
|
|
<TagsInputRoot
|
|
v-if="multiple"
|
|
v-slot="{ modelValue: tags }: { modelValue: AcceptableValue[] }"
|
|
:model-value="(modelValue as string[])"
|
|
:disabled="disabled"
|
|
delimiter=""
|
|
as-child
|
|
@blur="emitFormBlur()"
|
|
>
|
|
<TagsInputItem v-for="(item, index) in tags" :key="index" :value="(item as string)" :class="ui.tagsItem()">
|
|
<TagsInputItemText :class="ui.tagsItemText()">
|
|
<slot name="tags-item-text" :item="(item as T)" :index="index">
|
|
{{ typeof item === 'object' ? item.label : item }}
|
|
</slot>
|
|
</TagsInputItemText>
|
|
|
|
<TagsInputItemDelete :class="ui.tagsItemDelete()" :disabled="disabled">
|
|
<slot name="tags-item-delete" :item="(item as T)" :index="index">
|
|
<UIcon :name="deleteIcon || appConfig.ui.icons.close" :class="ui.tagsItemDeleteIcon()" />
|
|
</slot>
|
|
</TagsInputItemDelete>
|
|
</TagsInputItem>
|
|
|
|
<ComboboxInput as-child>
|
|
<TagsInputInput
|
|
ref="inputRef"
|
|
v-bind="$attrs"
|
|
:placeholder="placeholder"
|
|
:required="required"
|
|
:class="ui.tagsInput()"
|
|
@keydown.enter.prevent
|
|
/>
|
|
</ComboboxInput>
|
|
</TagsInputRoot>
|
|
|
|
<ComboboxInput
|
|
v-else
|
|
ref="inputRef"
|
|
v-bind="$attrs"
|
|
:type="type"
|
|
:placeholder="placeholder"
|
|
:required="required"
|
|
:class="ui.base()"
|
|
@blur="emitFormBlur()"
|
|
/>
|
|
|
|
<span v-if="isLeading || !!slots.leading" :class="ui.leading()">
|
|
<slot name="leading" :model-value="(modelValue as T)" :open="open">
|
|
<UIcon v-if="leadingIconName" :name="leadingIconName" :class="ui.leadingIcon()" />
|
|
</slot>
|
|
</span>
|
|
|
|
<ComboboxTrigger v-if="isTrailing || !!slots.trailing" :class="ui.trailing()">
|
|
<slot name="trailing" :model-value="(modelValue as T)" :open="open">
|
|
<UIcon v-if="trailingIconName" :name="trailingIconName" :class="ui.trailingIcon()" />
|
|
</slot>
|
|
</ComboboxTrigger>
|
|
</ComboboxAnchor>
|
|
|
|
<ComboboxPortal :disabled="!portal">
|
|
<ComboboxContent :class="ui.content()" v-bind="contentProps">
|
|
<ComboboxEmpty :class="ui.empty()">
|
|
<slot name="empty" :search-term="searchTerm">
|
|
{{ searchTerm ? `No results for ${searchTerm}` : 'No results' }}
|
|
</slot>
|
|
</ComboboxEmpty>
|
|
|
|
<ComboboxViewport :class="ui.viewport()">
|
|
<ComboboxGroup v-for="(group, groupIndex) in groups" :key="`group-${groupIndex}`" :class="ui.group()">
|
|
<template v-for="(item, index) in group" :key="`group-${groupIndex}-${index}`">
|
|
<ComboboxLabel v-if="item?.type === 'label'" :class="ui.label()">
|
|
{{ item.label }}
|
|
</ComboboxLabel>
|
|
|
|
<ComboboxSeparator v-else-if="item?.type === 'separator'" :class="ui.separator()" />
|
|
|
|
<ComboboxItem v-else :class="ui.item()" :disabled="item.disabled" :value="item">
|
|
<slot name="item" :item="(item as T)" :index="index">
|
|
<slot name="item-leading" :item="(item as T)" :index="index">
|
|
<UAvatar v-if="item.avatar" size="2xs" v-bind="item.avatar" :class="ui.itemLeadingAvatar()" />
|
|
<UIcon v-else-if="item.icon" :name="item.icon" :class="ui.itemLeadingIcon()" />
|
|
<UChip
|
|
v-else-if="item.chip"
|
|
size="md"
|
|
inset
|
|
standalone
|
|
v-bind="item.chip"
|
|
:class="ui.itemLeadingChip()"
|
|
/>
|
|
</slot>
|
|
|
|
<span :class="ui.itemLabel()">
|
|
<slot name="item-label" :item="(item as T)" :index="index">
|
|
{{ displayValue(item as T) }}
|
|
</slot>
|
|
</span>
|
|
|
|
<span :class="ui.itemTrailing()">
|
|
<slot name="item-trailing" :item="(item as T)" :index="index" />
|
|
|
|
<ComboboxItemIndicator as-child>
|
|
<UIcon :name="selectedIcon || appConfig.ui.icons.check" :class="ui.itemTrailingSelectedIcon()" />
|
|
</ComboboxItemIndicator>
|
|
</span>
|
|
</slot>
|
|
</ComboboxItem>
|
|
</template>
|
|
</ComboboxGroup>
|
|
</ComboboxViewport>
|
|
</ComboboxContent>
|
|
</ComboboxPortal>
|
|
</ComboboxRoot>
|
|
</template>
|