@cerberus-design/react/dist/components/combobox/primitives.d.ts

The Cerberus Design React component library.

import { Combobox, ComboboxClearTriggerProps as ArkComboboxClearTriggerProps, ComboboxContentProps as ArkComboboxContentProps, ComboboxControlProps as ArkComboboxControlProps, ComboboxInputProps as ArkComboboxInputProps, ComboboxItemGroupLabelProps as ArkComboboxItemGroupLabelProps, ComboboxItemGroupProps as ArkComboboxItemGroupProps, ComboboxItemIndicatorProps as ArkComboboxItemIndicatorProps, ComboboxItemProps as ArkComboboxItemProps, ComboboxItemTextProps as ArkComboboxItemTextProps, ComboboxLabelProps as ArkComboboxLabelProps, ComboboxPositionerProps as ArkComboboxPositionerProps, ComboboxRootProps as ArkComboboxRootProps, ComboboxTriggerProps as ArkComboboxTriggerProps } from '@ark-ui/react/combobox';
import { HTMLArkProps } from '@ark-ui/react/factory';
import { SelectCollectionItem } from '../select/select';
import { ComboboxVariantProps } from 'styled-system/recipes';
import { CerberusPrimitiveProps } from '../../system/index';
import { ForwardRefExoticComponent, RefAttributes, ClassAttributes, HTMLAttributes } from 'react';
import { PolymorphicProps } from '@ark-ui/react';
/**
 * The ComboboxRoot component is the context provider for the Combobox
 * component.
 */
export declare const ComboboxRoot: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Omit<Combobox.RootProps<unknown>, never> & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxRootProps = CerberusPrimitiveProps<ArkComboboxRootProps<SelectCollectionItem> & ComboboxVariantProps>;
/**
 * The label that appears above the combobox input.
 */
export declare const ComboboxLabel: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Combobox.LabelProps & RefAttributes<HTMLLabelElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxLabelProps = CerberusPrimitiveProps<ArkComboboxLabelProps>;
/**
 * The control that wraps the combobox input.
 */
export declare const ComboboxControl: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Combobox.ControlProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxControlProps = CerberusPrimitiveProps<ArkComboboxControlProps>;
/**
 * The input of the combobox.
 */
export declare const ComboboxInput: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Combobox.InputProps & RefAttributes<HTMLInputElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxInputProps = CerberusPrimitiveProps<ArkComboboxInputProps>;
/**
 * The trigger that opens the dropdown.
 */
export declare const ComboboxTrigger: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Combobox.TriggerProps & RefAttributes<HTMLButtonElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxTriggerProps = CerberusPrimitiveProps<ArkComboboxTriggerProps>;
/**
 * The trigger to clear the combobox input.
 */
export declare const ComboboxClearTrigger: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Combobox.ClearTriggerProps & RefAttributes<HTMLButtonElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxClearTriggerProps = CerberusPrimitiveProps<ArkComboboxClearTriggerProps>;
/**
 * The positioner that wraps the content.
 */
export declare const ComboboxPositioner: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Combobox.PositionerProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxPositionerProps = CerberusPrimitiveProps<ArkComboboxPositionerProps>;
/**
 * The content of the combobox component.
 */
export declare const ComboboxContent: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Combobox.ContentProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxContentProps = CerberusPrimitiveProps<ArkComboboxContentProps & ComboboxVariantProps>;
/**
 * A group of items in the combobox component.
 */
export declare const ComboboxItemGroup: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Combobox.ItemGroupProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxItemGroupProps = CerberusPrimitiveProps<ArkComboboxItemGroupProps>;
/**
 * The label for a group of items in the combobox component.
 */
export declare const ComboboxItemGroupLabel: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Combobox.ItemGroupLabelProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxItemGroupLabelProps = CerberusPrimitiveProps<ArkComboboxItemGroupLabelProps>;
/**
 * An individual item in the combobox component.
 */
export declare const ComboboxItem: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Combobox.ItemProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxItemProps = CerberusPrimitiveProps<ArkComboboxItemProps>;
/**
 * The text that labels a single item of the combobox.
 */
export declare const ComboboxItemText: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Combobox.ItemTextProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxItemTextProps = CerberusPrimitiveProps<ArkComboboxItemTextProps>;
/**
 * The indicator that appears when the item has been selected.
 */
export declare const ComboboxItemIndicator: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Combobox.ItemIndicatorProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxItemIndicatorProps = CerberusPrimitiveProps<ArkComboboxItemIndicatorProps>;
/**
 * The icon that appears at the start of the combobox input.
 */
export declare const ComboboxStartIcon: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps< ClassAttributes<HTMLSpanElement> & HTMLAttributes<HTMLSpanElement> & PolymorphicProps>, "ref"> & RefAttributes<unknown>>;
export type ComboboxStartIconProps = CerberusPrimitiveProps<HTMLArkProps<'span'>>;
export declare const ComboItemText: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Combobox.ItemTextProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type ComboboxInputValueChangeDetails = Combobox.InputValueChangeDetails;