components/listbox

Import

Import

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

Exports

Kind	Export	Description
Ttype alias	ListboxItemState	Intrinsic focus and selection state supplied when rendering a Listbox item.
Ttype alias	ListboxProps	Props accepted by Listbox.
Ttype alias	ListboxValue	Supported ListboxValue values.
fnfunction	Listbox()	A selection primitive with caller-owned values and intrinsic keyboard navigation.

ListboxItemStateTtype alias

Signature

type ListboxItemState = object;

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

Properties

active

Signature

active: boolean;

disabled

Signature

disabled: boolean;

selected

Signature

selected: boolean;

---

ListboxPropsTtype alias

Signature

type ListboxProps<T, Multiple> = object &
  Omit<
    HTMLAttributes<HTMLDivElement>,
    "defaultValue" | "onChange" | "onSelect" | "value"
  > &
  Multiple extends true
  ? object
  : Multiple extends false
    ? object
    : | {
          defaultValue?: ListboxValue;
          multiple?: false;
          onValueChange?: (value, item) => void;
          value?: ListboxValue;
        }
      | {
          defaultValue?: ListboxValue<true>;
          multiple: true;
          onValueChange?: (value, item) => void;
          value?: ListboxValue<true>;
        };

Props accepted by Listbox.

Type Declaration

Name	Type	Description
emptyMessage?	ReactNode	-
getKey()	(item) => string	Returns the stable key used for focus and selection.
getLabel()	(item) => string	Returns the accessible label used for an item.
isDisabled()?	(item) => boolean	Determines whether an item can receive focus or selection.
items	readonly T[]	-
rootRef?	React.Ref<HTMLDivElement>	Receives the selection control’s root div.
renderItem()?	(item, active, state) => ReactNode	Renders an item with its intrinsic focus and selection state.

Type Parameters

Type Parameter	Default type
T	-
Multiple extends boolean	false

---

ListboxValueTtype alias

Signature

type ListboxValue<Multiple> = Multiple extends true ? string[] : null | string;

Supported ListboxValue values.

Type Parameters

Type Parameter	Default type
Multiple extends boolean	false

Listbox()fnfunction

Signature

function Listbox<T>(input): Element;

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

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
input	ListboxProps<T, boolean>

Returns

Element