grassroot
Install

DocsAPI referenceHeadlesscombobox

combobox headless API

The core connector and vanilla mount are always visible. Use the framework choice to inspect native composition, props, outputs, context and hooks for the selected adapter.

Machine APIPlatform contract

@grassroot/ui-headless-core/combobox

Core connector and vanilla API

12 exports
View source packages/ui-headless/core/src/combobox/index.ts

activateComboboxLayer

function
DeclarationView source
activateComboboxLayerts
declare function activateComboboxLayer(service: ComboboxService, scope: PartScope, doc: Document): () => void;
Name
Kind
Type
Requirement
service
parameter
ComboboxService
required
scope
parameter
PartScope
required
doc
parameter
Document
required
return
return value
() => void
n/a
Name
service
Kind
parameter
Type
ComboboxService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
doc
Kind
parameter
Type
Document
Requirement
required
Name
return
Kind
return value
Type
() => void
Requirement
n/a

comboboxAnatomy

value
DeclarationView source
comboboxAnatomyts
export declare const comboboxAnatomy: {
  readonly scope: "combobox";
  readonly parts: readonly ["root", "label", "control", "input", "trigger", "positioner", "content", "item", "item-text", "empty"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "label", "control", "input", "trigger", "positioner", "content", "item", "item-text", "empty"]
required
scope
property
"combobox"
required
Name
parts
Kind
property
Type
readonly ["root", "label", "control", "input", "trigger", "positioner", "content", "item", "item-text", "empty"]
Requirement
required
Name
scope
Kind
property
Type
"combobox"
Requirement
required

ComboboxApi

interface
DeclarationView source
ComboboxApits
interface ComboboxApi {
  rootProps(): PartProps;
  labelProps(): PartProps;
  controlProps(): PartProps;
  inputProps(): PartProps;
  triggerProps(): PartProps;
  positionerProps(): PartProps;
  contentProps(): PartProps;
  itemProps(option: ComboboxOptionInput): PartProps;
  itemTextProps(option: ComboboxOptionInput): PartProps;
  emptyProps(): PartProps;
  hiddenInputProps(formOptions?: {
    name?: string;
    required?: boolean;
  }): readonly PartProps[];
  readonly open: boolean;
  readonly value: ComboboxValue;
  readonly selectedIds: readonly string[];
  readonly inputValue: string;
  readonly activeIndex: number;
  readonly filteredValues: readonly string[];
  readonly loading: boolean;
}
Name
Kind
Type
Requirement
activeIndex
property
number
required
contentProps
method
() => PartProps
required
controlProps
method
() => PartProps
required
emptyProps
method
() => PartProps
required
filteredValues
property
readonly string[]
required
hiddenInputProps
method
(formOptions?: { name?: string; required?: boolean; }) => readonly PartProps[]
required
inputProps
method
() => PartProps
required
inputValue
property
string
required
itemProps
method
(option: ComboboxOptionInput) => PartProps
required
itemTextProps
method
(option: ComboboxOptionInput) => PartProps
required
labelProps
method
() => PartProps
required
loading
property
boolean
required
open
property
boolean
required
positionerProps
method
() => PartProps
required
Name
activeIndex
Kind
property
Type
number
Requirement
required
Name
contentProps
Kind
method
Type
() => PartProps
Requirement
required
Name
controlProps
Kind
method
Type
() => PartProps
Requirement
required
Name
emptyProps
Kind
method
Type
() => PartProps
Requirement
required
Name
filteredValues
Kind
property
Type
readonly string[]
Requirement
required
Name
hiddenInputProps
Kind
method
Type
(formOptions?: { name?: string; required?: boolean; }) => readonly PartProps[]
Requirement
required
Name
inputProps
Kind
method
Type
() => PartProps
Requirement
required
Name
inputValue
Kind
property
Type
string
Requirement
required
Name
itemProps
Kind
method
Type
(option: ComboboxOptionInput) => PartProps
Requirement
required
Name
itemTextProps
Kind
method
Type
(option: ComboboxOptionInput) => PartProps
Requirement
required
Name
labelProps
Kind
method
Type
() => PartProps
Requirement
required
Name
loading
Kind
property
Type
boolean
Requirement
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
positionerProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
selectedIds
Kind
property
Type
readonly string[]
Requirement
required
Name
triggerProps
Kind
method
Type
() => PartProps
Requirement
required
Name
value
Kind
property
Type
ComboboxValue
Requirement
required

ComboboxConnectOptions

interface
DeclarationView source
ComboboxConnectOptionsts
interface ComboboxConnectOptions {
  readonly dir?: "ltr" | "rtl";
  readonly onOpenChange?: (detail: {
    open: boolean;
    reason: ComboboxChangeReason;
  }) => void;
  readonly onValueChange?: (detail: {
    value: ComboboxValue;
    reason: Exclude<ComboboxChangeReason, "input">;
  }) => void;
  readonly onInputValueChange?: (detail: {
    inputValue: string;
    reason: "input" | "programmatic";
  }) => void;
  readonly announce?: LiveRegionAnnouncer["announce"];
}
Name
Kind
Type
Requirement
announce
property
LiveRegionAnnouncer["announce"]
optional
dir
property
"ltr" | "rtl"
optional
onInputValueChange
property
(detail: { inputValue: string; reason: "input" | "programmatic"; }) => void
optional
onOpenChange
property
(detail: { open: boolean; reason: ComboboxChangeReason; }) => void
optional
onValueChange
property
(detail: { value: ComboboxValue; reason: Exclude<ComboboxChangeReason, "input">; }) => void
optional
Name
announce
Kind
property
Type
LiveRegionAnnouncer["announce"]
Requirement
optional
Name
dir
Kind
property
Type
"ltr" | "rtl"
Requirement
optional
Name
onInputValueChange
Kind
property
Type
(detail: { inputValue: string; reason: "input" | "programmatic"; }) => void
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: { open: boolean; reason: ComboboxChangeReason; }) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: { value: ComboboxValue; reason: Exclude<ComboboxChangeReason, "input">; }) => void
Requirement
optional

ComboboxMount

interface
DeclarationView source
ComboboxMountts
interface ComboboxMount {
  readonly service: ComboboxService;
  readonly connector: ComboboxApi;
  readonly root: HTMLElement;
  destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
ComboboxApi
required
destroy
method
() => void
required
root
property
HTMLElement
required
service
property
ComboboxService
required
Name
connector
Kind
property
Type
ComboboxApi
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLElement
Requirement
required
Name
service
Kind
property
Type
ComboboxService
Requirement
required

ComboboxPart

type
DeclarationView source
ComboboxPartts
type ComboboxPart = (typeof comboboxAnatomy.parts)[number];

ComboboxRunCommand

type
DeclarationView source
ComboboxRunCommandts
type ComboboxRunCommand = RunCommand<ComboboxCommand, ComboboxEvent>;

ComboboxService

type
DeclarationView source
ComboboxServicets
type ComboboxService = Service<ComboboxInput, ComboboxStateValue, ComboboxContext, ComboboxEvent, ComboboxCommand>;

connectCombobox

function
DeclarationView source
connectComboboxts
declare function connectCombobox(service: ComboboxService, scope: PartScope, options?: ComboboxConnectOptions): ComboboxApi;
Name
Kind
Type
Requirement
service
parameter
ComboboxService
required
scope
parameter
PartScope
required
options
parameter
ComboboxConnectOptions
optional
return
return value
ComboboxApi
n/a
Name
service
Kind
parameter
Type
ComboboxService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
ComboboxConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
ComboboxApi
Requirement
n/a

mountCombobox

function
DeclarationView source
mountComboboxts
declare function mountCombobox(container: HTMLElement, options: MountComboboxOptions): ComboboxMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountComboboxOptions
required
return
return value
ComboboxMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
MountComboboxOptions
Requirement
required
Name
return
Kind
return value
Type
ComboboxMount
Requirement
n/a

MountComboboxOptions

interface
DeclarationView source
MountComboboxOptionsts
interface MountComboboxOptions extends ComboboxInput {
  readonly name?: string;
  readonly required?: boolean;
  readonly dir?: "ltr" | "rtl";
  readonly label?: string;
  readonly placeholder?: string;
  readonly searchPlaceholder?: string;
  readonly emptyText?: string;
  readonly onOpenChange?: (detail: {
    open: boolean;
    reason: string;
  }) => void;
  readonly onValueChange?: (detail: {
    value: ComboboxValue;
    reason: string;
  }) => void;
  readonly onInputValueChange?: (detail: {
    inputValue: string;
    reason: string;
  }) => void;
  readonly renderOption?: (element: HTMLElement, option: ComboboxOptionInput) => void;
  readonly runCommand?: ComboboxRunCommand;
}
Name
Kind
Type
Requirement
dir
property
"ltr" | "rtl"
optional
emptyText
property
string
optional
label
property
string
optional
name
property
string
optional
onInputValueChange
property
(detail: { inputValue: string; reason: string; }) => void
optional
onOpenChange
property
(detail: { open: boolean; reason: string; }) => void
optional
onValueChange
property
(detail: { value: ComboboxValue; reason: string; }) => void
optional
placeholder
property
string
optional
renderOption
property
(element: HTMLElement, option: ComboboxOptionInput) => void
optional
required
property
boolean
optional
runCommand
property
ComboboxRunCommand
optional
searchPlaceholder
property
string
optional
Name
dir
Kind
property
Type
"ltr" | "rtl"
Requirement
optional
Name
emptyText
Kind
property
Type
string
Requirement
optional
Name
label
Kind
property
Type
string
Requirement
optional
Name
name
Kind
property
Type
string
Requirement
optional
Name
onInputValueChange
Kind
property
Type
(detail: { inputValue: string; reason: string; }) => void
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: { open: boolean; reason: string; }) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: { value: ComboboxValue; reason: string; }) => void
Requirement
optional
Name
placeholder
Kind
property
Type
string
Requirement
optional
Name
renderOption
Kind
property
Type
(element: HTMLElement, option: ComboboxOptionInput) => void
Requirement
optional
Name
required
Kind
property
Type
boolean
Requirement
optional
Name
runCommand
Kind
property
Type
ComboboxRunCommand
Requirement
optional
Name
searchPlaceholder
Kind
property
Type
string
Requirement
optional

