@bitrix24/b24ui-nuxt
Version:
Bitrix24 UI-Kit for developing web applications REST API for NUXT & VUE
1,202 lines (1,201 loc) • 30.6 kB
TypeScript
import type { VariantProps } from 'tailwind-variants';
import type { SelectRootProps, SelectRootEmits, SelectContentProps, SelectContentEmits, SelectArrowProps } from 'reka-ui';
import type { UseComponentIconsProps } from '../composables/useComponentIcons';
import type { AvatarProps, ChipProps, IconComponent } from '../types';
import type { AcceptableValue, ArrayOrNested, GetItemKeys, GetModelValue, GetModelValueEmits, NestedItem, PartialString, EmitsToProps } from '../types/utils';
declare const select: 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;
};
};
}, {
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;
}, 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;
};
};
}, {
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;
}, 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;
};
};
}, {
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;
}, 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;
};
};
}, {
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;
}, 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;
};
};
}, {
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;
}, undefined, unknown, unknown, undefined>>>;
type SelectVariants = VariantProps<typeof select>;
interface SelectItemBase {
label?: string;
/**
* Display an icon on the left side.
* @IconComponent
*/
icon?: IconComponent;
avatar?: AvatarProps;
color?: SelectVariants['color'];
chip?: ChipProps;
/**
* The item type.
* @defaultValue 'item'
*/
type?: 'label' | 'separator' | 'item';
value?: string | number;
disabled?: boolean;
onSelect?(e?: Event): void;
[key: string]: any;
}
export type SelectItem = SelectItemBase | AcceptableValue | boolean;
export interface SelectProps<T extends ArrayOrNested<SelectItem> = ArrayOrNested<SelectItem>, VK extends GetItemKeys<T> = 'value', M extends boolean = false> extends Omit<SelectRootProps<T>, 'dir' | 'multiple' | 'modelValue' | 'defaultValue' | 'by'>, UseComponentIconsProps {
id?: string;
/** The placeholder text when the select is empty. */
placeholder?: string;
/**
* @defaultValue 'primary'
*/
color?: SelectVariants['color'];
/**
* @defaultValue 'md'
*/
size?: SelectVariants['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?: SelectVariants['tagColor'];
/**
* 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<SelectContentProps, 'as' | 'asChild' | 'forceMount'> & Partial<EmitsToProps<SelectContentEmits>>;
/**
* Display an arrow alongside the menu.
* @defaultValue false
*/
arrow?: boolean | Omit<SelectArrowProps, '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.
* @defaultValue 'value'
*/
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 Select when initially rendered. Use when you do not need to control the state of the Select
*/
defaultValue?: GetModelValue<T, VK, M>;
/**
* The controlled value of the Select. Can be bind as `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;
class?: any;
b24ui?: PartialString<typeof select.slots>;
}
export type SelectEmits<A extends ArrayOrNested<SelectItem>, VK extends GetItemKeys<A> | undefined, M extends boolean> = Omit<SelectRootEmits, 'update:modelValue'> & {
change: [payload: Event];
blur: [payload: FocusEvent];
focus: [payload: FocusEvent];
} & GetModelValueEmits<A, VK, M>;
type SlotProps<T extends SelectItem> = (props: {
item: T;
index: number;
}) => any;
export interface SelectSlots<A extends ArrayOrNested<SelectItem> = ArrayOrNested<SelectItem>, 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 select>;
}): any;
'default'(props: {
modelValue?: GetModelValue<A, VK, M>;
open: boolean;
}): any;
'trailing'(props: {
modelValue?: GetModelValue<A, VK, M>;
open: boolean;
b24ui: ReturnType<typeof select>;
}): any;
'item': SlotProps<T>;
'item-leading': SlotProps<T>;
'item-label': SlotProps<T>;
'item-trailing': SlotProps<T>;
}
declare const _default: <T extends ArrayOrNested<SelectItem>, VK extends GetItemKeys<T> = "value", 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<any & SelectProps<T, VK, M> & Partial<{}>> & (import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps);
expose(exposed: import("vue").ShallowUnwrapRef<{}>): void;
attrs: any;
slots: Readonly<SelectSlots<T, VK, M, NestedItem<T>>> & SelectSlots<T, VK, M, NestedItem<T>>;
emit: ((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);
}>) => import("vue").VNode & {
__ctx?: Awaited<typeof __VLS_setup>;
};
export default _default;
type __VLS_PrettifyLocal<T> = {
[K in keyof T]: T[K];
} & {};