On this pageFunctions

Ui/Combobox/Multi

Functions

create

init

/** Creates an initial multi-select combobox model from a config. Defaults to closed with no active item, empty input, and no selection. */
(config: InitConfig): Multi.Model

Types

InitConfig

typesource

/** Configuration for creating a multi-select combobox model with `init`. `isAnimated` enables CSS transition coordination (default `false`). `isModal` locks page scroll and inerts other elements when open (default `false`). `selectedItems` sets the initial selection (default `[]`). */
type InitConfig = BaseInitConfig & Readonly<{
  selectedItems: ReadonlyArray<string>
}>

ViewInputs

typesource

/** Per-render view inputs passed to the view via `h.submodel`'s `viewInputs` field. */
type ViewInputs = BaseViewInputs<Item>

Constants

Model

constsource

/** Schema for the multi-select combobox component's state, tracking open/closed status, active item, input value, and selected items. */
const Model: Struct<{
  activationTrigger: Literals<readonly ["Pointer", "Keyboard"]>
  animation: Struct<{
    id: String
    isShowing: Boolean
    transitionState: Literals<readonly ["Idle", "EnterStart", "EnterAnimating", "LeaveStart", "LeaveAnimating"]>
  }>
  id: String
  immediate: Boolean
  inputValue: String
  isAnimated: Boolean
  isModal: Boolean
  isOpen: Boolean
  maybeActiveItemIndex: Option<Number>
  maybeLastPointerPosition: Option<Struct<{
    screenX: Number
    screenY: Number
  }>>
  nullable: Boolean
  selectedItems: $Array<String>
  selectInputOnFocus: Boolean
}>