@nuxt/ui
Version:
A UI Library for Modern Web Apps, powered by Vue & Tailwind CSS.
229 lines (228 loc) • 9.6 kB
TypeScript
import type { ComboboxRootProps, ComboboxRootEmits, ComboboxContentProps, ComboboxContentEmits, ComboboxArrowProps } from 'reka-ui';
import type { AppConfig } from '@nuxt/schema';
import theme from '#build/ui/select-menu';
import type { UseComponentIconsProps } from '../composables/useComponentIcons';
import type { AvatarProps, ChipProps, IconProps, InputProps } from '../types';
import type { ModelModifiers } from '../types/input';
import type { ButtonHTMLAttributes } from '../types/html';
import type { AcceptableValue, ArrayOrNested, GetItemKeys, GetModelValue, GetModelValueEmits, NestedItem, EmitsToProps } from '../types/utils';
import type { ComponentConfig } from '../types/tv';
type SelectMenu = ComponentConfig<typeof theme, AppConfig, 'selectMenu'>;
export type SelectMenuValue = AcceptableValue;
export type SelectMenuItem = SelectMenuValue | {
label?: string;
description?: string;
/**
* @IconifyIcon
*/
icon?: IconProps['name'];
avatar?: AvatarProps;
chip?: ChipProps;
/**
* The item type.
* @defaultValue 'item'
*/
type?: 'label' | 'separator' | 'item';
disabled?: boolean;
onSelect?: (e: Event) => void;
class?: any;
ui?: Pick<SelectMenu['slots'], 'label' | 'separator' | 'item' | 'itemLeadingIcon' | 'itemLeadingAvatarSize' | 'itemLeadingAvatar' | 'itemLeadingChipSize' | 'itemLeadingChip' | 'itemWrapper' | 'itemLabel' | 'itemDescription' | 'itemTrailing' | 'itemTrailingIcon'>;
[key: string]: any;
};
export interface SelectMenuProps<T extends ArrayOrNested<SelectMenuItem> = ArrayOrNested<SelectMenuItem>, VK extends GetItemKeys<T> | undefined = undefined, M extends boolean = false> extends Pick<ComboboxRootProps<T>, 'open' | 'defaultOpen' | 'disabled' | 'name' | 'resetSearchTermOnBlur' | 'resetSearchTermOnSelect' | 'highlightOnHover'>, UseComponentIconsProps, /** @vue-ignore */ Omit<ButtonHTMLAttributes, 'type' | 'disabled' | 'name'> {
id?: string;
/** The placeholder text when the select is empty. */
placeholder?: string;
/**
* Whether to display the search input or not.
* Can be an object to pass additional props to the input.
* `{ placeholder: 'Search...', variant: 'none' }`{lang="ts-type"}
* @defaultValue true
*/
searchInput?: boolean | InputProps;
/**
* @defaultValue 'primary'
*/
color?: SelectMenu['variants']['color'];
/**
* @defaultValue 'outline'
*/
variant?: SelectMenu['variants']['variant'];
/**
* @defaultValue 'md'
*/
size?: SelectMenu['variants']['size'];
required?: boolean;
/**
* The icon displayed to open the menu.
* @defaultValue appConfig.ui.icons.chevronDown
* @IconifyIcon
*/
trailingIcon?: IconProps['name'];
/**
* The icon displayed when an item is selected.
* @defaultValue appConfig.ui.icons.check
* @IconifyIcon
*/
selectedIcon?: IconProps['name'];
/**
* The content of the menu.
* @defaultValue { side: 'bottom', sideOffset: 8, collisionPadding: 8, position: 'popper' }
*/
content?: Omit<ComboboxContentProps, 'as' | 'asChild' | 'forceMount'> & Partial<EmitsToProps<ComboboxContentEmits>>;
/**
* Display an arrow alongside the menu.
* @defaultValue false
* @IconifyIcon
*/
arrow?: boolean | Omit<ComboboxArrowProps, 'as' | 'asChild'>;
/**
* Render the menu in a portal.
* @defaultValue true
*/
portal?: boolean | string | HTMLElement;
/**
* Enable virtualization for large lists.
* Note: when enabled, all groups are flattened into a single list due to a limitation of Reka UI (https://github.com/unovue/reka-ui/issues/1885).
* @defaultValue false
*/
virtualize?: boolean | {
/**
* Number of items rendered outside the visible area
* @defaultValue 12
*/
overscan?: number;
/**
* Estimated size (in px) of each item
* @defaultValue 32
*/
estimateSize?: number;
};
/**
* When `items` is an array of objects, select the field to use as the value instead of the object itself.
* @defaultValue undefined
*/
valueKey?: VK;
/**
* When `items` is an array of objects, select the field to use as the label.
* @defaultValue 'label'
*/
labelKey?: GetItemKeys<T>;
/**
* When `items` is an array of objects, select the field to use as the description.
* @defaultValue 'description'
*/
descriptionKey?: GetItemKeys<T>;
items?: T;
/** The value of the SelectMenu when initially rendered. Use when you do not need to control the state of the SelectMenu. */
defaultValue?: GetModelValue<T, VK, M>;
/** The controlled value of the SelectMenu. Can be binded-with with `v-model`. */
modelValue?: GetModelValue<T, VK, M>;
modelModifiers?: Omit<ModelModifiers<GetModelValue<T, VK, M>>, 'lazy'>;
/** Whether multiple options can be selected or not. */
multiple?: M & boolean;
/** Highlight the ring color like a focus state. */
highlight?: boolean;
/**
* Determines if custom user input that does not exist in options can be added.
* @defaultValue false
*/
createItem?: boolean | 'always' | {
position?: 'top' | 'bottom';
when?: 'empty' | 'always';
};
/**
* Fields to filter items by.
* @defaultValue [labelKey]
*/
filterFields?: string[];
/**
* When `true`, disable the default filters, useful for custom filtering (useAsyncData, useFetch, etc.).
* @defaultValue false
*/
ignoreFilter?: boolean;
autofocus?: boolean;
autofocusDelay?: number;
class?: any;
ui?: SelectMenu['slots'];
}
export type SelectMenuEmits<A extends ArrayOrNested<SelectMenuItem>, VK extends GetItemKeys<A> | undefined, M extends boolean> = Pick<ComboboxRootEmits, 'update:open'> & {
change: [event: Event];
blur: [event: FocusEvent];
focus: [event: FocusEvent];
create: [item: string];
/** Event handler when highlighted element changes. */
highlight: [
payload: {
ref: HTMLElement;
value: GetModelValue<A, VK, M>;
} | undefined
];
} & GetModelValueEmits<A, VK, M>;
type SlotProps<T extends SelectMenuItem> = (props: {
item: T;
index: number;
ui: SelectMenu['ui'];
}) => any;
export interface SelectMenuSlots<A extends ArrayOrNested<SelectMenuItem> = ArrayOrNested<SelectMenuItem>, VK extends GetItemKeys<A> | undefined = undefined, M extends boolean = false, T extends NestedItem<A> = NestedItem<A>> {
'leading'(props: {
modelValue?: GetModelValue<A, VK, M>;
open: boolean;
ui: SelectMenu['ui'];
}): any;
'default'(props: {
modelValue?: GetModelValue<A, VK, M>;
open: boolean;
ui: SelectMenu['ui'];
}): any;
'trailing'(props: {
modelValue?: GetModelValue<A, VK, M>;
open: boolean;
ui: SelectMenu['ui'];
}): any;
'empty'(props: {
searchTerm?: string;
}): any;
'item': SlotProps<T>;
'item-leading': SlotProps<T>;
'item-label'(props: {
item: T;
index: number;
}): any;
'item-description'(props: {
item: T;
index: number;
}): any;
'item-trailing': SlotProps<T>;
'content-top': (props?: {}) => any;
'content-bottom': (props?: {}) => any;
'create-item-label'(props: {
item: string;
}): any;
}
declare const __VLS_export: <T extends ArrayOrNested<SelectMenuItem>, VK extends GetItemKeys<T> | undefined = undefined, M extends boolean = false>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
props: __VLS_PrettifyLocal<(SelectMenuProps<T, VK, M> & {
searchTerm?: string;
}) & __VLS_EmitsToProps<__VLS_NormalizeEmits<((evt: "blur", event: FocusEvent) => void) & ((evt: "change", event: Event) => void) & ((evt: "focus", event: FocusEvent) => void) & ((evt: "update:open", value: boolean) => void) & ((evt: "create", item: string) => void) & ((evt: "update:modelValue", value: GetModelValue<T, VK, M>) => void) & ((evt: "highlight", payload: {
ref: HTMLElement;
value: GetModelValue<T, VK, M>;
} | undefined) => void) & ((evt: "update:searchTerm", value: string) => void)>>> & import("vue").PublicProps & (typeof globalThis extends {
__VLS_PROPS_FALLBACK: infer P;
} ? P : {});
expose: (exposed: import("vue").ShallowUnwrapRef<{
triggerRef: Readonly<import("vue").Ref<HTMLButtonElement, HTMLButtonElement>>;
}>) => void;
attrs: any;
slots: SelectMenuSlots<T, VK, M, NestedItem<T>>;
emit: (((evt: "blur", event: FocusEvent) => void) & ((evt: "change", event: Event) => void) & ((evt: "focus", event: FocusEvent) => void) & ((evt: "update:open", value: boolean) => void) & ((evt: "create", item: string) => void) & ((evt: "update:modelValue", value: GetModelValue<T, VK, M>) => void) & ((evt: "highlight", payload: {
ref: HTMLElement;
value: GetModelValue<T, VK, M>;
} | undefined) => void)) & ((evt: "update:searchTerm", value: string) => void);
}>) => import("vue").VNode & {
__ctx?: Awaited<typeof __VLS_setup>;
};
declare const _default: typeof __VLS_export;
export default _default;
type __VLS_PrettifyLocal<T> = {
[K in keyof T as K]: T[K];
} & {};