- Name
service- Kind
- parameter
- Type
CommandService<Item>- Requirement
- required
DocsAPI referenceHeadlesscommand
command 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.
@grassroot/ui-headless-core/command
Core connector and vanilla API
activateCommandLayer
functiondeclare function activateCommandLayer<Item extends CommandItem>(service: CommandService<Item>, scope: PartScope, document: Document): () => void;serviceCommandService<Item>scopePartScopedocumentDocumentreturn() => void- Name
scope- Kind
- parameter
- Type
PartScope- Requirement
- required
- Name
document- Kind
- parameter
- Type
Document- Requirement
- required
- Name
return- Kind
- return value
- Type
() => void- Requirement
- n/a
type CommandActionableItem = CommandItem & { readonly disabled?: boolean;};disabledboolean- Name
disabled- Kind
- property
- Type
boolean- Requirement
- optional
commandAnatomy
valueexport declare const commandAnatomy: { readonly scope: "command"; readonly parts: readonly ["root", "trigger", "input", "positioner", "content", "group", "group-label", "item", "item-text", "empty"];};partsreadonly ["root", "trigger", "input", "positioner", "content", "group", "group-label", "item", "item-text", "empty"]scope"command"- Name
parts- Kind
- property
- Type
readonly ["root", "trigger", "input", "positioner", "content", "group", "group-label", "item", "item-text", "empty"]- Requirement
- required
- Name
scope- Kind
- property
- Type
"command"- Requirement
- required
CommandApi
interfaceinterface CommandApi<Item extends CommandItem = CommandItem> { rootProps(): PartProps; triggerProps(): PartProps; inputProps(): PartProps; positionerProps(): PartProps; contentProps(): PartProps; groupProps(group: CommandGroup<Item>, index: number): PartProps; groupLabelProps(group: CommandGroup<Item>, index: number): PartProps; itemProps(item: Item, index?: number): PartProps; itemTextProps(item: Item): PartProps; emptyProps(): PartProps; readonly open: boolean; readonly value: string | undefined; readonly query: string; readonly activeIndex: number; readonly filteredGroups: readonly CommandGroup<Item>[]; readonly flatItems: readonly Item[];}activeIndexnumbercontentProps() => PartPropsemptyProps() => PartPropsfilteredGroupsreadonly CommandGroup<Item>[]flatItemsreadonly Item[]groupLabelProps(group: CommandGroup<Item>, index: number) => PartPropsgroupProps(group: CommandGroup<Item>, index: number) => PartPropsinputProps() => PartPropsitemProps(item: Item, index?: number) => PartPropsitemTextProps(item: Item) => PartPropsopenbooleanpositionerProps() => PartPropsquerystringrootProps() => PartProps- Name
activeIndex- Kind
- property
- Type
number- Requirement
- required
- Name
contentProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
emptyProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
filteredGroups- Kind
- property
- Type
readonly CommandGroup<Item>[]- Requirement
- required
- Name
flatItems- Kind
- property
- Type
readonly Item[]- Requirement
- required
- Name
groupLabelProps- Kind
- method
- Type
(group: CommandGroup<Item>, index: number) => PartProps- Requirement
- required
- Name
groupProps- Kind
- method
- Type
(group: CommandGroup<Item>, index: number) => PartProps- Requirement
- required
- Name
inputProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
itemProps- Kind
- method
- Type
(item: Item, index?: number) => PartProps- Requirement
- required
- Name
itemTextProps- Kind
- method
- Type
(item: Item) => PartProps- Requirement
- required
- Name
open- Kind
- property
- Type
boolean- Requirement
- required
- Name
positionerProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
query- Kind
- property
- Type
string- Requirement
- required
- Name
rootProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
triggerProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
value- Kind
- property
- Type
string | undefined- Requirement
- required
CommandBindingMode
typetype CommandBindingMode = "controlled" | "uncontrolled";CommandChangeReason
typetype CommandChangeReason = "pointer" | "keyboard" | "programmatic" | "trigger" | "input" | "escape" | "outside-click";CommandCommand
typetype CommandCommand = CommandObject & ({ readonly type: "VALUE_CHANGE_REQUEST"; readonly value: string; readonly reason: CommandSelectionReason;} | { readonly type: "OPEN_CHANGE_REQUEST"; readonly open: boolean; readonly reason: Exclude<CommandChangeReason, "input">;} | { readonly type: "QUERY_CHANGE_REQUEST"; readonly query: string; readonly reason: "input" | "programmatic";} | { readonly type: "FOCUS_PART"; readonly part: "input" | "panel";} | { readonly type: "ANNOUNCE"; readonly key: "selection-changed" | "results-available"; readonly params: { readonly label: string | null; readonly count: number | null; }; readonly politeness: "polite" | "assertive";});CommandConnectOptions
interfaceinterface CommandConnectOptions { readonly onValueChange?: (detail: { value: string; reason: CommandSelectionReason; }) => void; readonly onOpenChange?: (detail: { open: boolean; reason: Exclude<CommandChangeReason, "input">; }) => void; readonly onQueryChange?: (detail: { query: string; reason: "input" | "programmatic"; }) => void; readonly announce?: (key: "selection-changed" | "results-available", params: { readonly label: string | null; readonly count: number | null; }, politeness: "polite" | "assertive") => void;}announce(key: "selection-changed" | "results-available", params: {
readonly label: string | null;
readonly count: number | null;
}, politeness: "polite" | "assertive") => voidonOpenChange(detail: {
open: boolean;
reason: Exclude<CommandChangeReason, "input">;
}) => voidonQueryChange(detail: {
query: string;
reason: "input" | "programmatic";
}) => voidonValueChange(detail: {
value: string;
reason: CommandSelectionReason;
}) => void- Name
announce- Kind
- property
- Type
(key: "selection-changed" | "results-available", params: { readonly label: string | null; readonly count: number | null; }, politeness: "polite" | "assertive") => void- Requirement
- optional
- Name
onOpenChange- Kind
- property
- Type
(detail: { open: boolean; reason: Exclude<CommandChangeReason, "input">; }) => void- Requirement
- optional
- Name
onQueryChange- Kind
- property
- Type
(detail: { query: string; reason: "input" | "programmatic"; }) => void- Requirement
- optional
- Name
onValueChange- Kind
- property
- Type
(detail: { value: string; reason: CommandSelectionReason; }) => void- Requirement
- optional
CommandContext
interfaceinterface CommandContext<Item extends CommandItem = CommandItem> { readonly value: string | undefined; readonly open: boolean; readonly query: string; /** Index into the current flattened item list; filtering never creates a second index model. */ readonly highlightedIndex: number; readonly filteredGroups: readonly CommandGroup<Item>[]; readonly flatItems: readonly Item[]; readonly modes: CommandModes;}filteredGroupsreadonly CommandGroup<Item>[]flatItemsreadonly Item[]highlightedIndexnumbermodesCommandModesopenbooleanquerystringvaluestring | undefined- Name
filteredGroups- Kind
- property
- Type
readonly CommandGroup<Item>[]- Requirement
- required
- Description
- —
- Name
flatItems- Kind
- property
- Type
readonly Item[]- Requirement
- required
- Description
- —
- Name
highlightedIndex- Kind
- property
- Type
number- Requirement
- required
- Description
- Index into the current flattened item list; filtering never creates a second index model.
- Name
modes- Kind
- property
- Type
CommandModes- Requirement
- required
- Description
- —
- Name
open- Kind
- property
- Type
boolean- Requirement
- required
- Description
- —
- Name
query- Kind
- property
- Type
string- Requirement
- required
- Description
- —
- Name
value- Kind
- property
- Type
string | undefined- Requirement
- required
- Description
- —
CommandEvent
typetype CommandEvent = { readonly type: "OPEN"; readonly reason: Exclude<CommandChangeReason, "input">;} | { readonly type: "CLOSE"; readonly reason: Exclude<CommandChangeReason, "input">;} | { readonly type: "TOGGLE"; readonly reason: Exclude<CommandChangeReason, "input">;} | { readonly type: "SET_QUERY"; readonly query: string; readonly reason: "input" | "programmatic";} | { readonly type: "MOVE"; readonly direction: -1 | 1;} | { readonly type: "HIGHLIGHT"; readonly index: number;} | { readonly type: "SELECT"; readonly value: string; readonly reason: CommandSelectionReason;} | { readonly type: "RESET";};CommandFilter
typetype CommandFilter<Item extends CommandItem = CommandItem> = (item: Item, normalizedQuery: string) => boolean;CommandGroup
typetype CommandGroup<Item extends CommandItem = CommandItem> = CommandGroup$1<Item>;CommandInput
interfaceinterface CommandInput<Item extends CommandItem = CommandItem> { readonly groups: readonly CommandGroup<Item>[]; readonly value?: string; readonly defaultValue?: string; readonly open?: boolean; readonly defaultOpen?: boolean; readonly query?: string; readonly defaultQuery?: string; /** Replaces the default oracle predicate; the machine still owns grouping. */ readonly filter?: CommandFilter<Item>;}defaultOpenbooleandefaultQuerystringdefaultValuestringfilterCommandFilter<Item>groupsreadonly CommandGroup<Item>[]openbooleanquerystringvaluestring- Name
defaultOpen- Kind
- property
- Type
boolean- Requirement
- optional
- Description
- —
- Name
defaultQuery- Kind
- property
- Type
string- Requirement
- optional
- Description
- —
- Name
defaultValue- Kind
- property
- Type
string- Requirement
- optional
- Description
- —
- Name
filter- Kind
- property
- Type
CommandFilter<Item>- Requirement
- optional
- Description
- Replaces the default oracle predicate; the machine still owns grouping.
- Name
groups- Kind
- property
- Type
readonly CommandGroup<Item>[]- Requirement
- required
- Description
- —
- Name
open- Kind
- property
- Type
boolean- Requirement
- optional
- Description
- —
- Name
query- Kind
- property
- Type
string- Requirement
- optional
- Description
- —
- Name
value- Kind
- property
- Type
string- Requirement
- optional
- Description
- —
CommandItem
typetype CommandItem = CommandItem$1;commandMachine
valueexport declare const commandMachine: CommandMachine;CommandModes
interfaceinterface CommandModes { readonly value: CommandBindingMode; readonly open: CommandBindingMode; readonly query: CommandBindingMode;}openCommandBindingModequeryCommandBindingModevalueCommandBindingMode- Name
open- Kind
- property
- Type
CommandBindingMode- Requirement
- required
- Name
query- Kind
- property
- Type
CommandBindingMode- Requirement
- required
- Name
value- Kind
- property
- Type
CommandBindingMode- Requirement
- required
CommandMount
interfaceinterface CommandMount<Item extends CommandItem = CommandItem> { readonly service: CommandService<Item>; readonly connector: CommandApi<Item>; readonly root: HTMLElement; destroy(): void;}connectorCommandApi<Item>destroy() => voidrootHTMLElementserviceCommandService<Item>- Name
connector- Kind
- property
- Type
CommandApi<Item>- Requirement
- required
- Name
destroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
root- Kind
- property
- Type
HTMLElement- Requirement
- required
- Name
service- Kind
- property
- Type
CommandService<Item>- Requirement
- required
CommandOpenChangeDetail
interfaceinterface CommandOpenChangeDetail { readonly open: boolean; readonly reason: string;}openbooleanreasonstring- Name
open- Kind
- property
- Type
boolean- Requirement
- required
- Name
reason- Kind
- property
- Type
string- Requirement
- required
CommandPart
typetype CommandPart = (typeof parts)[number];CommandQueryChangeDetail
interfaceinterface CommandQueryChangeDetail { readonly query: string; readonly reason: "input" | "programmatic";}querystringreason"input" | "programmatic"- Name
query- Kind
- property
- Type
string- Requirement
- required
- Name
reason- Kind
- property
- Type
"input" | "programmatic"- Requirement
- required
type CommandSelectionReason = "pointer" | "keyboard" | "programmatic";commandSelectors
valueexport declare const commandSelectors: { value: <Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => string | undefined; open: <Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => boolean; query: <Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => string; highlightedIndex: <Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => number; filteredGroups: <Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => readonly CommandGroup<Item>[]; flatItems: <Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => readonly Item[];};filteredGroups<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => readonly CommandGroup<Item>[]flatItems<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => readonly Item[]highlightedIndex<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => numberopen<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => booleanquery<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => stringvalue<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => string | undefined- Name
filteredGroups- Kind
- property
- Type
<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => readonly CommandGroup<Item>[]- Requirement
- required
- Name
flatItems- Kind
- property
- Type
<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => readonly Item[]- Requirement
- required
- Name
highlightedIndex- Kind
- property
- Type
<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => number- Requirement
- required
- Name
open- Kind
- property
- Type
<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => boolean- Requirement
- required
- Name
query- Kind
- property
- Type
<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => string- Requirement
- required
- Name
value- Kind
- property
- Type
<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => string | undefined- Requirement
- required
CommandService
typetype CommandService<Item extends CommandItem = CommandItem> = Service<CommandInput<Item>, CommandStateValue, CommandContext<Item>, CommandEvent, CommandCommand>;CommandSnapshot
typetype CommandSnapshot<Item extends CommandItem = CommandItem> = Snapshot<CommandStateValue, CommandContext<Item>>;CommandStateValue
typetype CommandStateValue = "open" | "closed";CommandValueChangeDetail
interfaceinterface CommandValueChangeDetail { readonly value: string; readonly reason: string;}reasonstringvaluestring- Name
reason- Kind
- property
- Type
string- Requirement
- required
- Name
value- Kind
- property
- Type
string- Requirement
- required
connectCommand
functiondeclare function connectCommand<Item extends CommandItem = CommandItem>(service: CommandService<Item>, scope: PartScope, _options?: CommandConnectOptions): CommandApi<Item>;serviceCommandService<Item>scopePartScope_optionsCommandConnectOptionsreturnCommandApi<Item>- Name
service- Kind
- parameter
- Type
CommandService<Item>- Requirement
- required
- Name
scope- Kind
- parameter
- Type
PartScope- Requirement
- required
- Name
_options- Kind
- parameter
- Type
CommandConnectOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
CommandApi<Item>- Requirement
- n/a
mountCommand
functiondeclare function mountCommand<Item extends CommandItem = CommandItem>(container: HTMLElement, options: MountCommandOptions<Item>): CommandMount<Item>;containerHTMLElementoptionsMountCommandOptions<Item>returnCommandMount<Item>- Name
container- Kind
- parameter
- Type
HTMLElement- Requirement
- required
- Name
options- Kind
- parameter
- Type
MountCommandOptions<Item>- Requirement
- required
- Name
return- Kind
- return value
- Type
CommandMount<Item>- Requirement
- n/a
MountCommandOptions
interfaceinterface MountCommandOptions<Item extends CommandItem = CommandItem> extends CommandInput<Item> { readonly onValueChange?: (detail: CommandValueChangeDetail) => void; readonly onOpenChange?: (detail: CommandOpenChangeDetail) => void; readonly onQueryChange?: (detail: CommandQueryChangeDetail) => void; readonly announce?: (key: string, params: Record<string, string | number | null>, politeness: string) => void; readonly triggerText?: string; readonly emptyText?: string; readonly renderTrigger?: (element: HTMLButtonElement) => void; readonly renderItem?: (element: HTMLElement, item: Item) => void; readonly renderItemText?: (element: HTMLElement, item: Item) => void;}announce(key: string, params: Record<string, string | number | null>, politeness: string) => voidemptyTextstringonOpenChange(detail: CommandOpenChangeDetail) => voidonQueryChange(detail: CommandQueryChangeDetail) => voidonValueChange(detail: CommandValueChangeDetail) => voidrenderItem(element: HTMLElement, item: Item) => voidrenderItemText(element: HTMLElement, item: Item) => voidrenderTrigger(element: HTMLButtonElement) => voidtriggerTextstring- Name
announce- Kind
- property
- Type
(key: string, params: Record<string, string | number | null>, politeness: string) => void- Requirement
- optional
- Name
emptyText- Kind
- property
- Type
string- Requirement
- optional
- Name
onOpenChange- Kind
- property
- Type
(detail: CommandOpenChangeDetail) => void- Requirement
- optional
- Name
onQueryChange- Kind
- property
- Type
(detail: CommandQueryChangeDetail) => void- Requirement
- optional
- Name
onValueChange- Kind
- property
- Type
(detail: CommandValueChangeDetail) => void- Requirement
- optional
- Name
renderItem- Kind
- property
- Type
(element: HTMLElement, item: Item) => void- Requirement
- optional
- Name
renderItemText- Kind
- property
- Type
(element: HTMLElement, item: Item) => void- Requirement
- optional
- Name
renderTrigger- Kind
- property
- Type
(element: HTMLButtonElement) => void- Requirement
- optional
- Name
triggerText- Kind
- property
- Type
string- Requirement
- optional
runCommandCommand
functiondeclare function runCommandCommand(command: CommandCommand, scope: PartScope, options?: CommandConnectOptions): void;commandCommandCommandscopePartScopeoptionsCommandConnectOptionsreturnvoid- Name
command- Kind
- parameter
- Type
CommandCommand- Requirement
- required
- Name
scope- Kind
- parameter
- Type
PartScope- Requirement
- required
- Name
options- Kind
- parameter
- Type
CommandConnectOptions- 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 imports
import { Command, Content, Empty, Group, GroupLabel, Item, ItemText, Positioner } from "@grassroot/ui-headless-react/command"; // +3 more exportsVue imports
<script setup lang="ts">import { Command, Content, Empty, Group, GroupLabel, Item, ItemText, Positioner } from "@grassroot/ui-headless-vue/command"; // +3 more exports</script>Angular imports
import { Component } from "@angular/core";import { GR_COMMAND_DECLARATIONS } from "@grassroot/ui-headless-angular/command"; @Component({ standalone: true, imports: [GR_COMMAND_DECLARATIONS], template: `<!-- compose the command parts here -->` })export class Example {}Svelte imports
<script lang="ts"> import { Command, Content, Empty, Group, GroupLabel, Item, ItemText, Positioner } from "@grassroot/ui-headless-svelte/command"; // +2 more exports</script>Solid imports
import { Command, Content, Empty, Group, GroupLabel, Item, ItemText, Positioner } from "@grassroot/ui-headless-solid/command"; // +3 more exports@grassroot/ui-headless-react/command
React adapter
Command
valueexport declare const Command: { Root: import("react").ForwardRefExoticComponent<CommandRootProps & import("react").RefAttributes<HTMLDivElement>>; RootProvider: import("react").ForwardRefExoticComponent<CommandRootProviderProps & import("react").RefAttributes<HTMLDivElement>>; Trigger: import("react").ForwardRefExoticComponent<CommandTriggerProps & import("react").RefAttributes<HTMLButtonElement>>; Input: import("react").ForwardRefExoticComponent<CommandInputProps & import("react").RefAttributes<HTMLInputElement>>; Positioner: import("react").ForwardRefExoticComponent<CommandPositionerProps & import("react").RefAttributes<HTMLDivElement>>; Content: import("react").ForwardRefExoticComponent<CommandContentProps & import("react").RefAttributes<HTMLDivElement>>; Group: import("react").ForwardRefExoticComponent<CommandGroupProps & import("react").RefAttributes<HTMLDivElement>>; GroupLabel: import("react").ForwardRefExoticComponent<CommandGroupLabelProps & import("react").RefAttributes<HTMLDivElement>>; Item: import("react").ForwardRefExoticComponent<CommandItemProps & import("react").RefAttributes<HTMLDivElement>>; ItemText: import("react").ForwardRefExoticComponent<CommandItemTextProps & import("react").RefAttributes<HTMLSpanElement>>; Empty: import("react").ForwardRefExoticComponent<CommandEmptyProps & import("react").RefAttributes<HTMLDivElement>>;};Contentimport("react").ForwardRefExoticComponent<CommandContentProps & import("react").RefAttributes<HTMLDivElement>>Emptyimport("react").ForwardRefExoticComponent<CommandEmptyProps & import("react").RefAttributes<HTMLDivElement>>Groupimport("react").ForwardRefExoticComponent<CommandGroupProps & import("react").RefAttributes<HTMLDivElement>>GroupLabelimport("react").ForwardRefExoticComponent<CommandGroupLabelProps & import("react").RefAttributes<HTMLDivElement>>Inputimport("react").ForwardRefExoticComponent<CommandInputProps & import("react").RefAttributes<HTMLInputElement>>Itemimport("react").ForwardRefExoticComponent<CommandItemProps & import("react").RefAttributes<HTMLDivElement>>ItemTextimport("react").ForwardRefExoticComponent<CommandItemTextProps & import("react").RefAttributes<HTMLSpanElement>>Positionerimport("react").ForwardRefExoticComponent<CommandPositionerProps & import("react").RefAttributes<HTMLDivElement>>Rootimport("react").ForwardRefExoticComponent<CommandRootProps & import("react").RefAttributes<HTMLDivElement>>RootProviderimport("react").ForwardRefExoticComponent<CommandRootProviderProps & import("react").RefAttributes<HTMLDivElement>>Triggerimport("react").ForwardRefExoticComponent<CommandTriggerProps & import("react").RefAttributes<HTMLButtonElement>>- Name
Content- Kind
- property
- Type
import("react").ForwardRefExoticComponent<CommandContentProps & import("react").RefAttributes<HTMLDivElement>>- Requirement
- required
- Name
Empty- Kind
- property
- Type
import("react").ForwardRefExoticComponent<CommandEmptyProps & import("react").RefAttributes<HTMLDivElement>>- Requirement
- required
- Name
Group- Kind
- property
- Type
import("react").ForwardRefExoticComponent<CommandGroupProps & import("react").RefAttributes<HTMLDivElement>>- Requirement
- required
- Name
GroupLabel- Kind
- property
- Type
import("react").ForwardRefExoticComponent<CommandGroupLabelProps & import("react").RefAttributes<HTMLDivElement>>- Requirement
- required
- Name
Input- Kind
- property
- Type
import("react").ForwardRefExoticComponent<CommandInputProps & import("react").RefAttributes<HTMLInputElement>>- Requirement
- required
- Name
Item- Kind
- property
- Type
import("react").ForwardRefExoticComponent<CommandItemProps & import("react").RefAttributes<HTMLDivElement>>- Requirement
- required
- Name
ItemText- Kind
- property
- Type
import("react").ForwardRefExoticComponent<CommandItemTextProps & import("react").RefAttributes<HTMLSpanElement>>- Requirement
- required
- Name
Positioner- Kind
- property
- Type
import("react").ForwardRefExoticComponent<CommandPositionerProps & import("react").RefAttributes<HTMLDivElement>>- Requirement
- required
- Name
Root- Kind
- property
- Type
import("react").ForwardRefExoticComponent<CommandRootProps & import("react").RefAttributes<HTMLDivElement>>- Requirement
- required
- Name
RootProvider- Kind
- property
- Type
import("react").ForwardRefExoticComponent<CommandRootProviderProps & import("react").RefAttributes<HTMLDivElement>>- Requirement
- required
- Name
Trigger- Kind
- property
- Type
import("react").ForwardRefExoticComponent<CommandTriggerProps & import("react").RefAttributes<HTMLButtonElement>>- Requirement
- required
CommandContentProps
interfaceinterface CommandContentProps extends ComponentPropsWithoutRef<"div"> { readonly asChild?: boolean;}asChildboolean- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
CommandContext
valueexport declare const CommandContext: import("react").Context<CommandContextValue | null>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
CommandContextValue
interfaceinterface CommandContextValue { readonly service: CommandService; readonly connector: CommandApi; readonly scope: PartScope; readonly snapshot: CommandSnapshot;}connectorCommandApiscopePartScopeserviceCommandServicesnapshotCommandSnapshot- Name
connector- Kind
- property
- Type
CommandApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
CommandService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
CommandSnapshot- Requirement
- required
CommandEmptyProps
interfaceinterface CommandEmptyProps extends ComponentPropsWithoutRef<"div"> { readonly asChild?: boolean;}asChildboolean- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
CommandGroupLabelProps
interfaceinterface CommandGroupLabelProps extends ComponentPropsWithoutRef<"div"> { readonly asChild?: boolean; readonly group: CommandGroup; readonly index?: number;}asChildbooleangroupCommandGroupindexnumber- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
- Name
group- Kind
- property
- Type
CommandGroup- Requirement
- required
- Name
index- Kind
- property
- Type
number- Requirement
- optional
CommandGroupProps
interfaceinterface CommandGroupProps extends ComponentPropsWithoutRef<"div"> { readonly asChild?: boolean; readonly group: CommandGroup; readonly index?: number;}asChildbooleangroupCommandGroupindexnumber- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
- Name
group- Kind
- property
- Type
CommandGroup- Requirement
- required
- Name
index- Kind
- property
- Type
number- Requirement
- optional
CommandInputProps
interfaceinterface CommandInputProps extends ComponentPropsWithoutRef<"input"> { readonly asChild?: boolean;}asChildboolean- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
CommandItemProps
interfaceinterface CommandItemProps extends ComponentPropsWithoutRef<"div"> { readonly asChild?: boolean; readonly item: CommandItem; readonly index?: number; readonly children?: ReactNode;}asChildbooleanchildrenReactNodeindexnumberitemCommandItem- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
index- Kind
- property
- Type
number- Requirement
- optional
- Name
item- Kind
- property
- Type
CommandItem- Requirement
- required
CommandItemTextProps
interfaceinterface CommandItemTextProps extends ComponentPropsWithoutRef<"span"> { readonly asChild?: boolean; readonly item: CommandItem;}asChildbooleanitemCommandItem- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
- Name
item- Kind
- property
- Type
CommandItem- Requirement
- required
CommandOpenChangeDetail
interfaceinterface CommandOpenChangeDetail { readonly open: boolean; readonly reason: CommandChangeReason;}openbooleanreasonCommandChangeReason- Name
open- Kind
- property
- Type
boolean- Requirement
- required
- Name
reason- Kind
- property
- Type
CommandChangeReason- Requirement
- required
CommandPositionerProps
interfaceinterface CommandPositionerProps extends ComponentPropsWithoutRef<"div"> { readonly asChild?: boolean;}asChildboolean- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
CommandQueryChangeDetail
interfaceinterface CommandQueryChangeDetail { readonly query: string; readonly reason: "input" | "programmatic";}querystringreason"input" | "programmatic"- Name
query- Kind
- property
- Type
string- Requirement
- required
- Name
reason- Kind
- property
- Type
"input" | "programmatic"- Requirement
- required
CommandRootProps
interfaceinterface CommandRootProps extends Omit<ComponentPropsWithoutRef<"div">, "defaultValue" | "value"> { readonly asChild?: boolean; readonly groups: CommandInput["groups"]; readonly value?: CommandInput["value"]; readonly defaultValue?: CommandInput["defaultValue"]; readonly open?: CommandInput["open"]; readonly defaultOpen?: CommandInput["defaultOpen"]; readonly query?: CommandInput["query"]; readonly defaultQuery?: CommandInput["defaultQuery"]; readonly filter?: CommandInput["filter"]; readonly onOpenChange?: UseCommandOptions["onOpenChange"]; readonly onValueChange?: UseCommandOptions["onValueChange"]; readonly onQueryChange?: UseCommandOptions["onQueryChange"]; readonly children?: ReactNode;}asChildbooleanchildrenReactNodedefaultOpenCommandInput["defaultOpen"]defaultQueryCommandInput["defaultQuery"]defaultValueCommandInput["defaultValue"]filterCommandInput["filter"]groupsCommandInput["groups"]onOpenChangeUseCommandOptions["onOpenChange"]onQueryChangeUseCommandOptions["onQueryChange"]onValueChangeUseCommandOptions["onValueChange"]openCommandInput["open"]queryCommandInput["query"]valueCommandInput["value"]- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
defaultOpen- Kind
- property
- Type
CommandInput["defaultOpen"]- Requirement
- optional
- Name
defaultQuery- Kind
- property
- Type
CommandInput["defaultQuery"]- Requirement
- optional
- Name
defaultValue- Kind
- property
- Type
CommandInput["defaultValue"]- Requirement
- optional
- Name
filter- Kind
- property
- Type
CommandInput["filter"]- Requirement
- optional
- Name
groups- Kind
- property
- Type
CommandInput["groups"]- Requirement
- required
- Name
onOpenChange- Kind
- property
- Type
UseCommandOptions["onOpenChange"]- Requirement
- optional
- Name
onQueryChange- Kind
- property
- Type
UseCommandOptions["onQueryChange"]- Requirement
- optional
- Name
onValueChange- Kind
- property
- Type
UseCommandOptions["onValueChange"]- Requirement
- optional
- Name
open- Kind
- property
- Type
CommandInput["open"]- Requirement
- optional
- Name
query- Kind
- property
- Type
CommandInput["query"]- Requirement
- optional
- Name
value- Kind
- property
- Type
CommandInput["value"]- Requirement
- optional
CommandRootProviderProps
interfaceinterface CommandRootProviderProps extends ComponentPropsWithoutRef<"div"> { readonly value: UseCommandResult; readonly asChild?: boolean;}asChildbooleanvalueUseCommandResult- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
- Name
value- Kind
- property
- Type
UseCommandResult- Requirement
- required
CommandTriggerProps
interfaceinterface CommandTriggerProps extends ComponentPropsWithoutRef<"button"> { readonly asChild?: boolean;}asChildboolean- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
CommandValueChangeDetail
interfaceinterface CommandValueChangeDetail { readonly value: string; readonly reason: "pointer" | "keyboard" | "programmatic";}reason"pointer" | "keyboard" | "programmatic"valuestring- Name
reason- Kind
- property
- Type
"pointer" | "keyboard" | "programmatic"- Requirement
- required
- Name
value- Kind
- property
- Type
string- Requirement
- required
Content
valueexport declare const Content: import("react").ForwardRefExoticComponent<CommandContentProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Empty
valueexport declare const Empty: import("react").ForwardRefExoticComponent<CommandEmptyProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Group
valueexport declare const Group: import("react").ForwardRefExoticComponent<CommandGroupProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
GroupLabel
valueexport declare const GroupLabel: import("react").ForwardRefExoticComponent<CommandGroupLabelProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Input
valueexport declare const Input: import("react").ForwardRefExoticComponent<CommandInputProps & import("react").RefAttributes<HTMLInputElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Item
valueexport declare const Item: import("react").ForwardRefExoticComponent<CommandItemProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
ItemText
valueexport declare const ItemText: import("react").ForwardRefExoticComponent<CommandItemTextProps & import("react").RefAttributes<HTMLSpanElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Positioner
valueexport declare const Positioner: import("react").ForwardRefExoticComponent<CommandPositionerProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Root
valueexport declare const Root: import("react").ForwardRefExoticComponent<CommandRootProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
RootProvider
valueexport declare const RootProvider: import("react").ForwardRefExoticComponent<CommandRootProviderProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Trigger
valueexport declare const Trigger: import("react").ForwardRefExoticComponent<CommandTriggerProps & import("react").RefAttributes<HTMLButtonElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
useCommand
functiondeclare function useCommand(input: CommandInput, options?: UseCommandOptions): UseCommandResult;inputCommandInputoptionsUseCommandOptionsreturnUseCommandResult- Name
input- Kind
- parameter
- Type
CommandInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseCommandOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseCommandResult- Requirement
- n/a
useCommandContext
functiondeclare function useCommandContext(partName: string): CommandContextValue;partNamestringreturnCommandContextValue- Name
partName- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
CommandContextValue- Requirement
- n/a
UseCommandOptions
interfaceinterface UseCommandOptions { readonly onOpenChange?: (detail: CommandOpenChangeDetail) => void; readonly onValueChange?: (detail: CommandValueChangeDetail) => void; readonly onQueryChange?: (detail: CommandQueryChangeDetail) => void;}onOpenChange(detail: CommandOpenChangeDetail) => voidonQueryChange(detail: CommandQueryChangeDetail) => voidonValueChange(detail: CommandValueChangeDetail) => void- Name
onOpenChange- Kind
- property
- Type
(detail: CommandOpenChangeDetail) => void- Requirement
- optional
- Name
onQueryChange- Kind
- property
- Type
(detail: CommandQueryChangeDetail) => void- Requirement
- optional
- Name
onValueChange- Kind
- property
- Type
(detail: CommandValueChangeDetail) => void- Requirement
- optional
UseCommandResult
interfaceinterface UseCommandResult { readonly service: CommandService; readonly connector: CommandApi; readonly scope: PartScope; readonly snapshot: CommandSnapshot;}connectorCommandApiscopePartScopeserviceCommandServicesnapshotCommandSnapshot- Name
connector- Kind
- property
- Type
CommandApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
CommandService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
CommandSnapshot- Requirement
- required
useServiceVersion
functionSubscribes a component to a service's committed-snapshot version.
declare function useServiceVersion<S extends Service<any, any, any, any, any, any>>(service: S): ReturnType<S["getSnapshot"]>;serviceSreturnReturnType<S["getSnapshot"]>- Name
service- Kind
- parameter
- Type
S- Requirement
- required
- Name
return- Kind
- return value
- Type
ReturnType<S["getSnapshot"]>- Requirement
- n/a
@grassroot/ui-headless-vue/command
Vue adapter
Command
valueexport declare const Command: { Root: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ groups: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandInput["groups"]>; required: true; }; value: { type: import("vue").PropType<string | undefined>; default: undefined; }; defaultValue: { type: import("vue").PropType<string | undefined>; default: undefined; }; open: { type: import("vue").PropType<boolean | undefined>; default: undefined; }; defaultOpen: { type: import("vue").PropType<boolean | undefined>; default: undefined; }; query: { type: import("vue").PropType<string | undefined>; default: undefined; }; defaultQuery: { type: import("vue").PropType<string | undefined>; default: undefined; }; filter: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandInput["filter"]>; default: undefined; }; }>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, { openChange: (_detail: unknown) => true; valueChange: (_detail: unknown) => true; queryChange: (_detail: unknown) => true; }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ groups: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandInput["groups"]>; required: true; }; value: { type: import("vue").PropType<string | undefined>; default: undefined; }; defaultValue: { type: import("vue").PropType<string | undefined>; default: undefined; }; open: { type: import("vue").PropType<boolean | undefined>; default: undefined; }; defaultOpen: { type: import("vue").PropType<boolean | undefined>; default: undefined; }; query: { type: import("vue").PropType<string | undefined>; default: undefined; }; defaultQuery: { type: import("vue").PropType<string | undefined>; default: undefined; }; filter: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandInput["filter"]>; default: undefined; }; }>> & Readonly<{ onOpenChange?: ((_detail: unknown) => any) | undefined; onQueryChange?: ((_detail: unknown) => any) | undefined; onValueChange?: ((_detail: unknown) => any) | undefined; }>, { value: string | undefined; defaultValue: string | undefined; open: boolean | undefined; defaultOpen: boolean | undefined; query: string | undefined; defaultQuery: string | undefined; filter: import("@grassroot/ui-machines/command").CommandFilter<import("@grassroot/ui-core").CommandItem> | undefined; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>; RootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ value: { type: import("vue").PropType<ReturnType<typeof useCommand>>; 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: import("vue").PropType<ReturnType<typeof useCommand>>; required: true; }; }>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>; Trigger: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; }>, () => 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; }; }>> & Readonly<{}>, { asChild: boolean; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>; Input: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; }>, () => 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; }; }>> & Readonly<{}>, { asChild: boolean; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>; Positioner: 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>; Content: 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>; Group: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; group: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandGroup>; required: true; }; index: { type: NumberConstructor; default: undefined; }; }>, () => 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; }; group: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandGroup>; required: true; }; index: { type: NumberConstructor; default: undefined; }; }>> & Readonly<{}>, { asChild: boolean; index: number; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>; GroupLabel: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; group: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandGroup>; required: true; }; index: { type: NumberConstructor; 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; }; group: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandGroup>; required: true; }; index: { type: NumberConstructor; default: undefined; }; }>> & Readonly<{}>, { asChild: boolean; index: number; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>; Item: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; item: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandItem>; required: true; }; index: { type: NumberConstructor; default: undefined; }; }>, () => 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; }; item: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandItem>; required: true; }; index: { type: NumberConstructor; default: undefined; }; }>> & Readonly<{}>, { asChild: boolean; index: number; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>; ItemText: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; item: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandItem>; 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; }; item: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandItem>; required: true; }; }>> & Readonly<{}>, { asChild: boolean; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>; Empty: 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>;};Contentimport("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>Emptyimport("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>Groupimport("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
group: {
type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandGroup>;
required: true;
};
index: {
type: NumberConstructor;
default: undefined;
};
}>, () => 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;
};
group: {
type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandGroup>;
required: true;
};
index: {
type: NumberConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
asChild: boolean;
index: number;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>GroupLabelimport("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
group: {
type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandGroup>;
required: true;
};
index: {
type: NumberConstructor;
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;
};
group: {
type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandGroup>;
required: true;
};
index: {
type: NumberConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
asChild: boolean;
index: number;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>Inputimport("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => 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;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>Itemimport("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
item: {
type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandItem>;
required: true;
};
index: {
type: NumberConstructor;
default: undefined;
};
}>, () => 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;
};
item: {
type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandItem>;
required: true;
};
index: {
type: NumberConstructor;
default: undefined;
};
}>> & Readonly<{}>, {
asChild: boolean;
index: number;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>ItemTextimport("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
item: {
type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandItem>;
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;
};
item: {
type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandItem>;
required: true;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>Positionerimport("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>Rootimport("vue").DefineComponent<import("vue").ExtractPropTypes<{
groups: {
type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandInput["groups"]>;
required: true;
};
value: {
type: import("vue").PropType<string | undefined>;
default: undefined;
};
defaultValue: {
type: import("vue").PropType<string | undefined>;
default: undefined;
};
open: {
type: import("vue").PropType<boolean | undefined>;
default: undefined;
};
defaultOpen: {
type: import("vue").PropType<boolean | undefined>;
default: undefined;
};
query: {
type: import("vue").PropType<string | undefined>;
default: undefined;
};
defaultQuery: {
type: import("vue").PropType<string | undefined>;
default: undefined;
};
filter: {
type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandInput["filter"]>;
default: undefined;
};
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
openChange: (_detail: unknown) => true;
valueChange: (_detail: unknown) => true;
queryChange: (_detail: unknown) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
groups: {
type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandInput["groups"]>;
required: true;
};
value: {
type: import("vue").PropType<string | undefined>;
default: undefined;
};
defaultValue: {
type: import("vue").PropType<string | undefined>;
default: undefined;
};
open: {
type: import("vue").PropType<boolean | undefined>;
default: undefined;
};
defaultOpen: {
type: import("vue").PropType<boolean | undefined>;
default: undefined;
};
query: {
type: import("vue").PropType<string | undefined>;
default: undefined;
};
defaultQuery: {
type: import("vue").PropType<string | undefined>;
default: undefined;
};
filter: {
type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandInput["filter"]>;
default: undefined;
};
}>> & Readonly<{
onOpenChange?: ((_detail: unknown) => any) | undefined;
onQueryChange?: ((_detail: unknown) => any) | undefined;
onValueChange?: ((_detail: unknown) => any) | undefined;
}>, {
value: string | undefined;
defaultValue: string | undefined;
open: boolean | undefined;
defaultOpen: boolean | undefined;
query: string | undefined;
defaultQuery: string | undefined;
filter: import("@grassroot/ui-machines/command").CommandFilter<import("@grassroot/ui-core").CommandItem> | undefined;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>RootProviderimport("vue").DefineComponent<import("vue").ExtractPropTypes<{
value: {
type: import("vue").PropType<ReturnType<typeof useCommand>>;
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: import("vue").PropType<ReturnType<typeof useCommand>>;
required: true;
};
}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>Triggerimport("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => 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;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>- Name
Content- Kind
- property
- Type
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>- Requirement
- required
- Name
Empty- Kind
- property
- Type
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>- Requirement
- required
- Name
Group- Kind
- property
- Type
import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; group: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandGroup>; required: true; }; index: { type: NumberConstructor; default: undefined; }; }>, () => 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; }; group: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandGroup>; required: true; }; index: { type: NumberConstructor; default: undefined; }; }>> & Readonly<{}>, { asChild: boolean; index: number; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>- Requirement
- required
- Name
GroupLabel- Kind
- property
- Type
import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; group: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandGroup>; required: true; }; index: { type: NumberConstructor; 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; }; group: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandGroup>; required: true; }; index: { type: NumberConstructor; default: undefined; }; }>> & Readonly<{}>, { asChild: boolean; index: number; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>- Requirement
- required
- Name
Input- Kind
- property
- Type
import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; }>, () => 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; }; }>> & Readonly<{}>, { asChild: boolean; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>- Requirement
- required
- Name
Item- Kind
- property
- Type
import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; item: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandItem>; required: true; }; index: { type: NumberConstructor; default: undefined; }; }>, () => 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; }; item: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandItem>; required: true; }; index: { type: NumberConstructor; default: undefined; }; }>> & Readonly<{}>, { asChild: boolean; index: number; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>- Requirement
- required
- Name
ItemText- Kind
- property
- Type
import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; item: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandItem>; 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; }; item: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandItem>; required: true; }; }>> & Readonly<{}>, { asChild: boolean; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>- Requirement
- required
- Name
Positioner- Kind
- property
- Type
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>- Requirement
- required
- Name
Root- Kind
- property
- Type
import("vue").DefineComponent<import("vue").ExtractPropTypes<{ groups: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandInput["groups"]>; required: true; }; value: { type: import("vue").PropType<string | undefined>; default: undefined; }; defaultValue: { type: import("vue").PropType<string | undefined>; default: undefined; }; open: { type: import("vue").PropType<boolean | undefined>; default: undefined; }; defaultOpen: { type: import("vue").PropType<boolean | undefined>; default: undefined; }; query: { type: import("vue").PropType<string | undefined>; default: undefined; }; defaultQuery: { type: import("vue").PropType<string | undefined>; default: undefined; }; filter: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandInput["filter"]>; default: undefined; }; }>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, { openChange: (_detail: unknown) => true; valueChange: (_detail: unknown) => true; queryChange: (_detail: unknown) => true; }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ groups: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandInput["groups"]>; required: true; }; value: { type: import("vue").PropType<string | undefined>; default: undefined; }; defaultValue: { type: import("vue").PropType<string | undefined>; default: undefined; }; open: { type: import("vue").PropType<boolean | undefined>; default: undefined; }; defaultOpen: { type: import("vue").PropType<boolean | undefined>; default: undefined; }; query: { type: import("vue").PropType<string | undefined>; default: undefined; }; defaultQuery: { type: import("vue").PropType<string | undefined>; default: undefined; }; filter: { type: import("vue").PropType<import("@grassroot/ui-machines/command").CommandInput["filter"]>; default: undefined; }; }>> & Readonly<{ onOpenChange?: ((_detail: unknown) => any) | undefined; onQueryChange?: ((_detail: unknown) => any) | undefined; onValueChange?: ((_detail: unknown) => any) | undefined; }>, { value: string | undefined; defaultValue: string | undefined; open: boolean | undefined; defaultOpen: boolean | undefined; query: string | undefined; defaultQuery: string | undefined; filter: import("@grassroot/ui-machines/command").CommandFilter<import("@grassroot/ui-core").CommandItem> | undefined; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>- Requirement
- required
- Name
RootProvider- Kind
- property
- Type
import("vue").DefineComponent<import("vue").ExtractPropTypes<{ value: { type: import("vue").PropType<ReturnType<typeof useCommand>>; 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: import("vue").PropType<ReturnType<typeof useCommand>>; required: true; }; }>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>- Requirement
- required
- Name
Trigger- Kind
- property
- Type
import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; }>, () => 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; }; }>> & Readonly<{}>, { asChild: boolean; }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>- Requirement
- required
CommandContextKey
valueexport declare const CommandContextKey: InjectionKey<CommandContextValue>;CommandContextValue
interfaceinterface CommandContextValue { readonly service: CommandService; readonly connector: CommandApi; readonly scope: PartScope; readonly snapshot: ShallowRef<CommandSnapshot>;}connectorCommandApiscopePartScopeserviceCommandServicesnapshotShallowRef<CommandSnapshot>- Name
connector- Kind
- property
- Type
CommandApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
CommandService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
ShallowRef<CommandSnapshot>- Requirement
- required
CommandOpenChangeDetail
interfaceinterface CommandOpenChangeDetail { readonly open: boolean; readonly reason: CommandChangeReason;}openbooleanreasonCommandChangeReason- Name
open- Kind
- property
- Type
boolean- Requirement
- required
- Name
reason- Kind
- property
- Type
CommandChangeReason- Requirement
- required
CommandQueryChangeDetail
interfaceinterface CommandQueryChangeDetail { readonly query: string; readonly reason: "input" | "programmatic";}querystringreason"input" | "programmatic"- Name
query- Kind
- property
- Type
string- Requirement
- required
- Name
reason- Kind
- property
- Type
"input" | "programmatic"- Requirement
- required
CommandValueChangeDetail
interfaceinterface CommandValueChangeDetail { readonly value: string; readonly reason: "pointer" | "keyboard" | "programmatic";}reason"pointer" | "keyboard" | "programmatic"valuestring- Name
reason- Kind
- property
- Type
"pointer" | "keyboard" | "programmatic"- Requirement
- required
- Name
value- Kind
- property
- Type
string- Requirement
- required
Content
valueexport declare const Content: 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>;Empty
valueexport declare const Empty: 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>;Group
valueexport declare const Group: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; group: { type: PropType<CommandGroup$1>; required: true; }; index: { type: NumberConstructor; default: undefined; };}>, () => 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; }; group: { type: PropType<CommandGroup$1>; required: true; }; index: { type: NumberConstructor; default: undefined; };}>> & Readonly<{}>, { asChild: boolean; index: number;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;GroupLabel
valueexport declare const GroupLabel: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; group: { type: PropType<CommandGroup$1>; required: true; }; index: { type: NumberConstructor; 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; }; group: { type: PropType<CommandGroup$1>; required: true; }; index: { type: NumberConstructor; default: undefined; };}>> & Readonly<{}>, { asChild: boolean; index: number;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;Input
valueexport declare const Input: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; };}>, () => 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; };}>> & Readonly<{}>, { asChild: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;Item
valueexport declare const Item: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; item: { type: PropType<CommandItem$1>; required: true; }; index: { type: NumberConstructor; default: undefined; };}>, () => 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; }; item: { type: PropType<CommandItem$1>; required: true; }; index: { type: NumberConstructor; default: undefined; };}>> & Readonly<{}>, { asChild: boolean; index: number;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;ItemText
valueexport declare const ItemText: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; item: { type: PropType<CommandItem$1>; 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; }; item: { type: PropType<CommandItem$1>; required: true; };}>> & Readonly<{}>, { asChild: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;Positioner
valueexport declare const Positioner: 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>;provideCommandContext
functiondeclare function provideCommandContext(value: CommandContextValue): void;valueCommandContextValuereturnvoid- Name
value- Kind
- parameter
- Type
CommandContextValue- Requirement
- required
- Name
return- Kind
- return value
- Type
void- Requirement
- n/a
Root
valueexport declare const Root: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ groups: { type: PropType<CommandInput["groups"]>; required: true; }; value: { type: PropType<string | undefined>; default: undefined; }; defaultValue: { type: PropType<string | undefined>; default: undefined; }; open: { type: PropType<boolean | undefined>; default: undefined; }; defaultOpen: { type: PropType<boolean | undefined>; default: undefined; }; query: { type: PropType<string | undefined>; default: undefined; }; defaultQuery: { type: PropType<string | undefined>; default: undefined; }; filter: { type: PropType<CommandInput["filter"]>; default: undefined; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, { openChange: (_detail: unknown) => true; valueChange: (_detail: unknown) => true; queryChange: (_detail: unknown) => true;}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ groups: { type: PropType<CommandInput["groups"]>; required: true; }; value: { type: PropType<string | undefined>; default: undefined; }; defaultValue: { type: PropType<string | undefined>; default: undefined; }; open: { type: PropType<boolean | undefined>; default: undefined; }; defaultOpen: { type: PropType<boolean | undefined>; default: undefined; }; query: { type: PropType<string | undefined>; default: undefined; }; defaultQuery: { type: PropType<string | undefined>; default: undefined; }; filter: { type: PropType<CommandInput["filter"]>; default: undefined; };}>> & Readonly<{ onOpenChange?: ((_detail: unknown) => any) | undefined; onQueryChange?: ((_detail: unknown) => any) | undefined; onValueChange?: ((_detail: unknown) => any) | undefined;}>, { value: string | undefined; defaultValue: string | undefined; open: boolean | undefined; defaultOpen: boolean | undefined; query: string | undefined; defaultQuery: string | undefined; filter: import("@grassroot/ui-machines/command").CommandFilter<import("@grassroot/ui-core").CommandItem> | undefined;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;RootProvider
valueexport declare const RootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ value: { type: PropType<ReturnType<typeof useCommand>>; 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 useCommand>>; required: true; };}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;Trigger
valueexport declare const Trigger: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; };}>, () => 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; };}>> & Readonly<{}>, { asChild: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;useCommand
functiondeclare function useCommand(input: CommandInput | (() => CommandInput), options?: UseCommandOptions): UseCommandResult;inputCommandInput | (() => CommandInput)optionsUseCommandOptionsreturnUseCommandResult- Name
input- Kind
- parameter
- Type
CommandInput | (() => CommandInput)- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseCommandOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseCommandResult- Requirement
- n/a
useCommandContext
functiondeclare function useCommandContext(partName: string): CommandContextValue;partNamestringreturnCommandContextValue- Name
partName- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
CommandContextValue- Requirement
- n/a
UseCommandOptions
interfaceinterface UseCommandOptions { readonly onOpenChange?: (detail: CommandOpenChangeDetail) => void; readonly onValueChange?: (detail: CommandValueChangeDetail) => void; readonly onQueryChange?: (detail: CommandQueryChangeDetail) => void;}onOpenChange(detail: CommandOpenChangeDetail) => voidonQueryChange(detail: CommandQueryChangeDetail) => voidonValueChange(detail: CommandValueChangeDetail) => void- Name
onOpenChange- Kind
- property
- Type
(detail: CommandOpenChangeDetail) => void- Requirement
- optional
- Name
onQueryChange- Kind
- property
- Type
(detail: CommandQueryChangeDetail) => void- Requirement
- optional
- Name
onValueChange- Kind
- property
- Type
(detail: CommandValueChangeDetail) => void- Requirement
- optional
UseCommandResult
interfaceinterface UseCommandResult { readonly service: CommandService; readonly connector: CommandApi; readonly scope: PartScope; readonly snapshot: ShallowRef<CommandSnapshot>;}connectorCommandApiscopePartScopeserviceCommandServicesnapshotShallowRef<CommandSnapshot>- Name
connector- Kind
- property
- Type
CommandApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
CommandService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
ShallowRef<CommandSnapshot>- Requirement
- required
@grassroot/ui-headless-angular/command
Angular adapter
COMMAND_STORE
valueexport declare const COMMAND_STORE: InjectionToken<CommandStore>;CommandOpenChangeDetail
interfaceexport interface CommandOpenChangeDetail { readonly open: boolean; readonly reason: CommandChangeReason;}openbooleanreasonCommandChangeReason- Name
open- Kind
- property
- Type
boolean- Requirement
- required
- Name
reason- Kind
- property
- Type
CommandChangeReason- Requirement
- required
CommandQueryChangeDetail
interfaceexport interface CommandQueryChangeDetail { readonly query: string; readonly reason: "input" | "programmatic";}querystringreason"input" | "programmatic"- Name
query- Kind
- property
- Type
string- Requirement
- required
- Name
reason- Kind
- property
- Type
"input" | "programmatic"- Requirement
- required
CommandStore
interfaceexport interface CommandStore { readonly service: CommandService; readonly connector: CommandApi; readonly scope: PartScope; readonly version: WritableSignal<number>; start(): void; stop(): void; sync(input: import("@grassroot/ui-machines/command").CommandInput): void;}connectorCommandApiscopePartScopeserviceCommandServicestart() => voidstop() => voidsync(input: import("@grassroot/ui-machines/command").CommandInput) => voidversionWritableSignal<number>- Name
connector- Kind
- property
- Type
CommandApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
CommandService- Requirement
- required
- Name
start- Kind
- method
- Type
() => void- Requirement
- required
- Name
stop- Kind
- method
- Type
() => void- Requirement
- required
- Name
sync- Kind
- method
- Type
(input: import("@grassroot/ui-machines/command").CommandInput) => void- Requirement
- required
- Name
version- Kind
- property
- Type
WritableSignal<number>- Requirement
- required
CommandValueChangeDetail
interfaceexport interface CommandValueChangeDetail { readonly value: string; readonly reason: "pointer" | "keyboard" | "programmatic";}reason"pointer" | "keyboard" | "programmatic"valuestring- Name
reason- Kind
- property
- Type
"pointer" | "keyboard" | "programmatic"- Requirement
- required
- Name
value- Kind
- property
- Type
string- Requirement
- required
createCommandStore
functionexport declare function createCommandStore(initialInput: CommandInput, options?: CreateCommandStoreOptions): CommandStore;initialInputCommandInputoptionsCreateCommandStoreOptionsreturnCommandStore- Name
initialInput- Kind
- parameter
- Type
CommandInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
CreateCommandStoreOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
CommandStore- Requirement
- n/a
CreateCommandStoreOptions
interfaceexport interface CreateCommandStoreOptions { readonly onOpenChange?: (detail: CommandOpenChangeDetail) => void; readonly onValueChange?: (detail: CommandValueChangeDetail) => void; readonly onQueryChange?: (detail: CommandQueryChangeDetail) => void; readonly onCommit?: () => void;}onCommit() => voidonOpenChange(detail: CommandOpenChangeDetail) => voidonQueryChange(detail: CommandQueryChangeDetail) => voidonValueChange(detail: CommandValueChangeDetail) => void- Name
onCommit- Kind
- property
- Type
() => void- Requirement
- optional
- Name
onOpenChange- Kind
- property
- Type
(detail: CommandOpenChangeDetail) => void- Requirement
- optional
- Name
onQueryChange- Kind
- property
- Type
(detail: CommandQueryChangeDetail) => void- Requirement
- optional
- Name
onValueChange- Kind
- property
- Type
(detail: CommandValueChangeDetail) => void- Requirement
- optional
GR_COMMAND_DECLARATIONS
valueexport declare const GR_COMMAND_DECLARATIONS: readonly [typeof GrCommandRoot, typeof GrCommandTrigger, typeof GrCommandInput, typeof GrCommandOpen, typeof GrCommandPositioner, typeof GrCommandContent, typeof GrCommandGroup, typeof GrCommandGroupPart, typeof GrCommandGroupLabel, typeof GrCommandItem, typeof GrCommandItemPart, typeof GrCommandItemText, typeof GrCommandEmpty];GrCommandContent
classexport declare class GrCommandContent extends CommandPart { constructor(); static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandContent, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandContent, "[grCommandContent]", never, {}, {}, never, never, true, never>;}ɵdiri0.ɵɵDirectiveDeclaration<GrCommandContent, "[grCommandContent]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrCommandContent, never>- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrCommandContent, "[grCommandContent]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrCommandContent, never>- Requirement
- required
GrCommandEmpty
classexport declare class GrCommandEmpty implements OnDestroy { private readonly store; private readonly template; private readonly view; private mounted; private element; private readonly listeners; private consumerProps; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandEmpty, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandEmpty, "[grCommandEmpty]", never, {}, {}, never, never, true, never>;}consumerPropsanyelementanylistenersanymountedanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrCommandEmpty, "[grCommandEmpty]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrCommandEmpty, never>storeanytemplateanyviewany- 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
mounted- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrCommandEmpty, "[grCommandEmpty]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrCommandEmpty, never>- 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
GrCommandGroup
classexport declare class GrCommandGroup implements OnDestroy { readonly grCommandGroup: import("@angular/core").InputSignal<CommandGroup>; private readonly store; private readonly template; private readonly view; private mounted; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandGroup, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandGroup, "[grCommandGroup]", never, { "grCommandGroup": { "alias": "grCommandGroup"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;}grCommandGroupimport("@angular/core").InputSignal<CommandGroup>mountedanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrCommandGroup, "[grCommandGroup]", never, { "grCommandGroup": { "alias": "grCommandGroup"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrCommandGroup, never>storeanytemplateanyviewany- Name
grCommandGroup- Kind
- property
- Type
import("@angular/core").InputSignal<CommandGroup>- Requirement
- required
- Name
mounted- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrCommandGroup, "[grCommandGroup]", never, { "grCommandGroup": { "alias": "grCommandGroup"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrCommandGroup, never>- 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
GrCommandGroupLabel
classexport declare class GrCommandGroupLabel implements OnDestroy { readonly group: import("@angular/core").InputSignal<CommandGroup>; readonly index: import("@angular/core").InputSignal<number>; private readonly store; private readonly element; private readonly listeners; private readonly consumerProps; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandGroupLabel, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandGroupLabel, "[grCommandGroupLabel]", never, { "group": { "alias": "group"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;}consumerPropsanyelementanygroupimport("@angular/core").InputSignal<CommandGroup>indeximport("@angular/core").InputSignal<number>listenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrCommandGroupLabel, "[grCommandGroupLabel]", never, { "group": { "alias": "group"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrCommandGroupLabel, never>storeany- Name
consumerProps- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
group- Kind
- property
- Type
import("@angular/core").InputSignal<CommandGroup>- Requirement
- required
- Name
index- Kind
- property
- Type
import("@angular/core").InputSignal<number>- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrCommandGroupLabel, "[grCommandGroupLabel]", never, { "group": { "alias": "group"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrCommandGroupLabel, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrCommandGroupPart
classexport declare class GrCommandGroupPart implements OnDestroy { readonly group: import("@angular/core").InputSignal<CommandGroup>; readonly index: import("@angular/core").InputSignal<number>; private readonly store; private readonly element; private readonly listeners; private readonly consumerProps; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandGroupPart, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandGroupPart, "[grCommandGroupPart]", never, { "group": { "alias": "group"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;}consumerPropsanyelementanygroupimport("@angular/core").InputSignal<CommandGroup>indeximport("@angular/core").InputSignal<number>listenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrCommandGroupPart, "[grCommandGroupPart]", never, { "group": { "alias": "group"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrCommandGroupPart, never>storeany- Name
consumerProps- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
group- Kind
- property
- Type
import("@angular/core").InputSignal<CommandGroup>- Requirement
- required
- Name
index- Kind
- property
- Type
import("@angular/core").InputSignal<number>- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrCommandGroupPart, "[grCommandGroupPart]", never, { "group": { "alias": "group"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrCommandGroupPart, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrCommandInput
classexport declare class GrCommandInput extends CommandPart { constructor(); static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandInput, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandInput, "[grCommandInput]", never, {}, {}, never, never, true, never>;}ɵdiri0.ɵɵDirectiveDeclaration<GrCommandInput, "[grCommandInput]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrCommandInput, never>- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrCommandInput, "[grCommandInput]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrCommandInput, never>- Requirement
- required
GrCommandItem
classexport declare class GrCommandItem implements OnDestroy { readonly grCommandItem: import("@angular/core").InputSignal<import("@grassroot/ui-core").CommandItem>; private readonly store; private readonly template; private readonly view; private mounted; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandItem, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandItem, "[grCommandItem]", never, { "grCommandItem": { "alias": "grCommandItem"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;}grCommandItemimport("@angular/core").InputSignal<import("@grassroot/ui-core").CommandItem>mountedanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrCommandItem, "[grCommandItem]", never, { "grCommandItem": { "alias": "grCommandItem"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrCommandItem, never>storeanytemplateanyviewany- Name
grCommandItem- Kind
- property
- Type
import("@angular/core").InputSignal<import("@grassroot/ui-core").CommandItem>- Requirement
- required
- Name
mounted- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrCommandItem, "[grCommandItem]", never, { "grCommandItem": { "alias": "grCommandItem"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrCommandItem, never>- 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
GrCommandItemPart
classexport declare class GrCommandItemPart implements OnDestroy { readonly item: import("@angular/core").InputSignal<import("@grassroot/ui-core").CommandItem>; readonly index: import("@angular/core").InputSignal<number | undefined>; private readonly store; private readonly element; private readonly listeners; private readonly consumerProps; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandItemPart, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandItemPart, "[grCommandItemPart]", never, { "item": { "alias": "item"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;}consumerPropsanyelementanyindeximport("@angular/core").InputSignal<number | undefined>itemimport("@angular/core").InputSignal<import("@grassroot/ui-core").CommandItem>listenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrCommandItemPart, "[grCommandItemPart]", never, { "item": { "alias": "item"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrCommandItemPart, never>storeany- Name
consumerProps- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
index- Kind
- property
- Type
import("@angular/core").InputSignal<number | undefined>- Requirement
- required
- Name
item- Kind
- property
- Type
import("@angular/core").InputSignal<import("@grassroot/ui-core").CommandItem>- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrCommandItemPart, "[grCommandItemPart]", never, { "item": { "alias": "item"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrCommandItemPart, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrCommandItemText
classexport declare class GrCommandItemText implements OnDestroy { readonly item: import("@angular/core").InputSignal<import("@grassroot/ui-core").CommandItem>; private readonly store; private readonly element; private readonly listeners; private readonly consumerProps; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandItemText, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandItemText, "[grCommandItemText]", never, { "item": { "alias": "item"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;}consumerPropsanyelementanyitemimport("@angular/core").InputSignal<import("@grassroot/ui-core").CommandItem>listenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrCommandItemText, "[grCommandItemText]", never, { "item": { "alias": "item"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrCommandItemText, never>storeany- Name
consumerProps- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
item- Kind
- property
- Type
import("@angular/core").InputSignal<import("@grassroot/ui-core").CommandItem>- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrCommandItemText, "[grCommandItemText]", never, { "item": { "alias": "item"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrCommandItemText, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrCommandOpen
classexport declare class GrCommandOpen implements OnDestroy { private readonly store; private readonly template; private readonly view; private mounted; private release; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandOpen, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandOpen, "[grCommandOpen]", never, {}, {}, never, never, true, never>;}mountedanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrCommandOpen, "[grCommandOpen]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrCommandOpen, never>releaseanystoreanytemplateanyviewany- Name
mounted- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrCommandOpen, "[grCommandOpen]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrCommandOpen, 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
GrCommandPositioner
classexport declare class GrCommandPositioner extends CommandPart { constructor(); static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandPositioner, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandPositioner, "[grCommandPositioner]", never, {}, {}, never, never, true, never>;}ɵdiri0.ɵɵDirectiveDeclaration<GrCommandPositioner, "[grCommandPositioner]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrCommandPositioner, never>- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrCommandPositioner, "[grCommandPositioner]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrCommandPositioner, never>- Requirement
- required
GrCommandRoot
classexport declare class GrCommandRoot implements OnDestroy { readonly groups: import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/command").CommandGroup<import("@grassroot/ui-core").CommandItem>[]>; readonly value: import("@angular/core").InputSignal<string | undefined>; readonly defaultValue: import("@angular/core").InputSignal<string | undefined>; readonly open: import("@angular/core").InputSignal<boolean | undefined>; readonly defaultOpen: import("@angular/core").InputSignal<boolean | undefined>; readonly query: import("@angular/core").InputSignal<string | undefined>; readonly defaultQuery: import("@angular/core").InputSignal<string | undefined>; readonly filter: import("@angular/core").InputSignal<import("@grassroot/ui-machines/command").CommandFilter<import("@grassroot/ui-core").CommandItem> | undefined>; readonly openChange: import("@angular/core").OutputEmitterRef<CommandOpenChangeDetail>; readonly valueChange: import("@angular/core").OutputEmitterRef<CommandValueChangeDetail>; readonly queryChange: import("@angular/core").OutputEmitterRef<CommandQueryChangeDetail>; private readonly appRef; private readonly injector; private readonly element; private readonly listeners; private readonly consumerProps; private releaseLayer; private registrationTicked; readonly store: CommandStore; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandRoot, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandRoot, "[grCommandRoot]", never, { "groups": { "alias": "groups"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "query": { "alias": "query"; "required": false; "isSignal": true; }; "defaultQuery": { "alias": "defaultQuery"; "required": false; "isSignal": true; }; "filter": { "alias": "filter"; "required": false; "isSignal": true; }; }, { "openChange": "openChange"; "valueChange": "valueChange"; "queryChange": "queryChange"; }, never, never, true, never>;}appRefanyconsumerPropsanydefaultOpenimport("@angular/core").InputSignal<boolean | undefined>defaultQueryimport("@angular/core").InputSignal<string | undefined>defaultValueimport("@angular/core").InputSignal<string | undefined>elementanyfilterimport("@angular/core").InputSignal<import("@grassroot/ui-machines/command").CommandFilter<import("@grassroot/ui-core").CommandItem> | undefined>groupsimport("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/command").CommandGroup<import("@grassroot/ui-core").CommandItem>[]>injectoranylistenersanyngOnDestroy() => voidopenimport("@angular/core").InputSignal<boolean | undefined>openChangeimport("@angular/core").OutputEmitterRef<CommandOpenChangeDetail>ɵdiri0.ɵɵDirectiveDeclaration<GrCommandRoot, "[grCommandRoot]", never, { "groups": { "alias": "groups"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "query": { "alias": "query"; "required": false; "isSignal": true; }; "defaultQuery": { "alias": "defaultQuery"; "required": false; "isSignal": true; }; "filter": { "alias": "filter"; "required": false; "isSignal": true; }; }, { "openChange": "openChange"; "valueChange": "valueChange"; "queryChange": "queryChange"; }, never, never, true, never>- Name
appRef- Kind
- property
- Type
any- Requirement
- required
- Name
consumerProps- Kind
- property
- Type
any- Requirement
- required
- Name
defaultOpen- Kind
- property
- Type
import("@angular/core").InputSignal<boolean | undefined>- Requirement
- required
- Name
defaultQuery- Kind
- property
- Type
import("@angular/core").InputSignal<string | undefined>- Requirement
- required
- Name
defaultValue- Kind
- property
- Type
import("@angular/core").InputSignal<string | undefined>- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
filter- Kind
- property
- Type
import("@angular/core").InputSignal<import("@grassroot/ui-machines/command").CommandFilter<import("@grassroot/ui-core").CommandItem> | undefined>- Requirement
- required
- Name
groups- Kind
- property
- Type
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/command").CommandGroup<import("@grassroot/ui-core").CommandItem>[]>- Requirement
- required
- Name
injector- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
open- Kind
- property
- Type
import("@angular/core").InputSignal<boolean | undefined>- Requirement
- required
- Name
openChange- Kind
- property
- Type
import("@angular/core").OutputEmitterRef<CommandOpenChangeDetail>- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrCommandRoot, "[grCommandRoot]", never, { "groups": { "alias": "groups"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "query": { "alias": "query"; "required": false; "isSignal": true; }; "defaultQuery": { "alias": "defaultQuery"; "required": false; "isSignal": true; }; "filter": { "alias": "filter"; "required": false; "isSignal": true; }; }, { "openChange": "openChange"; "valueChange": "valueChange"; "queryChange": "queryChange"; }, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrCommandRoot, never>- Requirement
- required
- Name
query- Kind
- property
- Type
import("@angular/core").InputSignal<string | undefined>- Requirement
- required
- Name
queryChange- Kind
- property
- Type
import("@angular/core").OutputEmitterRef<CommandQueryChangeDetail>- Requirement
- required
- Name
registrationTicked- Kind
- property
- Type
any- Requirement
- required
- Name
releaseLayer- Kind
- property
- Type
any- Requirement
- required
- Name
store- Kind
- property
- Type
CommandStore- Requirement
- required
- Name
value- Kind
- property
- Type
import("@angular/core").InputSignal<string | undefined>- Requirement
- required
- Name
valueChange- Kind
- property
- Type
import("@angular/core").OutputEmitterRef<CommandValueChangeDetail>- Requirement
- required
GrCommandTrigger
classexport declare class GrCommandTrigger extends CommandPart { constructor(); static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandTrigger, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandTrigger, "[grCommandTrigger]", never, {}, {}, never, never, true, never>;}ɵdiri0.ɵɵDirectiveDeclaration<GrCommandTrigger, "[grCommandTrigger]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrCommandTrigger, never>- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrCommandTrigger, "[grCommandTrigger]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrCommandTrigger, never>- Requirement
- required
@grassroot/ui-headless-svelte/command
Svelte adapter
Command
valueexport declare const Command: { Root: import("svelte/legacy").LegacyComponentType; Trigger: import("svelte/legacy").LegacyComponentType; Input: import("svelte/legacy").LegacyComponentType; Positioner: import("svelte/legacy").LegacyComponentType; Content: import("svelte/legacy").LegacyComponentType; Group: import("svelte/legacy").LegacyComponentType; GroupLabel: import("svelte/legacy").LegacyComponentType; Item: import("svelte/legacy").LegacyComponentType; ItemText: import("svelte/legacy").LegacyComponentType; Empty: import("svelte/legacy").LegacyComponentType;};Contentimport("svelte/legacy").LegacyComponentTypeEmptyimport("svelte/legacy").LegacyComponentTypeGroupimport("svelte/legacy").LegacyComponentTypeGroupLabelimport("svelte/legacy").LegacyComponentTypeInputimport("svelte/legacy").LegacyComponentTypeItemimport("svelte/legacy").LegacyComponentTypeItemTextimport("svelte/legacy").LegacyComponentTypePositionerimport("svelte/legacy").LegacyComponentTypeRootimport("svelte/legacy").LegacyComponentTypeTriggerimport("svelte/legacy").LegacyComponentType- Name
Content- Kind
- property
- Type
import("svelte/legacy").LegacyComponentType- Requirement
- required
- Name
Empty- Kind
- property
- Type
import("svelte/legacy").LegacyComponentType- Requirement
- required
- Name
Group- Kind
- property
- Type
import("svelte/legacy").LegacyComponentType- Requirement
- required
- Name
GroupLabel- Kind
- property
- Type
import("svelte/legacy").LegacyComponentType- Requirement
- required
- Name
Input- Kind
- property
- Type
import("svelte/legacy").LegacyComponentType- Requirement
- required
- Name
Item- Kind
- property
- Type
import("svelte/legacy").LegacyComponentType- Requirement
- required
- Name
ItemText- Kind
- property
- Type
import("svelte/legacy").LegacyComponentType- Requirement
- required
- Name
Positioner- Kind
- property
- Type
import("svelte/legacy").LegacyComponentType- Requirement
- required
- Name
Root- Kind
- property
- Type
import("svelte/legacy").LegacyComponentType- Requirement
- required
- Name
Trigger- Kind
- property
- Type
import("svelte/legacy").LegacyComponentType- Requirement
- required
CommandContextValue
interfaceexport interface CommandContextValue { readonly service: CommandService; readonly connector: CommandApi; readonly scope: PartScope; readonly version: () => number; readonly snapshot: () => CommandSnapshot;}connectorCommandApiscopePartScopeserviceCommandServicesnapshot() => CommandSnapshotversion() => number- Name
connector- Kind
- property
- Type
CommandApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
CommandService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
() => CommandSnapshot- Requirement
- required
- Name
version- Kind
- property
- Type
() => number- Requirement
- required
CommandOpenChangeDetail
interfaceexport interface CommandOpenChangeDetail { readonly open: boolean; readonly reason: CommandChangeReason;}openbooleanreasonCommandChangeReason- Name
open- Kind
- property
- Type
boolean- Requirement
- required
- Name
reason- Kind
- property
- Type
CommandChangeReason- Requirement
- required
CommandQueryChangeDetail
interfaceexport interface CommandQueryChangeDetail { readonly query: string; readonly reason: "input" | "programmatic";}querystringreason"input" | "programmatic"- Name
query- Kind
- property
- Type
string- Requirement
- required
- Name
reason- Kind
- property
- Type
"input" | "programmatic"- Requirement
- required
CommandValueChangeDetail
interfaceexport interface CommandValueChangeDetail { readonly value: string; readonly reason: "pointer" | "keyboard" | "programmatic";}reason"pointer" | "keyboard" | "programmatic"valuestring- Name
reason- Kind
- property
- Type
"pointer" | "keyboard" | "programmatic"- Requirement
- required
- Name
value- Kind
- property
- Type
string- Requirement
- required
Content
valueexport declare const Content: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- 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
createCommand
functionexport declare function createCommand(inputGetter: () => CommandInput, options?: UseCommandOptions): UseCommandResult;inputGetter() => CommandInputoptionsUseCommandOptionsreturnUseCommandResult- Name
inputGetter- Kind
- parameter
- Type
() => CommandInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseCommandOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseCommandResult- Requirement
- n/a
Empty
valueexport declare const Empty: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- 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
Group
valueexport declare const Group: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- 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
GroupLabel
valueexport declare const GroupLabel: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- 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
Input
valueexport declare const Input: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- 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
Item
valueexport declare const Item: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- 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
ItemText
valueexport declare const ItemText: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- 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
Positioner
valueexport declare const Positioner: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- 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
provideCommandContext
functionexport declare function provideCommandContext(value: CommandContextValue): void;valueCommandContextValuereturnvoid- Name
value- Kind
- parameter
- Type
CommandContextValue- Requirement
- required
- Name
return- Kind
- return value
- Type
void- Requirement
- n/a
Root
valueexport declare const Root: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- 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
Trigger
valueexport declare const Trigger: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- 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
useCommandContext
functionexport declare function useCommandContext(partName: string): CommandContextValue;partNamestringreturnCommandContextValue- Name
partName- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
CommandContextValue- Requirement
- n/a
UseCommandOptions
interfaceexport interface UseCommandOptions { readonly onOpenChange?: (detail: CommandOpenChangeDetail) => void; readonly onValueChange?: (detail: CommandValueChangeDetail) => void; readonly onQueryChange?: (detail: CommandQueryChangeDetail) => void;}onOpenChange(detail: CommandOpenChangeDetail) => voidonQueryChange(detail: CommandQueryChangeDetail) => voidonValueChange(detail: CommandValueChangeDetail) => void- Name
onOpenChange- Kind
- property
- Type
(detail: CommandOpenChangeDetail) => void- Requirement
- optional
- Name
onQueryChange- Kind
- property
- Type
(detail: CommandQueryChangeDetail) => void- Requirement
- optional
- Name
onValueChange- Kind
- property
- Type
(detail: CommandValueChangeDetail) => void- Requirement
- optional
UseCommandResult
interfaceexport interface UseCommandResult { readonly service: CommandService; readonly connector: CommandApi; readonly scope: PartScope; readonly version: () => number; readonly snapshot: () => CommandSnapshot;}connectorCommandApiscopePartScopeserviceCommandServicesnapshot() => CommandSnapshotversion() => number- Name
connector- Kind
- property
- Type
CommandApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
CommandService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
() => CommandSnapshot- Requirement
- required
- Name
version- Kind
- property
- Type
() => number- Requirement
- required
@grassroot/ui-headless-solid/command
Solid adapter
Command
valueexport declare const Command: { Root: typeof CommandRoot; RootProvider: typeof CommandRootProvider; Trigger: (props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element; Input: (props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element; Positioner: (props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element; Content: (props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element; Group: typeof CommandGroup; GroupLabel: typeof CommandGroupLabel; Item: typeof CommandItem; ItemText: typeof CommandItemText; Empty: (props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element;};Content(props: {
as?: string | import("solid-js").Component<Record<string, unknown>>;
children?: import("solid-js").JSX.Element;
} & Record<string, unknown>) => import("solid-js").JSX.ElementEmpty(props: {
as?: string | import("solid-js").Component<Record<string, unknown>>;
children?: import("solid-js").JSX.Element;
} & Record<string, unknown>) => import("solid-js").JSX.ElementGrouptypeof CommandGroupGroupLabeltypeof CommandGroupLabelInput(props: {
as?: string | import("solid-js").Component<Record<string, unknown>>;
children?: import("solid-js").JSX.Element;
} & Record<string, unknown>) => import("solid-js").JSX.ElementItemtypeof CommandItemItemTexttypeof CommandItemTextPositioner(props: {
as?: string | import("solid-js").Component<Record<string, unknown>>;
children?: import("solid-js").JSX.Element;
} & Record<string, unknown>) => import("solid-js").JSX.ElementRoottypeof CommandRootRootProvidertypeof CommandRootProviderTrigger(props: {
as?: string | import("solid-js").Component<Record<string, unknown>>;
children?: import("solid-js").JSX.Element;
} & Record<string, unknown>) => import("solid-js").JSX.Element- Name
Content- Kind
- property
- Type
(props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element- Requirement
- required
- Name
Empty- Kind
- property
- Type
(props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element- Requirement
- required
- Name
Group- Kind
- property
- Type
typeof CommandGroup- Requirement
- required
- Name
GroupLabel- Kind
- property
- Type
typeof CommandGroupLabel- Requirement
- required
- Name
Input- Kind
- property
- Type
(props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element- Requirement
- required
- Name
Item- Kind
- property
- Type
typeof CommandItem- Requirement
- required
- Name
ItemText- Kind
- property
- Type
typeof CommandItemText- Requirement
- required
- Name
Positioner- Kind
- property
- Type
(props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element- Requirement
- required
- Name
Root- Kind
- property
- Type
typeof CommandRoot- Requirement
- required
- Name
RootProvider- Kind
- property
- Type
typeof CommandRootProvider- Requirement
- required
- Name
Trigger- Kind
- property
- Type
(props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element- Requirement
- required
CommandContext
valueexport declare const CommandContext: import("solid-js").Context<CommandContextValue | undefined>;CommandContextValue
interfaceexport interface CommandContextValue { readonly service: CommandService; readonly connector: CommandApi; readonly scope: PartScope; readonly snapshot: Accessor<CommandSnapshot>;}connectorCommandApiscopePartScopeserviceCommandServicesnapshotAccessor<CommandSnapshot>- Name
connector- Kind
- property
- Type
CommandApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
CommandService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
Accessor<CommandSnapshot>- Requirement
- required
CommandOpenChangeDetail
interfaceexport interface CommandOpenChangeDetail { readonly open: boolean; readonly reason: CommandChangeReason;}openbooleanreasonCommandChangeReason- Name
open- Kind
- property
- Type
boolean- Requirement
- required
- Name
reason- Kind
- property
- Type
CommandChangeReason- Requirement
- required
CommandQueryChangeDetail
interfaceexport interface CommandQueryChangeDetail { readonly query: string; readonly reason: "input" | "programmatic";}querystringreason"input" | "programmatic"- Name
query- Kind
- property
- Type
string- Requirement
- required
- Name
reason- Kind
- property
- Type
"input" | "programmatic"- Requirement
- required
CommandValueChangeDetail
interfaceexport interface CommandValueChangeDetail { readonly value: string; readonly reason: "pointer" | "keyboard" | "programmatic";}reason"pointer" | "keyboard" | "programmatic"valuestring- Name
reason- Kind
- property
- Type
"pointer" | "keyboard" | "programmatic"- Requirement
- required
- Name
value- Kind
- property
- Type
string- Requirement
- required
Content
valueexport declare const Content: (props: SimpleProps) => JSX.Element;propsSimplePropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
SimpleProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
Empty
valueexport declare const Empty: (props: SimpleProps) => JSX.Element;propsSimplePropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
SimpleProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
Group
functionexport declare function CommandGroup(props: { group: CommandGroup; index?: number; as?: AsProp; children?: JSX.Element;} & Record<string, unknown>): JSX.Element;props{
group: CommandGroup;
index?: number;
as?: AsProp;
children?: JSX.Element;
} & Record<string, unknown>returnJSX.Element- Name
props- Kind
- parameter
- Type
{ group: CommandGroup; index?: number; as?: AsProp; children?: JSX.Element; } & Record<string, unknown>- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
GroupLabel
functionexport declare function CommandGroupLabel(props: { group: CommandGroup; index?: number; as?: AsProp; children?: JSX.Element;} & Record<string, unknown>): JSX.Element;props{
group: CommandGroup;
index?: number;
as?: AsProp;
children?: JSX.Element;
} & Record<string, unknown>returnJSX.Element- Name
props- Kind
- parameter
- Type
{ group: CommandGroup; index?: number; as?: AsProp; children?: JSX.Element; } & Record<string, unknown>- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
Input
valueexport declare const Input: (props: SimpleProps) => JSX.Element;propsSimplePropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
SimpleProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
Item
functionexport declare function CommandItem(props: { item: CommandItem; index?: number; as?: AsProp; children?: JSX.Element;} & JSX.HTMLAttributes<HTMLDivElement>): JSX.Element;props{
item: CommandItem;
index?: number;
as?: AsProp;
children?: JSX.Element;
} & JSX.HTMLAttributes<HTMLDivElement>returnJSX.Element- Name
props- Kind
- parameter
- Type
{ item: CommandItem; index?: number; as?: AsProp; children?: JSX.Element; } & JSX.HTMLAttributes<HTMLDivElement>- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
ItemText
functionexport declare function CommandItemText(props: { item: CommandItem; as?: AsProp; children?: JSX.Element;} & Record<string, unknown>): JSX.Element;props{
item: CommandItem;
as?: AsProp;
children?: JSX.Element;
} & Record<string, unknown>returnJSX.Element- Name
props- Kind
- parameter
- Type
{ item: CommandItem; as?: AsProp; children?: JSX.Element; } & Record<string, unknown>- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
Positioner
valueexport declare const Positioner: (props: SimpleProps) => JSX.Element;propsSimplePropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
SimpleProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
Root
functionexport declare function CommandRoot(props: CommandRootProps): JSX.Element;propsCommandRootPropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
CommandRootProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
RootProvider
functionexport declare function CommandRootProvider(props: CommandRootProviderProps): JSX.Element;propsCommandRootProviderPropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
CommandRootProviderProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
Trigger
valueexport declare const Trigger: (props: SimpleProps) => JSX.Element;propsSimplePropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
SimpleProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
useCommand
functionexport declare function useCommand(input: Accessor<CommandInput>, options?: UseCommandOptions): UseCommandResult;inputAccessor<CommandInput>optionsUseCommandOptionsreturnUseCommandResult- Name
input- Kind
- parameter
- Type
Accessor<CommandInput>- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseCommandOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseCommandResult- Requirement
- n/a
useCommandContext
functionexport declare function useCommandContext(partName: string): CommandContextValue;partNamestringreturnCommandContextValue- Name
partName- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
CommandContextValue- Requirement
- n/a
UseCommandOptions
interfaceexport interface UseCommandOptions { readonly onOpenChange?: (detail: CommandOpenChangeDetail) => void; readonly onValueChange?: (detail: CommandValueChangeDetail) => void; readonly onQueryChange?: (detail: CommandQueryChangeDetail) => void;}onOpenChange(detail: CommandOpenChangeDetail) => voidonQueryChange(detail: CommandQueryChangeDetail) => voidonValueChange(detail: CommandValueChangeDetail) => void- Name
onOpenChange- Kind
- property
- Type
(detail: CommandOpenChangeDetail) => void- Requirement
- optional
- Name
onQueryChange- Kind
- property
- Type
(detail: CommandQueryChangeDetail) => void- Requirement
- optional
- Name
onValueChange- Kind
- property
- Type
(detail: CommandValueChangeDetail) => void- Requirement
- optional
UseCommandResult
interfaceexport interface UseCommandResult { readonly service: CommandService; readonly connector: CommandApi; readonly scope: PartScope; readonly snapshot: Accessor<CommandSnapshot>;}connectorCommandApiscopePartScopeserviceCommandServicesnapshotAccessor<CommandSnapshot>- Name
connector- Kind
- property
- Type
CommandApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
CommandService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
Accessor<CommandSnapshot>- Requirement
- required