runComboboxCommand

function
DeclarationView source
runComboboxCommandts
declare function runComboboxCommand(command: ComboboxCommandInput, scope: PartScope, options?: Pick<ComboboxConnectOptions, "onOpenChange" | "onValueChange" | "onInputValueChange" | "announce">): void;
Name
Kind
Type
Requirement
command
parameter
ComboboxCommandInput
required
scope
parameter
PartScope
required
options
parameter
Pick<ComboboxConnectOptions, "onOpenChange" | "onValueChange" | "onInputValueChange" | "announce">
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
ComboboxCommandInput
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
Pick<ComboboxConnectOptions, "onOpenChange" | "onValueChange" | "onInputValueChange" | "announce">
Requirement
optional
Name
return
Kind
return value
Type
void
Requirement
n/a

Framework adapters

Each panel keeps its adapter's public vocabulary. React compound exports, Vue composables, standalone Angular declarations, Svelte components, and Solid hooks stay native to their framework.

React example follows below.

React imports

@grassroot/ui-headless-react/comboboxts
import { Combobox, Content, Control, Empty, Item, ItemText, Label, Positioner } from "@grassroot/ui-headless-react/combobox"; // +3 more exports

Vue imports

@grassroot/ui-headless-vue/comboboxts
<script setup lang="ts">
import { ComboboxContent, ComboboxControl, ComboboxEmpty, ComboboxItem, ComboboxItemText, ComboboxLabel, ComboboxPositioner, ComboboxRoot } from "@grassroot/ui-headless-vue/combobox"; // +2 more exports
</script>

Angular imports

@grassroot/ui-headless-angular/comboboxts
import { Component } from "@angular/core";
import { GR_COMBOBOX_DECLARATIONS } from "@grassroot/ui-headless-angular/combobox";
 
@Component({ standalone: true, imports: [GR_COMBOBOX_DECLARATIONS], template: `<!-- compose the combobox parts here -->` })
export class Example {}

Svelte imports

@grassroot/ui-headless-svelte/comboboxts
<script lang="ts">
  import { ComboboxContent, ComboboxControl, ComboboxEmpty, ComboboxItem, ComboboxItemText, ComboboxLabel, ComboboxPositioner, ComboboxRoot } from "@grassroot/ui-headless-svelte/combobox"; // +2 more exports
</script>

Solid imports

@grassroot/ui-headless-solid/comboboxts
import { ComboboxContent, ComboboxControl, ComboboxEmpty, ComboboxItem, ComboboxItemText, ComboboxLabel, ComboboxPositioner, ComboboxRoot } from "@grassroot/ui-headless-solid/combobox"; // +2 more exports

@grassroot/ui-headless-react/combobox

React adapter

35 exports
View source packages/ui-headless/react/src/combobox/index.ts

Combobox

value
DeclarationView source
Comboboxts
export declare const Combobox: {
  Root: import("react").ForwardRefExoticComponent<ComboboxRootProps & import("react").RefAttributes<HTMLDivElement>>;
  RootProvider: import("react").ForwardRefExoticComponent<ComboboxRootProviderProps & import("react").RefAttributes<HTMLDivElement>>;
  Label: import("react").ForwardRefExoticComponent<ComboboxLabelProps & import("react").RefAttributes<HTMLLabelElement>>;
  Control: import("react").ForwardRefExoticComponent<ComboboxControlProps & import("react").RefAttributes<HTMLDivElement>>;
  Input: import("react").ForwardRefExoticComponent<ComboboxInputProps & import("react").RefAttributes<HTMLInputElement>>;
  Trigger: import("react").ForwardRefExoticComponent<ComboboxTriggerProps & import("react").RefAttributes<HTMLButtonElement>>;
  Positioner: import("react").ForwardRefExoticComponent<ComboboxPositionerProps & import("react").RefAttributes<HTMLDivElement>>;
  Content: import("react").ForwardRefExoticComponent<ComboboxContentProps & import("react").RefAttributes<HTMLDivElement>>;
  Item: import("react").ForwardRefExoticComponent<ComboboxItemProps & import("react").RefAttributes<HTMLDivElement>>;
  ItemText: import("react").ForwardRefExoticComponent<ComboboxItemTextProps & import("react").RefAttributes<HTMLSpanElement>>;
  Empty: import("react").ForwardRefExoticComponent<ComboboxEmptyProps & import("react").RefAttributes<HTMLDivElement>>;
  HiddenInput: import("react").ForwardRefExoticComponent<ComboboxHiddenInputProps & import("react").RefAttributes<HTMLInputElement>>;
};
Name
Kind
Type
Requirement
Content
property
import("react").ForwardRefExoticComponent<ComboboxContentProps & import("react").RefAttributes<HTMLDivElement>>
required
Control
property
import("react").ForwardRefExoticComponent<ComboboxControlProps & import("react").RefAttributes<HTMLDivElement>>
required
Empty
property
import("react").ForwardRefExoticComponent<ComboboxEmptyProps & import("react").RefAttributes<HTMLDivElement>>
required
HiddenInput
property
import("react").ForwardRefExoticComponent<ComboboxHiddenInputProps & import("react").RefAttributes<HTMLInputElement>>
required
Input
property
import("react").ForwardRefExoticComponent<ComboboxInputProps & import("react").RefAttributes<HTMLInputElement>>
required
Item
property
import("react").ForwardRefExoticComponent<ComboboxItemProps & import("react").RefAttributes<HTMLDivElement>>
required
ItemText
property
import("react").ForwardRefExoticComponent<ComboboxItemTextProps & import("react").RefAttributes<HTMLSpanElement>>
required
Label
property
import("react").ForwardRefExoticComponent<ComboboxLabelProps & import("react").RefAttributes<HTMLLabelElement>>
required
Positioner
property
import("react").ForwardRefExoticComponent<ComboboxPositionerProps & import("react").RefAttributes<HTMLDivElement>>
required
Root
property
import("react").ForwardRefExoticComponent<ComboboxRootProps & import("react").RefAttributes<HTMLDivElement>>
required
RootProvider
property
import("react").ForwardRefExoticComponent<ComboboxRootProviderProps & import("react").RefAttributes<HTMLDivElement>>
required
Trigger
property
import("react").ForwardRefExoticComponent<ComboboxTriggerProps & import("react").RefAttributes<HTMLButtonElement>>
required
Name
Content
Kind
property
Type
import("react").ForwardRefExoticComponent<ComboboxContentProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Control
Kind
property
Type
import("react").ForwardRefExoticComponent<ComboboxControlProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Empty
Kind
property
Type
import("react").ForwardRefExoticComponent<ComboboxEmptyProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
HiddenInput
Kind
property
Type
import("react").ForwardRefExoticComponent<ComboboxHiddenInputProps & import("react").RefAttributes<HTMLInputElement>>
Requirement
required
Name
Input
Kind
property
Type
import("react").ForwardRefExoticComponent<ComboboxInputProps & import("react").RefAttributes<HTMLInputElement>>
Requirement
required
Name
Item
Kind
property
Type
import("react").ForwardRefExoticComponent<ComboboxItemProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
ItemText
Kind
property
Type
import("react").ForwardRefExoticComponent<ComboboxItemTextProps & import("react").RefAttributes<HTMLSpanElement>>
Requirement
required
Name
Label
Kind
property
Type
import("react").ForwardRefExoticComponent<ComboboxLabelProps & import("react").RefAttributes<HTMLLabelElement>>
Requirement
required
Name
Positioner
Kind
property
Type
import("react").ForwardRefExoticComponent<ComboboxPositionerProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Root
Kind
property
Type
import("react").ForwardRefExoticComponent<ComboboxRootProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
RootProvider
Kind
property
Type
import("react").ForwardRefExoticComponent<ComboboxRootProviderProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Trigger
Kind
property
Type
import("react").ForwardRefExoticComponent<ComboboxTriggerProps & import("react").RefAttributes<HTMLButtonElement>>
Requirement
required

ComboboxContentProps

