components/combobox

Import

Import

import * as api from "@fungi.computer/caps/components/combobox";

Exports

Kind	Export	Description
Ttype alias	ComboboxItemState	Intrinsic focus and selection state supplied when rendering a Combobox item.
Ttype alias	ComboboxProps	Props accepted by Combobox.
Ttype alias	ComboboxBaseProps	Props shared by every Combobox mode: item shape, rendering, and field wiring.
Ttype alias	ComboboxInlineProps	Combobox mode flags for the inline (always-expanded, no popup trigger) layout.
Ttype alias	ComboboxPopupProps	Combobox mode flags for the popup layout, either caller-controlled or uncontrolled open state.
Ttype alias	ComboboxValueProps	Combobox selection shape: single or multiple, controlled or uncontrolled.
constconstant	ComboboxTrigger	The same molded field face as Select, for caller-owned selection summaries.
fnfunction	Combobox()	A searchable selection primitive with caller-owned values and intrinsic keyboard navigation.

ComboboxItemStateTtype alias

Signature

type ComboboxItemState = object;

Intrinsic focus and selection state supplied when rendering a Combobox item.

Properties

active

Signature

active: boolean;

disabled

Signature

disabled: boolean;

selected

Signature

selected: boolean;

---

ComboboxPropsTtype alias

Signature

type ComboboxProps<T> = ComboboxBaseProps<T> &
  | ComboboxInlineProps
| ComboboxPopupProps & ComboboxValueProps<T>;

Props accepted by Combobox.

Type Parameters

Type Parameter
T

---

ComboboxBasePropsTtype alias

Signature

type ComboboxBaseProps<T> = object &
  Omit<React.HTMLAttributes<HTMLDivElement>, "defaultValue" | "value">;

Props shared by every Combobox mode: item shape, rendering, and field wiring.

Type Declaration

Name	Type	Description
activeTone?	"neutral" | "primary"	Color intent for the locally active option.
container?	BasePopover.Portal.Props["container"]	Native portal destination. Use an unclipped themed container for nested themes.
contentClassName?	string	-
emptyMessage?	ReactNode	-
getKey()	(item) => string	Returns the stable identity used to track and compare items.
getLabel()	(item) => string	Returns the text shown for an item in the trigger and the list.
getSearchText()?	(item) => string	Returns the text matched against caller input; defaults to the item’s label.
groupBy()?	(item) => string	Returns the heading an item is grouped under in the list.
id?	string	Identifies the popup trigger or inline input for native label association.
inputProps?	Omit<React.InputHTMLAttributes<HTMLInputElement>, "defaultValue" | "value">	-
inputRef?	React.Ref<HTMLInputElement>	-
rootRef?	React.Ref<HTMLDivElement>	Receives the selection control’s root div.
isDisabled()?	(item) => boolean	Returns whether an item is unselectable.
items	readonly T[]	-
placeholder?	string	-
renderItem()?	(item, active, state) => ReactNode	Renders one item’s content; defaults to its label.

Type Parameters

Type Parameter
T

---

ComboboxInlinePropsTtype alias

Signature

type ComboboxInlineProps = object;

Combobox mode flags for the inline (always-expanded, no popup trigger) layout.

Properties

defaultOpen?

Signature

optional defaultOpen?: never;

onOpenChange?

Signature

optional onOpenChange?: never;

Popup visibility callbacks do not apply to inline choices.

open?

Signature

optional open?: never;

trigger?

Signature

optional trigger?: never;

triggerRef?

Signature

optional triggerRef?: never;

---

ComboboxPopupPropsTtype alias

Signature

type ComboboxPopupProps =
  | {
      defaultOpen?: boolean;
      onOpenChange?: (open) => void;
      open?: never;
      trigger: ReactElement<ButtonHTMLAttributes<HTMLButtonElement>>;
      triggerRef?: React.Ref<HTMLButtonElement>;
    }
  | {
      defaultOpen?: never;
      onOpenChange?: (open) => void;
      open: boolean;
      trigger: ReactElement<ButtonHTMLAttributes<HTMLButtonElement>>;
      triggerRef?: React.Ref<HTMLButtonElement>;
    };

Combobox mode flags for the popup layout, either caller-controlled or uncontrolled open state.

Union Members

Type Literal

Signature

{
  defaultOpen?: boolean;
  onOpenChange?: (open) => void;
  open?: never;
  trigger: ReactElement<ButtonHTMLAttributes<HTMLButtonElement>>;
  triggerRef?: React.Ref<HTMLButtonElement>;
}

Name	Type	Description
defaultOpen?	boolean	-
onOpenChange()?	(open) => void	Called after the popup’s open state changes.
open?	never	-
trigger	ReactElement<ButtonHTMLAttributes<HTMLButtonElement>>	-
triggerRef?	React.Ref<HTMLButtonElement>	-

---

Type Literal

Signature

{
  defaultOpen?: never;
  onOpenChange?: (open) => void;
  open: boolean;
  trigger: ReactElement<ButtonHTMLAttributes<HTMLButtonElement>>;
  triggerRef?: React.Ref<HTMLButtonElement>;
}

Name	Type	Description
defaultOpen?	never	-
onOpenChange()?	(open) => void	Called after the popup’s open state changes.
open	boolean	-
trigger	ReactElement<ButtonHTMLAttributes<HTMLButtonElement>>	-
triggerRef?	React.Ref<HTMLButtonElement>	-

---

ComboboxValuePropsTtype alias

Signature

type ComboboxValueProps<T> =
  |
  | {
  defaultValue?: never;
  value: null | string;
}
  | {
  defaultValue?: null | string;
  value?: never;
} & object
  | {
  multiple: true;
  value: readonly string[];
  defaultValue?: never;
  onValueChange?: (value, items) => void;
};

Combobox selection shape: single or multiple, controlled or uncontrolled.

Type Parameters

Type Parameter
T

Union Members

| { defaultValue?: never; value: null | string; } | { defaultValue?: null | string; value?: never; } & object

---

Type Literal

Signature

{
  multiple: true;
  value: readonly string[];
  defaultValue?: never;
  onValueChange?: (value, items) => void;
}

Name	Type	Description
multiple	true	-
value	readonly string[]	-
defaultValue?	never	-
onValueChange()?	(value, items) => void	Called with the newly selected keys and items.

ComboboxTriggerconstconstant

Signature

const ComboboxTrigger: ForwardRefExoticComponent<
  ButtonHTMLAttributes<HTMLButtonElement> & RefAttributes<HTMLButtonElement>
>;

The same molded field face as Select, for caller-owned selection summaries.

Combobox()fnfunction

Signature

function Combobox<T>(props): Element;

A searchable selection primitive with caller-owned values and intrinsic keyboard navigation.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
props	ComboboxProps<T>

Returns

Element