UNPKG

@bitrix24/b24ui-nuxt

Version:

Bitrix24 UI-Kit for developing web applications REST API for NUXT & VUE

1,299 lines (1,298 loc) 33.6 kB
import type { VariantProps } from 'tailwind-variants'; import type { ComboboxRootProps, ComboboxRootEmits, ComboboxContentProps, ComboboxContentEmits, ComboboxArrowProps } from 'reka-ui'; import type { UseComponentIconsProps } from '../composables/useComponentIcons'; import type { AvatarProps, ChipProps, InputProps, IconComponent } from '../types'; import type { AcceptableValue, ArrayOrNested, GetItemKeys, GetModelValue, GetModelValueEmits, NestedItem, PartialString, EmitsToProps } from '../types/utils'; declare const selectMenu: import("tailwind-variants").TVReturnType<{ buttonGroup: { horizontal: { root: string; base: string; }; vertical: { root: string; base: string; }; }; noSplit: { false: string; }; size: { xs: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; sm: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; md: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; lg: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; }; color: { default: string; danger: string; success: string; warning: string; primary: string; secondary: string; collab: string; ai: string; }; tagColor: { default: { tag: string; }; danger: { tag: string; }; success: { tag: string; }; warning: { tag: string; }; primary: { tag: string; }; secondary: { tag: string; }; collab: { tag: string; }; ai: { tag: string; }; }; rounded: { true: string; false: string; }; noPadding: { true: { base: string; }; }; noBorder: { true: string; }; underline: { true: string; }; leading: { true: string; }; trailing: { true: string; }; loading: { true: string; }; highlight: { true: string; }; type: { file: string; }; colorItem: { default: string; danger: { item: string; itemLeadingIcon: string; }; success: { item: string; itemLeadingIcon: string; }; warning: { item: string; itemLeadingIcon: string; }; primary: { item: string; itemLeadingIcon: string; }; secondary: { item: string; itemLeadingIcon: string; }; collab: { item: string; itemLeadingIcon: string; }; ai: { item: string; itemLeadingIcon: string; }; }; addNew: { true: { group: string; item: string; itemLabel: string; itemLeadingIcon: string; }; }; }, { root: string; base: string; leading: string; leadingIcon: string; leadingAvatar: string; leadingAvatarSize: string; trailing: string; trailingIcon: string; tag: string; value: string; placeholder: string; arrow: string; content: string; scrollUpDownButton: string; scrollUpDownButtonIcon: string; viewport: string; group: string; empty: string; label: string; separator: string; item: string; itemLeadingIcon: string; itemLeadingAvatar: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailing: string; itemTrailingIcon: string; itemLabel: string; input: string; focusScope: string; }, undefined, { buttonGroup: { horizontal: { root: string; base: string; }; vertical: { root: string; base: string; }; }; noSplit: { false: string; }; size: { xs: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; sm: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; md: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; lg: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; }; color: { default: string; danger: string; success: string; warning: string; primary: string; secondary: string; collab: string; ai: string; }; tagColor: { default: { tag: string; }; danger: { tag: string; }; success: { tag: string; }; warning: { tag: string; }; primary: { tag: string; }; secondary: { tag: string; }; collab: { tag: string; }; ai: { tag: string; }; }; rounded: { true: string; false: string; }; noPadding: { true: { base: string; }; }; noBorder: { true: string; }; underline: { true: string; }; leading: { true: string; }; trailing: { true: string; }; loading: { true: string; }; highlight: { true: string; }; type: { file: string; }; colorItem: { default: string; danger: { item: string; itemLeadingIcon: string; }; success: { item: string; itemLeadingIcon: string; }; warning: { item: string; itemLeadingIcon: string; }; primary: { item: string; itemLeadingIcon: string; }; secondary: { item: string; itemLeadingIcon: string; }; collab: { item: string; itemLeadingIcon: string; }; ai: { item: string; itemLeadingIcon: string; }; }; addNew: { true: { group: string; item: string; itemLabel: string; itemLeadingIcon: string; }; }; }, { root: string; base: string; leading: string; leadingIcon: string; leadingAvatar: string; leadingAvatarSize: string; trailing: string; trailingIcon: string; tag: string; value: string; placeholder: string; arrow: string; content: string; scrollUpDownButton: string; scrollUpDownButtonIcon: string; viewport: string; group: string; empty: string; label: string; separator: string; item: string; itemLeadingIcon: string; itemLeadingAvatar: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailing: string; itemTrailingIcon: string; itemLabel: string; input: string; focusScope: string; }, import("tailwind-variants").TVReturnType<{ buttonGroup: { horizontal: { root: string; base: string; }; vertical: { root: string; base: string; }; }; noSplit: { false: string; }; size: { xs: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; sm: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; md: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; lg: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; }; color: { default: string; danger: string; success: string; warning: string; primary: string; secondary: string; collab: string; ai: string; }; tagColor: { default: { tag: string; }; danger: { tag: string; }; success: { tag: string; }; warning: { tag: string; }; primary: { tag: string; }; secondary: { tag: string; }; collab: { tag: string; }; ai: { tag: string; }; }; rounded: { true: string; false: string; }; noPadding: { true: { base: string; }; }; noBorder: { true: string; }; underline: { true: string; }; leading: { true: string; }; trailing: { true: string; }; loading: { true: string; }; highlight: { true: string; }; type: { file: string; }; colorItem: { default: string; danger: { item: string; itemLeadingIcon: string; }; success: { item: string; itemLeadingIcon: string; }; warning: { item: string; itemLeadingIcon: string; }; primary: { item: string; itemLeadingIcon: string; }; secondary: { item: string; itemLeadingIcon: string; }; collab: { item: string; itemLeadingIcon: string; }; ai: { item: string; itemLeadingIcon: string; }; }; addNew: { true: { group: string; item: string; itemLabel: string; itemLeadingIcon: string; }; }; }, { root: string; base: string; leading: string; leadingIcon: string; leadingAvatar: string; leadingAvatarSize: string; trailing: string; trailingIcon: string; tag: string; value: string; placeholder: string; arrow: string; content: string; scrollUpDownButton: string; scrollUpDownButtonIcon: string; viewport: string; group: string; empty: string; label: string; separator: string; item: string; itemLeadingIcon: string; itemLeadingAvatar: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailing: string; itemTrailingIcon: string; itemLabel: string; input: string; focusScope: string; }, undefined, { buttonGroup: { horizontal: { root: string; base: string; }; vertical: { root: string; base: string; }; }; noSplit: { false: string; }; size: { xs: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; sm: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; md: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; lg: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; }; color: { default: string; danger: string; success: string; warning: string; primary: string; secondary: string; collab: string; ai: string; }; tagColor: { default: { tag: string; }; danger: { tag: string; }; success: { tag: string; }; warning: { tag: string; }; primary: { tag: string; }; secondary: { tag: string; }; collab: { tag: string; }; ai: { tag: string; }; }; rounded: { true: string; false: string; }; noPadding: { true: { base: string; }; }; noBorder: { true: string; }; underline: { true: string; }; leading: { true: string; }; trailing: { true: string; }; loading: { true: string; }; highlight: { true: string; }; type: { file: string; }; colorItem: { default: string; danger: { item: string; itemLeadingIcon: string; }; success: { item: string; itemLeadingIcon: string; }; warning: { item: string; itemLeadingIcon: string; }; primary: { item: string; itemLeadingIcon: string; }; secondary: { item: string; itemLeadingIcon: string; }; collab: { item: string; itemLeadingIcon: string; }; ai: { item: string; itemLeadingIcon: string; }; }; addNew: { true: { group: string; item: string; itemLabel: string; itemLeadingIcon: string; }; }; }, { root: string; base: string; leading: string; leadingIcon: string; leadingAvatar: string; leadingAvatarSize: string; trailing: string; trailingIcon: string; tag: string; value: string; placeholder: string; arrow: string; content: string; scrollUpDownButton: string; scrollUpDownButtonIcon: string; viewport: string; group: string; empty: string; label: string; separator: string; item: string; itemLeadingIcon: string; itemLeadingAvatar: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailing: string; itemTrailingIcon: string; itemLabel: string; input: string; focusScope: string; }, import("tailwind-variants").TVReturnType<{ buttonGroup: { horizontal: { root: string; base: string; }; vertical: { root: string; base: string; }; }; noSplit: { false: string; }; size: { xs: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; sm: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; md: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; lg: { base: string; leading: string; trailing: string; leadingIcon: string; leadingAvatarSize: string; trailingIcon: string; label: string; item: string; itemLeadingIcon: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailingIcon: string; scrollUpDownButtonIcon: string; }; }; color: { default: string; danger: string; success: string; warning: string; primary: string; secondary: string; collab: string; ai: string; }; tagColor: { default: { tag: string; }; danger: { tag: string; }; success: { tag: string; }; warning: { tag: string; }; primary: { tag: string; }; secondary: { tag: string; }; collab: { tag: string; }; ai: { tag: string; }; }; rounded: { true: string; false: string; }; noPadding: { true: { base: string; }; }; noBorder: { true: string; }; underline: { true: string; }; leading: { true: string; }; trailing: { true: string; }; loading: { true: string; }; highlight: { true: string; }; type: { file: string; }; colorItem: { default: string; danger: { item: string; itemLeadingIcon: string; }; success: { item: string; itemLeadingIcon: string; }; warning: { item: string; itemLeadingIcon: string; }; primary: { item: string; itemLeadingIcon: string; }; secondary: { item: string; itemLeadingIcon: string; }; collab: { item: string; itemLeadingIcon: string; }; ai: { item: string; itemLeadingIcon: string; }; }; addNew: { true: { group: string; item: string; itemLabel: string; itemLeadingIcon: string; }; }; }, { root: string; base: string; leading: string; leadingIcon: string; leadingAvatar: string; leadingAvatarSize: string; trailing: string; trailingIcon: string; tag: string; value: string; placeholder: string; arrow: string; content: string; scrollUpDownButton: string; scrollUpDownButtonIcon: string; viewport: string; group: string; empty: string; label: string; separator: string; item: string; itemLeadingIcon: string; itemLeadingAvatar: string; itemLeadingAvatarSize: string; itemLeadingChip: string; itemLeadingChipSize: string; itemTrailing: string; itemTrailingIcon: string; itemLabel: string; input: string; focusScope: string; }, undefined, unknown, unknown, undefined>>>; interface _SelectMenuItem { label?: string; /** * Display an icon on the left side. * @IconComponent */ icon?: IconComponent; avatar?: AvatarProps; color?: SelectMenuVariants['color']; chip?: ChipProps; /** * The item type. * @defaultValue 'item' */ type?: 'label' | 'separator' | 'item'; disabled?: boolean; onSelect?(e?: Event): void; [key: string]: any; } export type SelectMenuItem = _SelectMenuItem | AcceptableValue | boolean; type SelectMenuVariants = VariantProps<typeof selectMenu>; 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 { 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...', type: 'search' }`{lang="ts"} * @defaultValue true */ searchInput?: boolean | InputProps; /** * @defaultValue 'primary' */ color?: SelectMenuVariants['color']; /** * @defaultValue 'md' */ size?: SelectMenuVariants['size']; /** * Removes padding from input * @defaultValue false */ noPadding?: boolean; /** * Removes all borders (rings) * @defaultValue false */ noBorder?: boolean; /** * Removes all borders (rings) except the bottom one * @defaultValue false */ underline?: boolean; /** * Rounds the corners of the button * @defaultValue false */ rounded?: boolean; tag?: string; /** * @defaultValue 'primary' */ tagColor?: SelectMenuVariants['tagColor']; /** * @defaultValue false */ required?: boolean; /** * The icon displayed to open the menu. * @defaultValue icons.chevronDown * @IconComponent */ trailingIcon?: IconComponent; /** * The icon displayed when an item is selected. * @defaultValue icons.check * @IconComponent */ selectedIcon?: IconComponent; /** * 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 */ arrow?: boolean | Omit<ComboboxArrowProps, 'as' | 'asChild'>; /** * Render the menu in a portal. * @defaultValue true */ portal?: boolean; /** * 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?: keyof NestedItem<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>; /** * Whether multiple options can be selected or not * @defaultValue false */ multiple?: M & boolean; /** * Highlight the ring color like a focus state * @defaultValue false */ 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; class?: any; b24ui?: PartialString<typeof selectMenu.slots>; } export type SelectMenuEmits<A extends ArrayOrNested<SelectMenuItem>, VK extends GetItemKeys<A> | undefined, M extends boolean> = Pick<ComboboxRootEmits, 'update:open'> & { change: [payload: Event]; blur: [payload: FocusEvent]; focus: [payload: 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; }) => 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; b24ui: ReturnType<typeof selectMenu>; }): any; 'default'(props: { modelValue?: GetModelValue<A, VK, M>; open: boolean; }): any; 'trailing'(props: { modelValue?: GetModelValue<A, VK, M>; open: boolean; b24ui: ReturnType<typeof selectMenu>; }): any; 'empty'(props: { searchTerm?: string; }): any; 'item': SlotProps<T>; 'item-leading': SlotProps<T>; 'item-label': SlotProps<T>; 'item-trailing': SlotProps<T>; 'create-item-label'(props: { item: string; }): any; } declare const _default: <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<Pick<Partial<{}> & Omit<{} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, never> & ({ searchTerm?: string; } & SelectMenuProps<T, VK, M>) & Partial<{}>> & (import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps); expose(exposed: import("vue").ShallowUnwrapRef<{}>): void; attrs: any; slots: Readonly<SelectMenuSlots<T, VK, M, NestedItem<T>>> & SelectMenuSlots<T, VK, M, NestedItem<T>>; emit: (((evt: "create", item: string) => void) & ((evt: "blur", payload: FocusEvent) => void) & ((evt: "change", payload: Event) => void) & ((evt: "focus", payload: FocusEvent) => void) & ((evt: "update:open", value: boolean) => void) & ((evt: "update:modelValue", payload: 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>; }; export default _default; type __VLS_PrettifyLocal<T> = { [K in keyof T]: T[K]; } & {};