interface
DeclarationView source
ComboboxContentPropsts
interface ComboboxContentProps extends ComponentPropsWithoutRef<"div"> {
  readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional

ComboboxContext

value
DeclarationView source
ComboboxContextts
export declare const ComboboxContext: import("react").Context<ComboboxContextValue | null>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

ComboboxContextValue

interface
DeclarationView source
ComboboxContextValuets
interface ComboboxContextValue {
  readonly service: ComboboxService;
  readonly connector: ComboboxApi;
  readonly scope: PartScope;
}
Name
Kind
Type
Requirement
connector
property
ComboboxApi
required
scope
property
PartScope
required
service
property
ComboboxService
required
Name
connector
Kind
property
Type
ComboboxApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
ComboboxService
Requirement
required

ComboboxControlProps

interface
DeclarationView source
ComboboxControlPropsts
interface ComboboxControlProps extends ComponentPropsWithoutRef<"div"> {
  readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional

ComboboxEmptyProps

interface
DeclarationView source
ComboboxEmptyPropsts
interface ComboboxEmptyProps extends ComponentPropsWithoutRef<"div"> {
  readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional

ComboboxHiddenInputProps

interface
DeclarationView source
ComboboxHiddenInputPropsts
interface ComboboxHiddenInputProps extends Omit<ComponentPropsWithoutRef<"input">, "name" | "required"> {
  readonly asChild?: boolean;
  readonly name?: string;
  readonly required?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
name
property
string
optional
required
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
name
Kind
property
Type
string
Requirement
optional
Name
required
Kind
property
Type
boolean
Requirement
optional

ComboboxInputProps

interface
DeclarationView source
ComboboxInputPropsts
interface ComboboxInputProps extends ComponentPropsWithoutRef<"input"> {
  readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional

ComboboxInputValueChangeDetail

interface
DeclarationView source
ComboboxInputValueChangeDetailts
interface ComboboxInputValueChangeDetail {
  readonly inputValue: string;
  readonly reason: "input" | "programmatic";
}
Name
Kind
Type
Requirement
inputValue
property
string
required
reason
property
"input" | "programmatic"
required
Name
inputValue
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"input" | "programmatic"
Requirement
required

ComboboxItemProps

interface
DeclarationView source
ComboboxItemPropsts
interface ComboboxItemProps extends ComponentPropsWithoutRef<"div"> {
  readonly asChild?: boolean;
  readonly option: ComboboxOptionInput;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
option
property
ComboboxOptionInput
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
option
Kind
property
Type
ComboboxOptionInput
Requirement
required

ComboboxItemTextProps

interface
DeclarationView source
ComboboxItemTextPropsts
interface ComboboxItemTextProps extends ComponentPropsWithoutRef<"span"> {
  readonly asChild?: boolean;
  readonly option: ComboboxOptionInput;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
option
property
ComboboxOptionInput
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
option
Kind
property
Type
ComboboxOptionInput
Requirement
required

ComboboxLabelProps

interface
DeclarationView source
ComboboxLabelPropsts
interface ComboboxLabelProps extends ComponentPropsWithoutRef<"label"> {
  readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional

ComboboxOpenChangeDetail

interface
DeclarationView source
ComboboxOpenChangeDetailts
interface ComboboxOpenChangeDetail {
  readonly open: boolean;
  readonly reason: ComboboxChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
ComboboxChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
ComboboxChangeReason
Requirement
required

ComboboxPositionerProps

interface
DeclarationView source
ComboboxPositionerPropsts
interface ComboboxPositionerProps extends ComponentPropsWithoutRef<"div"> {
  readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional

ComboboxRootProps

interface
DeclarationView source
ComboboxRootPropsts
interface ComboboxRootProps extends Omit<ComponentPropsWithoutRef<"div">, "value" | "defaultValue" | "onChange"> {
  readonly asChild?: boolean;
  readonly options: ComboboxInput["options"];
  readonly value?: ComboboxInput["value"];
  readonly defaultValue?: ComboboxInput["defaultValue"];
  readonly selectionMode?: ComboboxInput["selectionMode"];
  readonly open?: ComboboxInput["open"];
  readonly defaultOpen?: ComboboxInput["defaultOpen"];
  readonly inputValue?: ComboboxInput["inputValue"];
  readonly defaultInputValue?: ComboboxInput["defaultInputValue"];
  readonly loadOptions?: ComboboxInput["loadOptions"];
  readonly runCommand?: UseComboboxOptions["runCommand"];
  readonly dir?: UseComboboxOptions["dir"];
  readonly onOpenChange?: (detail: ComboboxOpenChangeDetail) => void;
  readonly onValueChange?: (detail: ComboboxValueChangeDetail) => void;
  readonly onInputValueChange?: (detail: ComboboxInputValueChangeDetail) => void;
  readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
defaultInputValue
property
ComboboxInput["defaultInputValue"]
optional
defaultOpen
property
ComboboxInput["defaultOpen"]
optional
defaultValue
property
ComboboxInput["defaultValue"]
optional
dir
property
UseComboboxOptions["dir"]
optional
inputValue
property
ComboboxInput["inputValue"]
optional
loadOptions
property
ComboboxInput["loadOptions"]
optional
onInputValueChange
property
(detail: ComboboxInputValueChangeDetail) => void
optional
onOpenChange
property
(detail: ComboboxOpenChangeDetail) => void
optional
onValueChange
property
(detail: ComboboxValueChangeDetail) => void
optional
open
property
ComboboxInput["open"]
optional
options
property
ComboboxInput["options"]
required
runCommand
property
UseComboboxOptions["runCommand"]
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
defaultInputValue
Kind
property
Type
ComboboxInput["defaultInputValue"]
Requirement
optional
Name
defaultOpen
Kind
property
Type
ComboboxInput["defaultOpen"]
Requirement
optional
Name
defaultValue
Kind
property
Type
ComboboxInput["defaultValue"]
Requirement
optional
Name
dir
Kind
property
Type
UseComboboxOptions["dir"]
Requirement
optional
Name
inputValue
Kind
property
Type
ComboboxInput["inputValue"]
Requirement
optional
Name
loadOptions
Kind
property
Type
ComboboxInput["loadOptions"]
Requirement
optional
Name
onInputValueChange
Kind
property
Type
(detail: ComboboxInputValueChangeDetail) => void
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: ComboboxOpenChangeDetail) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: ComboboxValueChangeDetail) => void
Requirement
optional
Name
open
Kind
property
Type
ComboboxInput["open"]
Requirement
optional
Name
options
Kind
property
Type
ComboboxInput["options"]
Requirement
required
Name
runCommand
Kind
property
Type
UseComboboxOptions["runCommand"]
Requirement
optional
Name
selectionMode
Kind
property
Type
ComboboxInput["selectionMode"]
Requirement
optional
Name
value
Kind
property
Type
ComboboxInput["value"]
Requirement
optional

ComboboxRootProviderProps

interface
DeclarationView source
ComboboxRootProviderPropsts
interface ComboboxRootProviderProps extends Omit<ComponentPropsWithoutRef<"div">, "value"> {
  readonly value: UseComboboxResult;
  readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
value
property
UseComboboxResult
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
value
Kind
property
Type
UseComboboxResult
Requirement
required

ComboboxTriggerProps

interface
DeclarationView source
ComboboxTriggerPropsts
interface ComboboxTriggerProps extends Omit<ComponentPropsWithoutRef<"button">, "type"> {
  readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional

ComboboxValueChangeDetail

interface
DeclarationView source
ComboboxValueChangeDetailts
interface ComboboxValueChangeDetail {
  readonly value: ComboboxValue;
  readonly reason: Exclude<ComboboxChangeReason, "input">;
}
Name
Kind
Type
Requirement
reason
property
Exclude<ComboboxChangeReason, "input">
required
value
property
ComboboxValue
required
Name
reason
Kind
property
Type
Exclude<ComboboxChangeReason, "input">
Requirement
required
Name
value
Kind
property
Type
ComboboxValue
Requirement
required

Content

value
DeclarationView source
Contentts
export declare const Content: import("react").ForwardRefExoticComponent<ComboboxContentProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Control

value
DeclarationView source
Controlts
export declare const Control: import("react").ForwardRefExoticComponent<ComboboxControlProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Empty

value
DeclarationView source
Emptyts
export declare const Empty: import("react").ForwardRefExoticComponent<ComboboxEmptyProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

HiddenInput

value
DeclarationView source
HiddenInputts
export declare const HiddenInput: import("react").ForwardRefExoticComponent<ComboboxHiddenInputProps & import("react").RefAttributes<HTMLInputElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Input

value
DeclarationView source
Inputts
export declare const Input: import("react").ForwardRefExoticComponent<ComboboxInputProps & import("react").RefAttributes<HTMLInputElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Item

value
DeclarationView source
Itemts
export declare const Item: import("react").ForwardRefExoticComponent<ComboboxItemProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

ItemText

value
DeclarationView source
ItemTextts
export declare const ItemText: import("react").ForwardRefExoticComponent<ComboboxItemTextProps & import("react").RefAttributes<HTMLSpanElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Label

value
DeclarationView source
Labelts
export declare const Label: import("react").ForwardRefExoticComponent<ComboboxLabelProps & import("react").RefAttributes<HTMLLabelElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Positioner

value
DeclarationView source
Positionerts
export declare const Positioner: import("react").ForwardRefExoticComponent<ComboboxPositionerProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Root

value
DeclarationView source
Rootts
export declare const Root: import("react").ForwardRefExoticComponent<ComboboxRootProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

RootProvider

value
DeclarationView source
RootProviderts
export declare const RootProvider: import("react").ForwardRefExoticComponent<ComboboxRootProviderProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Trigger

value
DeclarationView source
Triggerts
export declare const Trigger: import("react").ForwardRefExoticComponent<ComboboxTriggerProps & import("react").RefAttributes<HTMLButtonElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

useCombobox

function
DeclarationView source
useComboboxts
declare function useCombobox(input: ComboboxInput, options?: UseComboboxOptions): UseComboboxResult;
Name
Kind
Type
Requirement
input
parameter
ComboboxInput
required
options
parameter
UseComboboxOptions
optional
return
return value
UseComboboxResult
n/a
Name
input
Kind
parameter
Type
ComboboxInput
Requirement
required
Name
options
Kind
parameter
Type
UseComboboxOptions
Requirement
optional
Name
return
Kind
return value
Type
UseComboboxResult
Requirement
n/a

useComboboxContext

function
DeclarationView source
useComboboxContextts
declare function useComboboxContext(partName: string): ComboboxContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
ComboboxContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
ComboboxContextValue
Requirement
n/a

UseComboboxOptions

interface
DeclarationView source
UseComboboxOptionsts
interface UseComboboxOptions {
  readonly dir?: "ltr" | "rtl";
  readonly onOpenChange?: (detail: ComboboxOpenChangeDetail) => void;
  readonly onValueChange?: (detail: ComboboxValueChangeDetail) => void;
  readonly onInputValueChange?: (detail: ComboboxInputValueChangeDetail) => void;
  readonly runCommand?: ComboboxRunCommand;
}
Name
Kind
Type
Requirement
dir
property
"ltr" | "rtl"
optional
onInputValueChange
property
(detail: ComboboxInputValueChangeDetail) => void
optional
onOpenChange
property
(detail: ComboboxOpenChangeDetail) => void
optional
onValueChange
property
(detail: ComboboxValueChangeDetail) => void
optional
runCommand
property
ComboboxRunCommand
optional
Name
dir
Kind
property
Type
"ltr" | "rtl"
Requirement
optional
Name
onInputValueChange
Kind
property
Type
(detail: ComboboxInputValueChangeDetail) => void
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: ComboboxOpenChangeDetail) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: ComboboxValueChangeDetail) => void
Requirement
optional
Name
runCommand
Kind
property
Type
ComboboxRunCommand
Requirement
optional

UseComboboxResult

interface
DeclarationView source
UseComboboxResultts
interface UseComboboxResult {
  readonly service: ComboboxService;
  readonly connector: ComboboxApi;
  readonly scope: PartScope;
  readonly snapshot: ComboboxSnapshot;
}
Name
Kind
Type
Requirement
connector
property
ComboboxApi
required
scope
property
PartScope
required
service
property
ComboboxService
required
snapshot
property
ComboboxSnapshot
required
Name
connector
Kind
property
Type
ComboboxApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
ComboboxService
Requirement
required
Name
snapshot
Kind
property
Type
ComboboxSnapshot
Requirement
required

useServiceVersion

function

Subscribes a component to a service's committed-snapshot version.

DeclarationView source
useServiceVersionts
declare function useServiceVersion<S extends Service<any, any, any, any, any, any>>(service: S): ReturnType<S["getSnapshot"]>;
Name
Kind
Type
Requirement
service
parameter
S
required
return
return value
ReturnType<S["getSnapshot"]>
n/a
Name
service
Kind
parameter
Type
S
Requirement
required
Name
return
Kind
return value
Type
ReturnType<S["getSnapshot"]>
Requirement
n/a

@grassroot/ui-headless-vue/combobox

Vue adapter

21 exports
View source packages/ui-headless/vue/src/combobox/index.ts

ComboboxContent

value
DeclarationView source
ComboboxContentts
export declare const ComboboxContent: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

ComboboxContextKey

value
DeclarationView source
ComboboxContextKeyts
export declare const ComboboxContextKey: InjectionKey<ComboboxContextValue>;

ComboboxContextValue

interface
DeclarationView source
ComboboxContextValuets
interface ComboboxContextValue {
  readonly service: ComboboxService;
  readonly connector: ComboboxApi;
  readonly scope: PartScope;
  readonly snapshot: ShallowRef<ComboboxSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
ComboboxApi
required
scope
property
PartScope
required
service
property
ComboboxService
required
snapshot
property
ShallowRef<ComboboxSnapshot>
required
Name
connector
Kind
property
Type
ComboboxApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
ComboboxService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<ComboboxSnapshot>
Requirement
required

ComboboxControl

value
DeclarationView source
ComboboxControlts
export declare const ComboboxControl: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

ComboboxEmpty

value
DeclarationView source
ComboboxEmptyts
export declare const ComboboxEmpty: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

ComboboxHiddenInput

value
DeclarationView source
ComboboxHiddenInputts
export declare const ComboboxHiddenInput: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    default: undefined;
  };
  required: {
    type: BooleanConstructor;
    default: undefined;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>[], {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    default: undefined;
  };
  required: {
    type: BooleanConstructor;
    default: undefined;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
  name: string;
  required: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

ComboboxInput

value
DeclarationView source
ComboboxInputts
export declare const ComboboxInput: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

ComboboxInputValueChangeDetail

interface
DeclarationView source
ComboboxInputValueChangeDetailts
interface ComboboxInputValueChangeDetail {
  readonly inputValue: string;
  readonly reason: "input" | "programmatic";
}
Name
Kind
Type
Requirement
inputValue
property
string
required
reason
property
"input" | "programmatic"
required
Name
inputValue
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"input" | "programmatic"
Requirement
required

ComboboxItem

value
DeclarationView source
ComboboxItemts
export declare const ComboboxItem: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  option: {
    type: PropType<ComboboxOptionInput>;
    required: true;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  option: {
    type: PropType<ComboboxOptionInput>;
    required: true;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

ComboboxItemText

value
DeclarationView source
ComboboxItemTextts
export declare const ComboboxItemText: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  option: {
    type: PropType<ComboboxOptionInput>;
    required: true;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  option: {
    type: PropType<ComboboxOptionInput>;
    required: true;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

ComboboxLabel

value
DeclarationView source
ComboboxLabelts
export declare const ComboboxLabel: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

ComboboxOpenChangeDetail

interface
DeclarationView source
ComboboxOpenChangeDetailts
interface ComboboxOpenChangeDetail {
  readonly open: boolean;
  readonly reason: ComboboxChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
ComboboxChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
ComboboxChangeReason
Requirement
required

ComboboxPositioner

value
DeclarationView source
ComboboxPositionerts
export declare const ComboboxPositioner: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

ComboboxRoot

value
DeclarationView source
ComboboxRootts
export declare const ComboboxRoot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  options: {
    type: PropType<ComboboxInput["options"]>;
    required: true;
  };
  value: {
    type: PropType<ComboboxInput["value"]>;
    default: undefined;
  };
  defaultValue: {
    type: PropType<ComboboxInput["defaultValue"]>;
    default: undefined;
  };
  selectionMode: {
    type: PropType<ComboboxInput["selectionMode"]>;
    default: undefined;
  };
  open: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  defaultOpen: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  inputValue: {
    type: PropType<string | undefined>;
    default: undefined;
  };
  defaultInputValue: {
    type: PropType<string | undefined>;
    default: undefined;
  };
  loadOptions: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  runCommand: {
    type: PropType<UseComboboxOptions["runCommand"]>;
    default: undefined;
  };
  dir: {
    type: PropType<UseComboboxOptions["dir"]>;
    default: undefined;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
  openChange: (_detail: ComboboxOpenChangeDetail) => true;
  valueChange: (_detail: ComboboxValueChangeDetail) => true;
  inputValueChange: (_detail: ComboboxInputValueChangeDetail) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  options: {
    type: PropType<ComboboxInput["options"]>;
    required: true;
  };
  value: {
    type: PropType<ComboboxInput["value"]>;
    default: undefined;
  };
  defaultValue: {
    type: PropType<ComboboxInput["defaultValue"]>;
    default: undefined;
  };
  selectionMode: {
    type: PropType<ComboboxInput["selectionMode"]>;
    default: undefined;
  };
  open: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  defaultOpen: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  inputValue: {
    type: PropType<string | undefined>;
    default: undefined;
  };
  defaultInputValue: {
    type: PropType<string | undefined>;
    default: undefined;
  };
  loadOptions: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  runCommand: {
    type: PropType<UseComboboxOptions["runCommand"]>;
    default: undefined;
  };
  dir: {
    type: PropType<UseComboboxOptions["dir"]>;
    default: undefined;
  };
}>> & Readonly<{
  onInputValueChange?: ((_detail: ComboboxInputValueChangeDetail) => any) | undefined;
  onOpenChange?: ((_detail: ComboboxOpenChangeDetail) => any) | undefined;
  onValueChange?: ((_detail: ComboboxValueChangeDetail) => any) | undefined;
}>, {
  value: import("@grassroot/ui-machines/combobox").ComboboxValue | undefined;
  defaultValue: import("@grassroot/ui-machines/combobox").ComboboxValue | undefined;
  selectionMode: import("@grassroot/ui-machines/combobox").ComboboxSelectionMode | undefined;
  open: boolean | undefined;
  defaultOpen: boolean | undefined;
  inputValue: string | undefined;
  defaultInputValue: string | undefined;
  loadOptions: boolean | undefined;
  runCommand: import("@grassroot/ui-headless-core/combobox").ComboboxRunCommand | undefined;
  dir: "ltr" | "rtl" | undefined;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

ComboboxRootProvider

value
DeclarationView source
ComboboxRootProviderts
export declare const ComboboxRootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  value: {
    type: PropType<ReturnType<typeof useCombobox>>;
    required: true;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  value: {
    type: PropType<ReturnType<typeof useCombobox>>;
    required: true;
  };
}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

ComboboxTrigger

value
DeclarationView source
ComboboxTriggerts
export declare const ComboboxTrigger: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

ComboboxValueChangeDetail

interface
DeclarationView source
ComboboxValueChangeDetailts
interface ComboboxValueChangeDetail {
  readonly value: ComboboxValue;
  readonly reason: Exclude<ComboboxChangeReason, "input">;
}
Name
Kind
Type
Requirement
reason
property
Exclude<ComboboxChangeReason, "input">
required
value
property
ComboboxValue
required
Name
reason
Kind
property
Type
Exclude<ComboboxChangeReason, "input">
Requirement
required
Name
value
Kind
property
Type
ComboboxValue
Requirement
required

useCombobox

function
DeclarationView source
useComboboxts
declare function useCombobox(input: ComboboxInput | (() => ComboboxInput), options?: UseComboboxOptions): UseComboboxResult;
Name
Kind
Type
Requirement
input
parameter
ComboboxInput | (() => ComboboxInput)
required
options
parameter
UseComboboxOptions
optional
return
return value
UseComboboxResult
n/a
Name
input
Kind
parameter
Type
ComboboxInput | (() => ComboboxInput)
Requirement
required
Name
options
Kind
parameter
Type
UseComboboxOptions
Requirement
optional
Name
return
Kind
return value
Type
UseComboboxResult
Requirement
n/a

useComboboxContext

function
DeclarationView source
useComboboxContextts
declare function useComboboxContext(partName: string): ComboboxContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
ComboboxContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
ComboboxContextValue
Requirement
n/a

UseComboboxOptions

interface
DeclarationView source
UseComboboxOptionsts
interface UseComboboxOptions {
  readonly dir?: "ltr" | "rtl";
  readonly onOpenChange?: (detail: ComboboxOpenChangeDetail) => void;
  readonly onValueChange?: (detail: ComboboxValueChangeDetail) => void;
  readonly onInputValueChange?: (detail: ComboboxInputValueChangeDetail) => void;
  readonly runCommand?: ComboboxRunCommand;
}
Name
Kind
Type
Requirement
dir
property
"ltr" | "rtl"
optional
onInputValueChange
property
(detail: ComboboxInputValueChangeDetail) => void
optional
onOpenChange
property
(detail: ComboboxOpenChangeDetail) => void
optional
onValueChange
property
(detail: ComboboxValueChangeDetail) => void
optional
runCommand
property
ComboboxRunCommand
optional
Name
dir
Kind
property
Type
"ltr" | "rtl"
Requirement
optional
Name
onInputValueChange
Kind
property
Type
(detail: ComboboxInputValueChangeDetail) => void
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: ComboboxOpenChangeDetail) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: ComboboxValueChangeDetail) => void
Requirement
optional
Name
runCommand
Kind
property
Type
ComboboxRunCommand
Requirement
optional

UseComboboxResult

interface
DeclarationView source
UseComboboxResultts
interface UseComboboxResult {
  readonly service: ComboboxService;
  readonly connector: ComboboxApi;
  readonly scope: PartScope;
  readonly snapshot: ShallowRef<ComboboxSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
ComboboxApi
required
scope
property
PartScope
required
service
property
ComboboxService
required
snapshot
property
ShallowRef<ComboboxSnapshot>
required
Name
connector
Kind
property
Type
ComboboxApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
ComboboxService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<ComboboxSnapshot>
Requirement
required

@grassroot/ui-headless-angular/combobox

Angular adapter

20 exports
View source packages/ui-headless/angular/src/combobox/index.ts

COMBOBOX_STORE

value
DeclarationView source
COMBOBOX_STOREts
export declare const COMBOBOX_STORE: InjectionToken<ComboboxStore>;

ComboboxInputValueChangeDetail

interface
DeclarationView source
ComboboxInputValueChangeDetailts
export interface ComboboxInputValueChangeDetail {
    readonly inputValue: string;
    readonly reason: "input" | "programmatic";
}
Name
Kind
Type
Requirement
inputValue
property
string
required
reason
property
"input" | "programmatic"
required
Name
inputValue
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"input" | "programmatic"
Requirement
required

ComboboxOpenChangeDetail

interface
DeclarationView source
ComboboxOpenChangeDetailts
export interface ComboboxOpenChangeDetail {
    readonly open: boolean;
    readonly reason: ComboboxChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
ComboboxChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
ComboboxChangeReason
Requirement
required

ComboboxRunCommand

type
DeclarationView source
ComboboxRunCommandts
type ComboboxRunCommand = RunCommand<ComboboxCommand, ComboboxEvent>;

ComboboxStore

interface
DeclarationView source
ComboboxStorets
export interface ComboboxStore {
    readonly service: ComboboxService;
    readonly connector: ComboboxApi;
    readonly scope: PartScope;
    readonly version: WritableSignal<number>;
    start(): void;
    stop(): void;
    sync(input: ComboboxInput): void;
}
Name
Kind
Type
Requirement
connector
property
ComboboxApi
required
scope
property
PartScope
required
service
property
ComboboxService
required
start
method
() => void
required
stop
method
() => void
required
sync
method
(input: ComboboxInput) => void
required
version
property
WritableSignal<number>
required
Name
connector
Kind
property
Type
ComboboxApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
ComboboxService
Requirement
required
Name
start
Kind
method
Type
() => void
Requirement
required
Name
stop
Kind
method
Type
() => void
Requirement
required
Name
sync
Kind
method
Type
(input: ComboboxInput) => void
Requirement
required
Name
version
Kind
property
Type
WritableSignal<number>
Requirement
required

ComboboxValueChangeDetail

interface
DeclarationView source
ComboboxValueChangeDetailts
export interface ComboboxValueChangeDetail {
    readonly value: ComboboxValue;
    readonly reason: Exclude<ComboboxChangeReason, "input">;
}
Name
Kind
Type
Requirement
reason
property
Exclude<ComboboxChangeReason, "input">
required
value
property
ComboboxValue
required
Name
reason
Kind
property
Type
Exclude<ComboboxChangeReason, "input">
Requirement
required
Name
value
Kind
property
Type
ComboboxValue
Requirement
required

createComboboxStore

function
DeclarationView source
createComboboxStorets
export declare function createComboboxStore(initialInput: ComboboxInput, options?: ComboboxOptions): ComboboxStore;
Name
Kind
Type
Requirement
initialInput
parameter
ComboboxInput
required
options
parameter
ComboboxOptions
optional
return
return value
ComboboxStore
n/a
Name
initialInput
Kind
parameter
Type
ComboboxInput
Requirement
required
Name
options
Kind
parameter
Type
ComboboxOptions
Requirement
optional
Name
return
Kind
return value
Type
ComboboxStore
Requirement
n/a

GR_COMBOBOX_DECLARATIONS

value
DeclarationView source
GR_COMBOBOX_DECLARATIONSts
export declare const GR_COMBOBOX_DECLARATIONS: readonly [typeof GrComboboxRoot, typeof GrComboboxLabel, typeof GrComboboxControl, typeof GrComboboxInput, typeof GrComboboxTrigger, typeof GrComboboxOpen, typeof GrComboboxPositioner, typeof GrComboboxContent, typeof GrComboboxItem, typeof GrComboboxItemText, typeof GrComboboxEmpty, typeof GrComboboxHiddenInput];

GrComboboxContent

class
DeclarationView source
GrComboboxContentts
export declare class GrComboboxContent extends ComboboxPart {
    constructor();
    static ɵfac: i0.ɵɵFactoryDeclaration<GrComboboxContent, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrComboboxContent, "[grComboboxContent]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrComboboxContent, "[grComboboxContent]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrComboboxContent, never>
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrComboboxContent, "[grComboboxContent]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrComboboxContent, never>
Requirement
required

GrComboboxControl

class
DeclarationView source
GrComboboxControlts
export declare class GrComboboxControl extends ComboboxPart {
    constructor();
    static ɵfac: i0.ɵɵFactoryDeclaration<GrComboboxControl, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrComboboxControl, "[grComboboxControl]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrComboboxControl, "[grComboboxControl]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrComboboxControl, never>
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrComboboxControl, "[grComboboxControl]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrComboboxControl, never>
Requirement
required

GrComboboxEmpty

class
DeclarationView source
GrComboboxEmptyts
export declare class GrComboboxEmpty extends ComboboxPart {
    constructor();
    static ɵfac: i0.ɵɵFactoryDeclaration<GrComboboxEmpty, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrComboboxEmpty, "[grComboboxEmpty]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrComboboxEmpty, "[grComboboxEmpty]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrComboboxEmpty, never>
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrComboboxEmpty, "[grComboboxEmpty]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrComboboxEmpty, never>
Requirement
required

GrComboboxHiddenInput

class
DeclarationView source
GrComboboxHiddenInputts
export declare class GrComboboxHiddenInput implements OnDestroy {
    readonly name: InputSignal<string | undefined>;
    readonly required: InputSignal<boolean | undefined>;
    private readonly store;
    private readonly element;
    private readonly consumerProps;
    private readonly primaryListeners;
    private readonly extraInputs;
    private readonly extraListeners;
    private form;
    private readonly onReset;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrComboboxHiddenInput, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrComboboxHiddenInput, "[grComboboxHiddenInput]", never, { "name": { "alias": "name"; "required": false; "isSignal": true; }; "required": { "alias": "required"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
element
property
any
required
extraInputs
property
any
required
extraListeners
property
any
required
form
property
any
required
name
property
InputSignal<string | undefined>
required
ngOnDestroy
method
() => void
required
onReset
property
any
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrComboboxHiddenInput, "[grComboboxHiddenInput]", never, { "name": { "alias": "name"; "required": false; "isSignal": true; }; "required": { "alias": "required"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrComboboxHiddenInput, never>
required
primaryListeners
property
any
required
required
property
InputSignal<boolean | undefined>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
extraInputs
Kind
property
Type
any
Requirement
required
Name
extraListeners
Kind
property
Type
any
Requirement
required
Name
form
Kind
property
Type
any
Requirement
required
Name
name
Kind
property
Type
InputSignal<string | undefined>
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
onReset
Kind
property
Type
any
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrComboboxHiddenInput, "[grComboboxHiddenInput]", never, { "name": { "alias": "name"; "required": false; "isSignal": true; }; "required": { "alias": "required"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrComboboxHiddenInput, never>
Requirement
required
Name
primaryListeners
Kind
property
Type
any
Requirement
required
Name
required
Kind
property
Type
InputSignal<boolean | undefined>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrComboboxInput

class
DeclarationView source
GrComboboxInputts
export declare class GrComboboxInput extends ComboboxPart {
    constructor();
    static ɵfac: i0.ɵɵFactoryDeclaration<GrComboboxInput, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrComboboxInput, "[grComboboxInput]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrComboboxInput, "[grComboboxInput]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrComboboxInput, never>
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrComboboxInput, "[grComboboxInput]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrComboboxInput, never>
Requirement
required

GrComboboxItem

class
DeclarationView source
GrComboboxItemts
export declare class GrComboboxItem implements OnDestroy {
    readonly option: InputSignal<ComboboxOptionInput>;
    private readonly store;
    private readonly element;
    private readonly listeners;
    private readonly consumerProps;
    private key;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrComboboxItem, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrComboboxItem, "[grComboboxItem]", never, { "option": { "alias": "option"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
element
property
any
required
key
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
option
property
InputSignal<ComboboxOptionInput>
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrComboboxItem, "[grComboboxItem]", never, { "option": { "alias": "option"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrComboboxItem, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
key
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
option
Kind
property
Type
InputSignal<ComboboxOptionInput>
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrComboboxItem, "[grComboboxItem]", never, { "option": { "alias": "option"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrComboboxItem, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrComboboxItemText

class
DeclarationView source
GrComboboxItemTextts
export declare class GrComboboxItemText implements OnDestroy {
    readonly option: InputSignal<ComboboxOptionInput>;
    private readonly store;
    private readonly element;
    private readonly listeners;
    private readonly consumerProps;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrComboboxItemText, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrComboboxItemText, "[grComboboxItemText]", never, { "option": { "alias": "option"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
option
property
InputSignal<ComboboxOptionInput>
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrComboboxItemText, "[grComboboxItemText]", never, { "option": { "alias": "option"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrComboboxItemText, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
option
Kind
property
Type
InputSignal<ComboboxOptionInput>
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrComboboxItemText, "[grComboboxItemText]", never, { "option": { "alias": "option"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrComboboxItemText, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrComboboxLabel

class
DeclarationView source
GrComboboxLabelts
export declare class GrComboboxLabel extends ComboboxPart {
    constructor();
    static ɵfac: i0.ɵɵFactoryDeclaration<GrComboboxLabel, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrComboboxLabel, "[grComboboxLabel]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrComboboxLabel, "[grComboboxLabel]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrComboboxLabel, never>
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrComboboxLabel, "[grComboboxLabel]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrComboboxLabel, never>
Requirement
required

GrComboboxOpen

class
DeclarationView source
GrComboboxOpents
export declare class GrComboboxOpen implements OnDestroy {
    private readonly store;
    private readonly template;
    private readonly view;
    private mounted;
    private release;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrComboboxOpen, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrComboboxOpen, "[grComboboxOpen]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
mounted
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrComboboxOpen, "[grComboboxOpen]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrComboboxOpen, never>
required
release
property
any
required
store
property
any
required
template
property
any
required
view
property
any
required
Name
mounted
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrComboboxOpen, "[grComboboxOpen]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrComboboxOpen, never>
Requirement
required
Name
release
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
Name
template
Kind
property
Type
any
Requirement
required
Name
view
Kind
property
Type
any
Requirement
required

GrComboboxPositioner

class
DeclarationView source
GrComboboxPositionerts
export declare class GrComboboxPositioner extends ComboboxPart {
    constructor();
    static ɵfac: i0.ɵɵFactoryDeclaration<GrComboboxPositioner, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrComboboxPositioner, "[grComboboxPositioner]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrComboboxPositioner, "[grComboboxPositioner]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrComboboxPositioner, never>
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrComboboxPositioner, "[grComboboxPositioner]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrComboboxPositioner, never>
Requirement
required

GrComboboxRoot

class
DeclarationView source
GrComboboxRootts
export declare class GrComboboxRoot implements OnInit, OnDestroy {
    readonly options: InputSignal<readonly ComboboxOptionInput[]>;
    readonly value: InputSignal<import("@grassroot/ui-machines/combobox").ComboboxValue | undefined>;
    readonly defaultValue: InputSignal<import("@grassroot/ui-machines/combobox").ComboboxValue | undefined>;
    readonly selectionMode: InputSignal<import("@grassroot/ui-machines/combobox").ComboboxSelectionMode | undefined>;
    readonly open: InputSignal<boolean | undefined>;
    readonly defaultOpen: InputSignal<boolean | undefined>;
    readonly inputValue: InputSignal<string | undefined>;
    readonly defaultInputValue: InputSignal<string | undefined>;
    readonly loadOptions: InputSignal<boolean | undefined>;
    readonly runCommand: InputSignal<ComboboxRunCommand | undefined>;
    readonly openChange: import("@angular/core").OutputEmitterRef<ComboboxOpenChangeDetail>;
    readonly valueChange: import("@angular/core").OutputEmitterRef<ComboboxValueChangeDetail>;
    readonly inputValueChange: import("@angular/core").OutputEmitterRef<ComboboxInputValueChangeDetail>;
    private readonly element;
    private readonly listeners;
    private readonly consumerProps;
    readonly store: ComboboxStore;
    constructor();
    ngOnInit(): void;
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrComboboxRoot, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrComboboxRoot, "[grComboboxRoot]", never, { "options": { "alias": "options"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "selectionMode": { "alias": "selectionMode"; "required": false; "isSignal": true; }; "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "inputValue": { "alias": "inputValue"; "required": false; "isSignal": true; }; "defaultInputValue": { "alias": "defaultInputValue"; "required": false; "isSignal": true; }; "loadOptions": { "alias": "loadOptions"; "required": false; "isSignal": true; }; "runCommand": { "alias": "runCommand"; "required": false; "isSignal": true; }; }, { "openChange": "openChange"; "valueChange": "valueChange"; "inputValueChange": "inputValueChange"; }, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
defaultInputValue
property
InputSignal<string | undefined>
required
defaultOpen
property
InputSignal<boolean | undefined>
required
defaultValue
property
InputSignal<import("@grassroot/ui-machines/combobox").ComboboxValue | undefined>
required
element
property
any
required
inputValue
property
InputSignal<string | undefined>
required
inputValueChange
property
import("@angular/core").OutputEmitterRef<ComboboxInputValueChangeDetail>
required
listeners
property
any
required
loadOptions
property
InputSignal<boolean | undefined>
required
ngOnDestroy
method
() => void
required
ngOnInit
method
() => void
required
open
property
InputSignal<boolean | undefined>
required
openChange
property
import("@angular/core").OutputEmitterRef<ComboboxOpenChangeDetail>
required
options
property
InputSignal<readonly ComboboxOptionInput[]>
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
defaultInputValue
Kind
property
Type
InputSignal<string | undefined>
Requirement
required
Name
defaultOpen
Kind
property
Type
InputSignal<boolean | undefined>
Requirement
required
Name
defaultValue
Kind
property
Type
InputSignal<import("@grassroot/ui-machines/combobox").ComboboxValue | undefined>
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
inputValue
Kind
property
Type
InputSignal<string | undefined>
Requirement
required
Name
inputValueChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<ComboboxInputValueChangeDetail>
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
loadOptions
Kind
property
Type
InputSignal<boolean | undefined>
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ngOnInit
Kind
method
Type
() => void
Requirement
required
Name
open
Kind
property
Type
InputSignal<boolean | undefined>
Requirement
required
Name
openChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<ComboboxOpenChangeDetail>
Requirement
required
Name
options
Kind
property
Type
InputSignal<readonly ComboboxOptionInput[]>
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrComboboxRoot, "[grComboboxRoot]", never, { "options": { "alias": "options"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "selectionMode": { "alias": "selectionMode"; "required": false; "isSignal": true; }; "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "inputValue": { "alias": "inputValue"; "required": false; "isSignal": true; }; "defaultInputValue": { "alias": "defaultInputValue"; "required": false; "isSignal": true; }; "loadOptions": { "alias": "loadOptions"; "required": false; "isSignal": true; }; "runCommand": { "alias": "runCommand"; "required": false; "isSignal": true; }; }, { "openChange": "openChange"; "valueChange": "valueChange"; "inputValueChange": "inputValueChange"; }, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrComboboxRoot, never>
Requirement
required
Name
runCommand
Kind
property
Type
InputSignal<ComboboxRunCommand | undefined>
Requirement
required
Name
selectionMode
Kind
property
Type
InputSignal<import("@grassroot/ui-machines/combobox").ComboboxSelectionMode | undefined>
Requirement
required
Name
store
Kind
property
Type
ComboboxStore
Requirement
required
Name
value
Kind
property
Type
InputSignal<import("@grassroot/ui-machines/combobox").ComboboxValue | undefined>
Requirement
required
Name
valueChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<ComboboxValueChangeDetail>
Requirement
required

GrComboboxTrigger

class
DeclarationView source
GrComboboxTriggerts
export declare class GrComboboxTrigger extends ComboboxPart {
    readonly ariaLabel: InputSignal<string | undefined>;
    readonly ariaLabelledby: InputSignal<string | undefined>;
    constructor();
    static ɵfac: i0.ɵɵFactoryDeclaration<GrComboboxTrigger, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrComboboxTrigger, "[grComboboxTrigger]", never, { "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "ariaLabelledby": { "alias": "ariaLabelledby"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ariaLabel
property
InputSignal<string | undefined>
required
ariaLabelledby
property
InputSignal<string | undefined>
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrComboboxTrigger, "[grComboboxTrigger]", never, { "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "ariaLabelledby": { "alias": "ariaLabelledby"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrComboboxTrigger, never>
required
Name
ariaLabel
Kind
property
Type
InputSignal<string | undefined>
Requirement
required
Name
ariaLabelledby
Kind
property
Type
InputSignal<string | undefined>
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrComboboxTrigger, "[grComboboxTrigger]", never, { "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "ariaLabelledby": { "alias": "ariaLabelledby"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrComboboxTrigger, never>
Requirement
required

@grassroot/ui-headless-svelte/combobox

Svelte adapter

19 exports
View source packages/ui-headless/svelte/src/combobox/index.ts

ComboboxContent

value
DeclarationView source
ComboboxContentts
export declare const ComboboxContent: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

ComboboxControl

value
DeclarationView source
ComboboxControlts
export declare const ComboboxControl: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

ComboboxEmpty

value
DeclarationView source
ComboboxEmptyts
export declare const ComboboxEmpty: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

ComboboxHiddenInput

value
DeclarationView source
ComboboxHiddenInputts
export declare const ComboboxHiddenInput: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

ComboboxInput

value
DeclarationView source
ComboboxInputts
export declare const ComboboxInput: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

ComboboxInputValueChangeDetail

interface
DeclarationView source
ComboboxInputValueChangeDetailts
export interface ComboboxInputValueChangeDetail {
    readonly inputValue: string;
    readonly reason: "input" | "programmatic";
}
Name
Kind
Type
Requirement
inputValue
property
string
required
reason
property
"input" | "programmatic"
required
Name
inputValue
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"input" | "programmatic"
Requirement
required

ComboboxItem

value
DeclarationView source
ComboboxItemts
export declare const ComboboxItem: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

ComboboxItemText

value
DeclarationView source
ComboboxItemTextts
export declare const ComboboxItemText: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

ComboboxLabel

value
DeclarationView source
ComboboxLabelts
export declare const ComboboxLabel: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

ComboboxOpenChangeDetail

interface
DeclarationView source
ComboboxOpenChangeDetailts
export interface ComboboxOpenChangeDetail {
    readonly open: boolean;
    readonly reason: ComboboxChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
ComboboxChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
ComboboxChangeReason
Requirement
required

ComboboxPositioner

value
DeclarationView source
ComboboxPositionerts
export declare const ComboboxPositioner: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

ComboboxRoot

value
DeclarationView source
ComboboxRootts
export declare const ComboboxRoot: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

ComboboxRootProvider

value
DeclarationView source
ComboboxRootProviderts
export declare const ComboboxRootProvider: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

ComboboxTrigger

value
DeclarationView source
ComboboxTriggerts
export declare const ComboboxTrigger: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

ComboboxValueChangeDetail

interface
DeclarationView source
ComboboxValueChangeDetailts
export interface ComboboxValueChangeDetail {
    readonly value: ComboboxValue;
    readonly reason: Exclude<ComboboxChangeReason, "input">;
}
Name
Kind
Type
Requirement
reason
property
Exclude<ComboboxChangeReason, "input">
required
value
property
ComboboxValue
required
Name
reason
Kind
property
Type
Exclude<ComboboxChangeReason, "input">
Requirement
required
Name
value
Kind
property
Type
ComboboxValue
Requirement
required

createCombobox

function
DeclarationView source
createComboboxts
export declare function createCombobox(inputGetter: () => ComboboxInput, options?: UseComboboxOptions): UseComboboxResult;
Name
Kind
Type
Requirement
inputGetter
parameter
() => ComboboxInput
required
options
parameter
UseComboboxOptions
optional
return
return value
UseComboboxResult
n/a
Name
inputGetter
Kind
parameter
Type
() => ComboboxInput
Requirement
required
Name
options
Kind
parameter
Type
UseComboboxOptions
Requirement
optional
Name
return
Kind
return value
Type
UseComboboxResult
Requirement
n/a

useComboboxContext

function
DeclarationView source
useComboboxContextts
export declare function useComboboxContext(partName: string): ComboboxContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
ComboboxContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
ComboboxContextValue
Requirement
n/a

UseComboboxOptions

interface
DeclarationView source
UseComboboxOptionsts
export interface UseComboboxOptions {
    readonly dir?: "ltr" | "rtl";
    readonly onOpenChange?: (detail: ComboboxOpenChangeDetail) => void;
    readonly onValueChange?: (detail: ComboboxValueChangeDetail) => void;
    readonly onInputValueChange?: (detail: ComboboxInputValueChangeDetail) => void;
    readonly runCommand?: ComboboxRunCommand;
}
Name
Kind
Type
Requirement
dir
property
"ltr" | "rtl"
optional
onInputValueChange
property
(detail: ComboboxInputValueChangeDetail) => void
optional
onOpenChange
property
(detail: ComboboxOpenChangeDetail) => void
optional
onValueChange
property
(detail: ComboboxValueChangeDetail) => void
optional
runCommand
property
ComboboxRunCommand
optional
Name
dir
Kind
property
Type
"ltr" | "rtl"
Requirement
optional
Name
onInputValueChange
Kind
property
Type
(detail: ComboboxInputValueChangeDetail) => void
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: ComboboxOpenChangeDetail) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: ComboboxValueChangeDetail) => void
Requirement
optional
Name
runCommand
Kind
property
Type
ComboboxRunCommand
Requirement
optional

UseComboboxResult

interface
DeclarationView source
UseComboboxResultts
export interface UseComboboxResult {
    readonly service: ComboboxService;
    readonly connector: ComboboxApi;
    readonly scope: PartScope;
    readonly version: () => number;
    readonly snapshot: () => ComboboxSnapshot;
}
Name
Kind
Type
Requirement
connector
property
ComboboxApi
required
scope
property
PartScope
required
service
property
ComboboxService
required
snapshot
property
() => ComboboxSnapshot
required
version
property
() => number
required
Name
connector
Kind
property
Type
ComboboxApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
ComboboxService
Requirement
required
Name
snapshot
Kind
property
Type
() => ComboboxSnapshot
Requirement
required
Name
version
Kind
property
Type
() => number
Requirement
required

@grassroot/ui-headless-solid/combobox

Solid adapter

23 exports
View source packages/ui-headless/solid/src/combobox/index.ts

ComboboxContent

value
DeclarationView source
ComboboxContentts
export declare const ComboboxContent: (props: {
    as?: AsProp;
    children?: JSX.Element;
} & Record<string, unknown>) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

ComboboxContext

value
DeclarationView source
ComboboxContextts
export declare const ComboboxContext: import("solid-js").Context<ComboboxContextValue | undefined>;

ComboboxContextValue

interface
DeclarationView source
ComboboxContextValuets
export interface ComboboxContextValue {
    readonly service: ComboboxService;
    readonly connector: ComboboxApi;
    readonly scope: PartScope;
    readonly snapshot: Accessor<ComboboxSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
ComboboxApi
required
scope
property
PartScope
required
service
property
ComboboxService
required
snapshot
property
Accessor<ComboboxSnapshot>
required
Name
connector
Kind
property
Type
ComboboxApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
ComboboxService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<ComboboxSnapshot>
Requirement
required

ComboboxControl

value
DeclarationView source
ComboboxControlts
export declare const ComboboxControl: (props: {
    as?: AsProp;
    children?: JSX.Element;
} & Record<string, unknown>) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

ComboboxEmpty

value
DeclarationView source
ComboboxEmptyts
export declare const ComboboxEmpty: (props: {
    as?: AsProp;
    children?: JSX.Element;
} & Record<string, unknown>) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

ComboboxHiddenInput

function
DeclarationView source
ComboboxHiddenInputts
export declare function ComboboxHiddenInput(props: {
    name?: string;
    required?: boolean;
    as?: AsProp;
} & JSX.InputHTMLAttributes<HTMLInputElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ name?: string; required?: boolean; as?: AsProp; } & JSX.InputHTMLAttributes<HTMLInputElement>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ name?: string; required?: boolean; as?: AsProp; } & JSX.InputHTMLAttributes<HTMLInputElement>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

ComboboxInput

value
DeclarationView source
ComboboxInputts
export declare const ComboboxInput: (props: {
    as?: AsProp;
    children?: JSX.Element;
} & Record<string, unknown>) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

ComboboxInputValueChangeDetail

interface
DeclarationView source
ComboboxInputValueChangeDetailts
export interface ComboboxInputValueChangeDetail {
    readonly inputValue: string;
    readonly reason: "input" | "programmatic";
}
Name
Kind
Type
Requirement
inputValue
property
string
required
reason
property
"input" | "programmatic"
required
Name
inputValue
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"input" | "programmatic"
Requirement
required

ComboboxItem

function
DeclarationView source
ComboboxItemts
export declare function ComboboxItem(props: {
    as?: AsProp;
    option: ComboboxOptionInput;
    children?: JSX.Element;
} & JSX.HTMLAttributes<HTMLDivElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ as?: AsProp; option: ComboboxOptionInput; children?: JSX.Element; } & JSX.HTMLAttributes<HTMLDivElement>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ as?: AsProp; option: ComboboxOptionInput; children?: JSX.Element; } & JSX.HTMLAttributes<HTMLDivElement>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

ComboboxItemText

function
DeclarationView source
ComboboxItemTextts
export declare function ComboboxItemText(props: {
    as?: AsProp;
    option: ComboboxOptionInput;
    children?: JSX.Element;
} & JSX.HTMLAttributes<HTMLSpanElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ as?: AsProp; option: ComboboxOptionInput; children?: JSX.Element; } & JSX.HTMLAttributes<HTMLSpanElement>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ as?: AsProp; option: ComboboxOptionInput; children?: JSX.Element; } & JSX.HTMLAttributes<HTMLSpanElement>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

ComboboxLabel

value
DeclarationView source
ComboboxLabelts
export declare const ComboboxLabel: (props: {
    as?: AsProp;
    children?: JSX.Element;
} & Record<string, unknown>) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

ComboboxOpenChangeDetail

interface
DeclarationView source
ComboboxOpenChangeDetailts
export interface ComboboxOpenChangeDetail {
    readonly open: boolean;
    readonly reason: ComboboxChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
ComboboxChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
ComboboxChangeReason
Requirement
required

ComboboxPositioner

value
DeclarationView source
ComboboxPositionerts
export declare const ComboboxPositioner: (props: {
    as?: AsProp;
    children?: JSX.Element;
} & Record<string, unknown>) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

ComboboxRoot

function
DeclarationView source
ComboboxRootts
export declare function ComboboxRoot(props: ComboboxRootProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
ComboboxRootProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
ComboboxRootProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

ComboboxRootProps

interface
DeclarationView source
ComboboxRootPropsts
export interface ComboboxRootProps extends JSX.HTMLAttributes<HTMLDivElement> {
    readonly options: ComboboxInput["options"];
    readonly selectionMode?: ComboboxInput["selectionMode"];
    readonly value?: ComboboxInput["value"];
    readonly defaultValue?: ComboboxInput["defaultValue"];
    readonly open?: boolean;
    readonly defaultOpen?: boolean;
    readonly inputValue?: string;
    readonly defaultInputValue?: string;
    readonly loadOptions?: boolean;
    readonly runCommand?: UseComboboxOptions["runCommand"];
    readonly dir?: UseComboboxOptions["dir"];
    readonly onOpenChange?: (detail: ComboboxOpenChangeDetail) => void;
    readonly onValueChange?: (detail: ComboboxValueChangeDetail) => void;
    readonly onInputValueChange?: (detail: ComboboxInputValueChangeDetail) => void;
}
Name
Kind
Type
Requirement
defaultInputValue
property
string
optional
defaultOpen
property
boolean
optional
defaultValue
property
ComboboxInput["defaultValue"]
optional
dir
property
UseComboboxOptions["dir"]
optional
inputValue
property
string
optional
loadOptions
property
boolean
optional
onInputValueChange
property
(detail: ComboboxInputValueChangeDetail) => void
optional
onOpenChange
property
(detail: ComboboxOpenChangeDetail) => void
optional
onValueChange
property
(detail: ComboboxValueChangeDetail) => void
optional
open
property
boolean
optional
options
property
ComboboxInput["options"]
required
runCommand
property
UseComboboxOptions["runCommand"]
optional
selectionMode
property
ComboboxInput["selectionMode"]
optional
value
property
ComboboxInput["value"]
optional
Name
defaultInputValue
Kind
property
Type
string
Requirement
optional
Name
defaultOpen
Kind
property
Type
boolean
Requirement
optional
Name
defaultValue
Kind
property
Type
ComboboxInput["defaultValue"]
Requirement
optional
Name
dir
Kind
property
Type
UseComboboxOptions["dir"]
Requirement
optional
Name
inputValue
Kind
property
Type
string
Requirement
optional
Name
loadOptions
Kind
property
Type
boolean
Requirement
optional
Name
onInputValueChange
Kind
property
Type
(detail: ComboboxInputValueChangeDetail) => void
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: ComboboxOpenChangeDetail) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: ComboboxValueChangeDetail) => void
Requirement
optional
Name
open
Kind
property
Type
boolean
Requirement
optional
Name
options
Kind
property
Type
ComboboxInput["options"]
Requirement
required
Name
runCommand
Kind
property
Type
UseComboboxOptions["runCommand"]
Requirement
optional
Name
selectionMode
Kind
property
Type
ComboboxInput["selectionMode"]
Requirement
optional
Name
value
Kind
property
Type
ComboboxInput["value"]
Requirement
optional

ComboboxRootProvider

function
DeclarationView source
ComboboxRootProviderts
export declare function ComboboxRootProvider(props: ComboboxRootProviderProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
ComboboxRootProviderProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
ComboboxRootProviderProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

ComboboxRootProviderProps

interface
DeclarationView source
ComboboxRootProviderPropsts
export interface ComboboxRootProviderProps extends JSX.HTMLAttributes<HTMLDivElement> {
    readonly value: UseComboboxResult;
}
Name
Kind
Type
Requirement
value
property
UseComboboxResult
required
Name
value
Kind
property
Type
UseComboboxResult
Requirement
required

ComboboxTrigger

value
DeclarationView source
ComboboxTriggerts
export declare const ComboboxTrigger: (props: {
    as?: AsProp;
    children?: JSX.Element;
} & Record<string, unknown>) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

ComboboxValueChangeDetail

interface
DeclarationView source
ComboboxValueChangeDetailts
export interface ComboboxValueChangeDetail {
    readonly value: ComboboxValue;
    readonly reason: Exclude<ComboboxChangeReason, "input">;
}
Name
Kind
Type
Requirement
reason
property
Exclude<ComboboxChangeReason, "input">
required
value
property
ComboboxValue
required
Name
reason
Kind
property
Type
Exclude<ComboboxChangeReason, "input">
Requirement
required
Name
value
Kind
property
Type
ComboboxValue
Requirement
required

useCombobox

function
DeclarationView source
useComboboxts
export declare function useCombobox(input: Accessor<ComboboxInput>, options?: UseComboboxOptions): UseComboboxResult;
Name
Kind
Type
Requirement
input
parameter
Accessor<ComboboxInput>
required
options
parameter
UseComboboxOptions
optional
return
return value
UseComboboxResult
n/a
Name
input
Kind
parameter
Type
Accessor<ComboboxInput>
Requirement
required
Name
options
Kind
parameter
Type
UseComboboxOptions
Requirement
optional
Name
return
Kind
return value
Type
UseComboboxResult
Requirement
n/a

useComboboxContext

function
DeclarationView source
useComboboxContextts
export declare function useComboboxContext(partName: string): ComboboxContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
ComboboxContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
ComboboxContextValue
Requirement
n/a

UseComboboxOptions

interface
DeclarationView source
UseComboboxOptionsts
export interface UseComboboxOptions {
    readonly dir?: "ltr" | "rtl";
    readonly onOpenChange?: (detail: ComboboxOpenChangeDetail) => void;
    readonly onValueChange?: (detail: ComboboxValueChangeDetail) => void;
    readonly onInputValueChange?: (detail: ComboboxInputValueChangeDetail) => void;
    readonly runCommand?: ComboboxRunCommand;
}
Name
Kind
Type
Requirement
dir
property
"ltr" | "rtl"
optional
onInputValueChange
property
(detail: ComboboxInputValueChangeDetail) => void
optional
onOpenChange
property
(detail: ComboboxOpenChangeDetail) => void
optional
onValueChange
property
(detail: ComboboxValueChangeDetail) => void
optional
runCommand
property
ComboboxRunCommand
optional
Name
dir
Kind
property
Type
"ltr" | "rtl"
Requirement
optional
Name
onInputValueChange
Kind
property
Type
(detail: ComboboxInputValueChangeDetail) => void
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: ComboboxOpenChangeDetail) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: ComboboxValueChangeDetail) => void
Requirement
optional
Name
runCommand
Kind
property
Type
ComboboxRunCommand
Requirement
optional

UseComboboxResult

interface
DeclarationView source
UseComboboxResultts
export interface UseComboboxResult {
    readonly service: ComboboxService;
    readonly connector: ComboboxApi;
    readonly scope: PartScope;
    readonly snapshot: Accessor<ComboboxSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
ComboboxApi
required
scope
property
PartScope
required
service
property
ComboboxService
required
snapshot
property
Accessor<ComboboxSnapshot>
required
Name
connector
Kind
property
Type
ComboboxApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
ComboboxService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<ComboboxSnapshot>
Requirement
required