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

30 exports
View source packages/ui-headless/core/src/command/index.ts
DeclarationView source
activateCommandLayerts
declare function activateCommandLayer<Item extends CommandItem>(service: CommandService<Item>, scope: PartScope, document: Document): () => void;
Name
Kind
Type
Requirement
service
parameter
CommandService<Item>
required
scope
parameter
PartScope
required
document
parameter
Document
required
return
return value
() => void
n/a
Name
service
Kind
parameter
Type
CommandService<Item>
Requirement
required
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
DeclarationView source
CommandActionableItemts
type CommandActionableItem = CommandItem & {
readonly disabled?: boolean;
};
Name
Kind
Type
Requirement
disabled
property
boolean
optional
Name
disabled
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
commandAnatomyts
export declare const commandAnatomy: {
readonly scope: "command";
readonly parts: readonly ["root", "trigger", "input", "positioner", "content", "group", "group-label", "item", "item-text", "empty"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "trigger", "input", "positioner", "content", "group", "group-label", "item", "item-text", "empty"]
required
scope
property
"command"
required
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

interface
DeclarationView source
CommandApits
interface 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[];
}
Name
Kind
Type
Requirement
activeIndex
property
number
required
contentProps
method
() => PartProps
required
emptyProps
method
() => PartProps
required
filteredGroups
property
readonly CommandGroup<Item>[]
required
flatItems
property
readonly Item[]
required
groupLabelProps
method
(group: CommandGroup<Item>, index: number) => PartProps
required
groupProps
method
(group: CommandGroup<Item>, index: number) => PartProps
required
inputProps
method
() => PartProps
required
itemProps
method
(item: Item, index?: number) => PartProps
required
itemTextProps
method
(item: Item) => PartProps
required
open
property
boolean
required
positionerProps
method
() => PartProps
required
query
property
string
required
rootProps
method
() => PartProps
required
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
DeclarationView source
CommandBindingModets
type CommandBindingMode = "controlled" | "uncontrolled";
DeclarationView source
CommandChangeReasonts
type CommandChangeReason = "pointer" | "keyboard" | "programmatic" | "trigger" | "input" | "escape" | "outside-click";
DeclarationView source
CommandCommandts
type 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";
});
DeclarationView source
CommandConnectOptionsts
interface 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;
}
Name
Kind
Type
Requirement
announce
property
(key: "selection-changed" | "results-available", params: { readonly label: string | null; readonly count: number | null; }, politeness: "polite" | "assertive") => void
optional
onOpenChange
property
(detail: { open: boolean; reason: Exclude<CommandChangeReason, "input">; }) => void
optional
onQueryChange
property
(detail: { query: string; reason: "input" | "programmatic"; }) => void
optional
onValueChange
property
(detail: { value: string; reason: CommandSelectionReason; }) => void
optional
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

interface
DeclarationView source
CommandContextts
interface 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;
}
Name
Kind
Type
Requirement
Description
filteredGroups
property
readonly CommandGroup<Item>[]
required
flatItems
property
readonly Item[]
required
highlightedIndex
property
number
required
Index into the current flattened item list; filtering never creates a second index model.
modes
property
CommandModes
required
open
property
boolean
required
query
property
string
required
value
property
string | undefined
required
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
DeclarationView source
CommandEventts
type 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";
};
DeclarationView source
CommandFilterts
type CommandFilter<Item extends CommandItem = CommandItem> = (item: Item, normalizedQuery: string) => boolean;
DeclarationView source
CommandGroupts
type CommandGroup<Item extends CommandItem = CommandItem> = CommandGroup$1<Item>;

CommandInput

interface
DeclarationView source
CommandInputts
interface 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>;
}
Name
Kind
Type
Requirement
Description
defaultOpen
property
boolean
optional
defaultQuery
property
string
optional
defaultValue
property
string
optional
filter
property
CommandFilter<Item>
optional
Replaces the default oracle predicate; the machine still owns grouping.
groups
property
readonly CommandGroup<Item>[]
required
open
property
boolean
optional
query
property
string
optional
value
property
string
optional
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
DeclarationView source
CommandItemts
type CommandItem = CommandItem$1;
DeclarationView source
commandMachinets
export declare const commandMachine: CommandMachine;

CommandModes

interface
DeclarationView source
CommandModests
interface CommandModes {
readonly value: CommandBindingMode;
readonly open: CommandBindingMode;
readonly query: CommandBindingMode;
}
Name
Kind
Type
Requirement
open
property
CommandBindingMode
required
query
property
CommandBindingMode
required
value
property
CommandBindingMode
required
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

interface
DeclarationView source
CommandMountts
interface CommandMount<Item extends CommandItem = CommandItem> {
readonly service: CommandService<Item>;
readonly connector: CommandApi<Item>;
readonly root: HTMLElement;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
CommandApi<Item>
required
destroy
method
() => void
required
root
property
HTMLElement
required
service
property
CommandService<Item>
required
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
DeclarationView source
CommandOpenChangeDetailts
interface CommandOpenChangeDetail {
readonly open: boolean;
readonly reason: string;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
string
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
string
Requirement
required
DeclarationView source
CommandPartts
type CommandPart = (typeof parts)[number];
DeclarationView source
CommandQueryChangeDetailts
interface CommandQueryChangeDetail {
readonly query: string;
readonly reason: "input" | "programmatic";
}
Name
Kind
Type
Requirement
query
property
string
required
reason
property
"input" | "programmatic"
required
Name
query
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"input" | "programmatic"
Requirement
required
DeclarationView source
CommandSelectionReasonts
type CommandSelectionReason = "pointer" | "keyboard" | "programmatic";
DeclarationView source
commandSelectorsts
export 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[];
};
Name
Kind
Type
Requirement
filteredGroups
property
<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => readonly CommandGroup<Item>[]
required
flatItems
property
<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => readonly Item[]
required
highlightedIndex
property
<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => number
required
open
property
<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => boolean
required
query
property
<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => string
required
value
property
<Item extends CommandItem>(snapshot: CommandSnapshot<Item>) => string | undefined
required
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
DeclarationView source
CommandServicets
type CommandService<Item extends CommandItem = CommandItem> = Service<CommandInput<Item>, CommandStateValue, CommandContext<Item>, CommandEvent, CommandCommand>;
DeclarationView source
CommandSnapshotts
type CommandSnapshot<Item extends CommandItem = CommandItem> = Snapshot<CommandStateValue, CommandContext<Item>>;
DeclarationView source
CommandStateValuets
type CommandStateValue = "open" | "closed";
DeclarationView source
CommandValueChangeDetailts
interface CommandValueChangeDetail {
readonly value: string;
readonly reason: string;
}
Name
Kind
Type
Requirement
reason
property
string
required
value
property
string
required
Name
reason
Kind
property
Type
string
Requirement
required
Name
value
Kind
property
Type
string
Requirement
required

connectCommand

function
DeclarationView source
connectCommandts
declare function connectCommand<Item extends CommandItem = CommandItem>(service: CommandService<Item>, scope: PartScope, _options?: CommandConnectOptions): CommandApi<Item>;
Name
Kind
Type
Requirement
service
parameter
CommandService<Item>
required
scope
parameter
PartScope
required
_options
parameter
CommandConnectOptions
optional
return
return value
CommandApi<Item>
n/a
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

function
DeclarationView source
mountCommandts
declare function mountCommand<Item extends CommandItem = CommandItem>(container: HTMLElement, options: MountCommandOptions<Item>): CommandMount<Item>;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountCommandOptions<Item>
required
return
return value
CommandMount<Item>
n/a
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
DeclarationView source
MountCommandOptionsts
interface 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;
}
Name
Kind
Type
Requirement
announce
property
(key: string, params: Record<string, string | number | null>, politeness: string) => void
optional
emptyText
property
string
optional
onOpenChange
property
(detail: CommandOpenChangeDetail) => void
optional
onQueryChange
property
(detail: CommandQueryChangeDetail) => void
optional
onValueChange
property
(detail: CommandValueChangeDetail) => void
optional
renderItem
property
(element: HTMLElement, item: Item) => void
optional
renderItemText
property
(element: HTMLElement, item: Item) => void
optional
renderTrigger
property
(element: HTMLButtonElement) => void
optional
triggerText
property
string
optional
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
DeclarationView source
runCommandCommandts
declare function runCommandCommand(command: CommandCommand, scope: PartScope, options?: CommandConnectOptions): void;
Name
Kind
Type
Requirement
command
parameter
CommandCommand
required
scope
parameter
PartScope
required
options
parameter
CommandConnectOptions
optional
return
return value
void
n/a
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 example follows below.

React imports

@grassroot/ui-headless-react/commandts
import { Command, Content, Empty, Group, GroupLabel, Item, ItemText, Positioner } from "@grassroot/ui-headless-react/command"; // +3 more exports

Vue imports

@grassroot/ui-headless-vue/commandts
<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

@grassroot/ui-headless-angular/commandts
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

@grassroot/ui-headless-svelte/commandts
<script lang="ts">
import { Command, Content, Empty, Group, GroupLabel, Item, ItemText, Positioner } from "@grassroot/ui-headless-svelte/command"; // +2 more exports
</script>

Solid imports

@grassroot/ui-headless-solid/commandts
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

33 exports
View source packages/ui-headless/react/src/command/index.ts

Command

value
DeclarationView source
Commandts
export 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>>;
};
Name
Kind
Type
Requirement
Content
property
import("react").ForwardRefExoticComponent<CommandContentProps & import("react").RefAttributes<HTMLDivElement>>
required
Empty
property
import("react").ForwardRefExoticComponent<CommandEmptyProps & import("react").RefAttributes<HTMLDivElement>>
required
Group
property
import("react").ForwardRefExoticComponent<CommandGroupProps & import("react").RefAttributes<HTMLDivElement>>
required
GroupLabel
property
import("react").ForwardRefExoticComponent<CommandGroupLabelProps & import("react").RefAttributes<HTMLDivElement>>
required
Input
property
import("react").ForwardRefExoticComponent<CommandInputProps & import("react").RefAttributes<HTMLInputElement>>
required
Item
property
import("react").ForwardRefExoticComponent<CommandItemProps & import("react").RefAttributes<HTMLDivElement>>
required
ItemText
property
import("react").ForwardRefExoticComponent<CommandItemTextProps & import("react").RefAttributes<HTMLSpanElement>>
required
Positioner
property
import("react").ForwardRefExoticComponent<CommandPositionerProps & import("react").RefAttributes<HTMLDivElement>>
required
Root
property
import("react").ForwardRefExoticComponent<CommandRootProps & import("react").RefAttributes<HTMLDivElement>>
required
RootProvider
property
import("react").ForwardRefExoticComponent<CommandRootProviderProps & import("react").RefAttributes<HTMLDivElement>>
required
Trigger
property
import("react").ForwardRefExoticComponent<CommandTriggerProps & import("react").RefAttributes<HTMLButtonElement>>
required
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
DeclarationView source
CommandContentPropsts
interface CommandContentProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
CommandContextts
export declare const CommandContext: import("react").Context<CommandContextValue | null>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a
DeclarationView source
CommandContextValuets
interface CommandContextValue {
readonly service: CommandService;
readonly connector: CommandApi;
readonly scope: PartScope;
readonly snapshot: CommandSnapshot;
}
Name
Kind
Type
Requirement
connector
property
CommandApi
required
scope
property
PartScope
required
service
property
CommandService
required
snapshot
property
CommandSnapshot
required
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

interface
DeclarationView source
CommandEmptyPropsts
interface CommandEmptyProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
CommandGroupLabelPropsts
interface CommandGroupLabelProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
readonly group: CommandGroup;
readonly index?: number;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
group
property
CommandGroup
required
index
property
number
optional
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

interface
DeclarationView source
CommandGroupPropsts
interface CommandGroupProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
readonly group: CommandGroup;
readonly index?: number;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
group
property
CommandGroup
required
index
property
number
optional
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

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

CommandItemProps

interface
DeclarationView source
CommandItemPropsts
interface CommandItemProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
readonly item: CommandItem;
readonly index?: number;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
index
property
number
optional
item
property
CommandItem
required
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
DeclarationView source
CommandItemTextPropsts
interface CommandItemTextProps extends ComponentPropsWithoutRef<"span"> {
readonly asChild?: boolean;
readonly item: CommandItem;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
item
property
CommandItem
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
item
Kind
property
Type
CommandItem
Requirement
required
DeclarationView source
CommandOpenChangeDetailts
interface CommandOpenChangeDetail {
readonly open: boolean;
readonly reason: CommandChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
CommandChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
CommandChangeReason
Requirement
required
DeclarationView source
CommandPositionerPropsts
interface CommandPositionerProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
CommandQueryChangeDetailts
interface CommandQueryChangeDetail {
readonly query: string;
readonly reason: "input" | "programmatic";
}
Name
Kind
Type
Requirement
query
property
string
required
reason
property
"input" | "programmatic"
required
Name
query
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"input" | "programmatic"
Requirement
required

CommandRootProps

interface
DeclarationView source
CommandRootPropsts
interface 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;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
defaultOpen
property
CommandInput["defaultOpen"]
optional
defaultQuery
property
CommandInput["defaultQuery"]
optional
defaultValue
property
CommandInput["defaultValue"]
optional
filter
property
CommandInput["filter"]
optional
groups
property
CommandInput["groups"]
required
onOpenChange
property
UseCommandOptions["onOpenChange"]
optional
onQueryChange
property
UseCommandOptions["onQueryChange"]
optional
onValueChange
property
UseCommandOptions["onValueChange"]
optional
open
property
CommandInput["open"]
optional
query
property
CommandInput["query"]
optional
value
property
CommandInput["value"]
optional
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
DeclarationView source
CommandRootProviderPropsts
interface CommandRootProviderProps extends ComponentPropsWithoutRef<"div"> {
readonly value: UseCommandResult;
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
value
property
UseCommandResult
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
value
Kind
property
Type
UseCommandResult
Requirement
required
DeclarationView source
CommandTriggerPropsts
interface CommandTriggerProps extends ComponentPropsWithoutRef<"button"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
CommandValueChangeDetailts
interface CommandValueChangeDetail {
readonly value: string;
readonly reason: "pointer" | "keyboard" | "programmatic";
}
Name
Kind
Type
Requirement
reason
property
"pointer" | "keyboard" | "programmatic"
required
value
property
string
required
Name
reason
Kind
property
Type
"pointer" | "keyboard" | "programmatic"
Requirement
required
Name
value
Kind
property
Type
string
Requirement
required

Content

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

Empty

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

Group

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

GroupLabel

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

Input

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

Item

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

ItemText

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

Positioner

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

Root

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

RootProvider

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

Trigger

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

useCommand

function
DeclarationView source
useCommandts
declare function useCommand(input: CommandInput, options?: UseCommandOptions): UseCommandResult;
Name
Kind
Type
Requirement
input
parameter
CommandInput
required
options
parameter
UseCommandOptions
optional
return
return value
UseCommandResult
n/a
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
DeclarationView source
useCommandContextts
declare function useCommandContext(partName: string): CommandContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
CommandContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
CommandContextValue
Requirement
n/a

UseCommandOptions

interface
DeclarationView source
UseCommandOptionsts
interface UseCommandOptions {
readonly onOpenChange?: (detail: CommandOpenChangeDetail) => void;
readonly onValueChange?: (detail: CommandValueChangeDetail) => void;
readonly onQueryChange?: (detail: CommandQueryChangeDetail) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: CommandOpenChangeDetail) => void
optional
onQueryChange
property
(detail: CommandQueryChangeDetail) => void
optional
onValueChange
property
(detail: CommandValueChangeDetail) => void
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

UseCommandResult

interface
DeclarationView source
UseCommandResultts
interface UseCommandResult {
readonly service: CommandService;
readonly connector: CommandApi;
readonly scope: PartScope;
readonly snapshot: CommandSnapshot;
}
Name
Kind
Type
Requirement
connector
property
CommandApi
required
scope
property
PartScope
required
service
property
CommandService
required
snapshot
property
CommandSnapshot
required
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

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

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

@grassroot/ui-headless-vue/command

Vue adapter

22 exports
View source packages/ui-headless/vue/src/command/index.ts

Command

value
DeclarationView source
Commandts
export 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>;
};
Name
Kind
Type
Requirement
Content
property
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>
required
Empty
property
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>
required
Group
property
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>
required
GroupLabel
property
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>
required
Input
property
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>
required
Item
property
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>
required
ItemText
property
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>
required
Positioner
property
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>
required
Root
property
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>
required
RootProvider
property
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>
required
Trigger
property
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>
required
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
DeclarationView source
CommandContextKeyts
export declare const CommandContextKey: InjectionKey<CommandContextValue>;
DeclarationView source
CommandContextValuets
interface CommandContextValue {
readonly service: CommandService;
readonly connector: CommandApi;
readonly scope: PartScope;
readonly snapshot: ShallowRef<CommandSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
CommandApi
required
scope
property
PartScope
required
service
property
CommandService
required
snapshot
property
ShallowRef<CommandSnapshot>
required
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
DeclarationView source
CommandOpenChangeDetailts
interface CommandOpenChangeDetail {
readonly open: boolean;
readonly reason: CommandChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
CommandChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
CommandChangeReason
Requirement
required
DeclarationView source
CommandQueryChangeDetailts
interface CommandQueryChangeDetail {
readonly query: string;
readonly reason: "input" | "programmatic";
}
Name
Kind
Type
Requirement
query
property
string
required
reason
property
"input" | "programmatic"
required
Name
query
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"input" | "programmatic"
Requirement
required
DeclarationView source
CommandValueChangeDetailts
interface CommandValueChangeDetail {
readonly value: string;
readonly reason: "pointer" | "keyboard" | "programmatic";
}
Name
Kind
Type
Requirement
reason
property
"pointer" | "keyboard" | "programmatic"
required
value
property
string
required
Name
reason
Kind
property
Type
"pointer" | "keyboard" | "programmatic"
Requirement
required
Name
value
Kind
property
Type
string
Requirement
required

Content

value
DeclarationView source
Contentts
export 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

value
DeclarationView source
Emptyts
export 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

value
DeclarationView source
Groupts
export 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

value
DeclarationView source
GroupLabelts
export 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

value
DeclarationView source
Inputts
export 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

value
DeclarationView source
Itemts
export 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

value
DeclarationView source
ItemTextts
export 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

value
DeclarationView source
Positionerts
export 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>;
DeclarationView source
provideCommandContextts
declare function provideCommandContext(value: CommandContextValue): void;
Name
Kind
Type
Requirement
value
parameter
CommandContextValue
required
return
return value
void
n/a
Name
value
Kind
parameter
Type
CommandContextValue
Requirement
required
Name
return
Kind
return value
Type
void
Requirement
n/a

Root

value
DeclarationView source
Rootts
export 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

value
DeclarationView source
RootProviderts
export 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

value
DeclarationView source
Triggerts
export 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

function
DeclarationView source
useCommandts
declare function useCommand(input: CommandInput | (() => CommandInput), options?: UseCommandOptions): UseCommandResult;
Name
Kind
Type
Requirement
input
parameter
CommandInput | (() => CommandInput)
required
options
parameter
UseCommandOptions
optional
return
return value
UseCommandResult
n/a
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
DeclarationView source
useCommandContextts
declare function useCommandContext(partName: string): CommandContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
CommandContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
CommandContextValue
Requirement
n/a

UseCommandOptions

interface
DeclarationView source
UseCommandOptionsts
interface UseCommandOptions {
readonly onOpenChange?: (detail: CommandOpenChangeDetail) => void;
readonly onValueChange?: (detail: CommandValueChangeDetail) => void;
readonly onQueryChange?: (detail: CommandQueryChangeDetail) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: CommandOpenChangeDetail) => void
optional
onQueryChange
property
(detail: CommandQueryChangeDetail) => void
optional
onValueChange
property
(detail: CommandValueChangeDetail) => void
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

UseCommandResult

interface
DeclarationView source
UseCommandResultts
interface UseCommandResult {
readonly service: CommandService;
readonly connector: CommandApi;
readonly scope: PartScope;
readonly snapshot: ShallowRef<CommandSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
CommandApi
required
scope
property
PartScope
required
service
property
CommandService
required
snapshot
property
ShallowRef<CommandSnapshot>
required
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

21 exports
View source packages/ui-headless/angular/src/command/index.ts
DeclarationView source
COMMAND_STOREts
export declare const COMMAND_STORE: InjectionToken<CommandStore>;
DeclarationView source
CommandOpenChangeDetailts
export interface CommandOpenChangeDetail {
readonly open: boolean;
readonly reason: CommandChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
CommandChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
CommandChangeReason
Requirement
required
DeclarationView source
CommandQueryChangeDetailts
export interface CommandQueryChangeDetail {
readonly query: string;
readonly reason: "input" | "programmatic";
}
Name
Kind
Type
Requirement
query
property
string
required
reason
property
"input" | "programmatic"
required
Name
query
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"input" | "programmatic"
Requirement
required

CommandStore

interface
DeclarationView source
CommandStorets
export 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;
}
Name
Kind
Type
Requirement
connector
property
CommandApi
required
scope
property
PartScope
required
service
property
CommandService
required
start
method
() => void
required
stop
method
() => void
required
sync
method
(input: import("@grassroot/ui-machines/command").CommandInput) => void
required
version
property
WritableSignal<number>
required
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
DeclarationView source
CommandValueChangeDetailts
export interface CommandValueChangeDetail {
readonly value: string;
readonly reason: "pointer" | "keyboard" | "programmatic";
}
Name
Kind
Type
Requirement
reason
property
"pointer" | "keyboard" | "programmatic"
required
value
property
string
required
Name
reason
Kind
property
Type
"pointer" | "keyboard" | "programmatic"
Requirement
required
Name
value
Kind
property
Type
string
Requirement
required
DeclarationView source
createCommandStorets
export declare function createCommandStore(initialInput: CommandInput, options?: CreateCommandStoreOptions): CommandStore;
Name
Kind
Type
Requirement
initialInput
parameter
CommandInput
required
options
parameter
CreateCommandStoreOptions
optional
return
return value
CommandStore
n/a
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
DeclarationView source
CreateCommandStoreOptionsts
export interface CreateCommandStoreOptions {
readonly onOpenChange?: (detail: CommandOpenChangeDetail) => void;
readonly onValueChange?: (detail: CommandValueChangeDetail) => void;
readonly onQueryChange?: (detail: CommandQueryChangeDetail) => void;
readonly onCommit?: () => void;
}
Name
Kind
Type
Requirement
onCommit
property
() => void
optional
onOpenChange
property
(detail: CommandOpenChangeDetail) => void
optional
onQueryChange
property
(detail: CommandQueryChangeDetail) => void
optional
onValueChange
property
(detail: CommandValueChangeDetail) => void
optional
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
DeclarationView source
GR_COMMAND_DECLARATIONSts
export 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];
DeclarationView source
GrCommandContentts
export declare class GrCommandContent extends CommandPart {
constructor();
static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandContent, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandContent, "[grCommandContent]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCommandContent, "[grCommandContent]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCommandContent, never>
required
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
DeclarationView source
GrCommandEmptyts
export 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>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
element
property
any
required
listeners
property
any
required
mounted
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCommandEmpty, "[grCommandEmpty]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCommandEmpty, never>
required
store
property
any
required
template
property
any
required
view
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
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
DeclarationView source
GrCommandGroupts
export 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>;
}
Name
Kind
Type
Requirement
grCommandGroup
property
import("@angular/core").InputSignal<CommandGroup>
required
mounted
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCommandGroup, "[grCommandGroup]", never, { "grCommandGroup": { "alias": "grCommandGroup"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCommandGroup, never>
required
store
property
any
required
template
property
any
required
view
property
any
required
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
DeclarationView source
GrCommandGroupLabelts
export 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>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
element
property
any
required
group
property
import("@angular/core").InputSignal<CommandGroup>
required
index
property
import("@angular/core").InputSignal<number>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCommandGroupLabel, "[grCommandGroupLabel]", never, { "group": { "alias": "group"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCommandGroupLabel, never>
required
store
property
any
required
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
DeclarationView source
GrCommandGroupPartts
export 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>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
element
property
any
required
group
property
import("@angular/core").InputSignal<CommandGroup>
required
index
property
import("@angular/core").InputSignal<number>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCommandGroupPart, "[grCommandGroupPart]", never, { "group": { "alias": "group"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCommandGroupPart, never>
required
store
property
any
required
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
DeclarationView source
GrCommandInputts
export declare class GrCommandInput extends CommandPart {
constructor();
static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandInput, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandInput, "[grCommandInput]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCommandInput, "[grCommandInput]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCommandInput, never>
required
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
DeclarationView source
GrCommandItemts
export 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>;
}
Name
Kind
Type
Requirement
grCommandItem
property
import("@angular/core").InputSignal<import("@grassroot/ui-core").CommandItem>
required
mounted
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCommandItem, "[grCommandItem]", never, { "grCommandItem": { "alias": "grCommandItem"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCommandItem, never>
required
store
property
any
required
template
property
any
required
view
property
any
required
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
DeclarationView source
GrCommandItemPartts
export 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>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
element
property
any
required
index
property
import("@angular/core").InputSignal<number | undefined>
required
item
property
import("@angular/core").InputSignal<import("@grassroot/ui-core").CommandItem>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCommandItemPart, "[grCommandItemPart]", never, { "item": { "alias": "item"; "required": true; "isSignal": true; }; "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCommandItemPart, never>
required
store
property
any
required
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
DeclarationView source
GrCommandItemTextts
export 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>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
element
property
any
required
item
property
import("@angular/core").InputSignal<import("@grassroot/ui-core").CommandItem>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCommandItemText, "[grCommandItemText]", never, { "item": { "alias": "item"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCommandItemText, never>
required
store
property
any
required
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
DeclarationView source
GrCommandOpents
export 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>;
}
Name
Kind
Type
Requirement
mounted
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCommandOpen, "[grCommandOpen]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCommandOpen, never>
required
release
property
any
required
store
property
any
required
template
property
any
required
view
property
any
required
Name
mounted
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<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
DeclarationView source
GrCommandPositionerts
export declare class GrCommandPositioner extends CommandPart {
constructor();
static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandPositioner, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandPositioner, "[grCommandPositioner]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCommandPositioner, "[grCommandPositioner]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCommandPositioner, never>
required
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
DeclarationView source
GrCommandRootts
export 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>;
}
Name
Kind
Type
Requirement
appRef
property
any
required
consumerProps
property
any
required
defaultOpen
property
import("@angular/core").InputSignal<boolean | undefined>
required
defaultQuery
property
import("@angular/core").InputSignal<string | undefined>
required
defaultValue
property
import("@angular/core").InputSignal<string | undefined>
required
element
property
any
required
filter
property
import("@angular/core").InputSignal<import("@grassroot/ui-machines/command").CommandFilter<import("@grassroot/ui-core").CommandItem> | undefined>
required
groups
property
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/command").CommandGroup<import("@grassroot/ui-core").CommandItem>[]>
required
injector
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
open
property
import("@angular/core").InputSignal<boolean | undefined>
required
openChange
property
import("@angular/core").OutputEmitterRef<CommandOpenChangeDetail>
required
ɵdir
property
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>
required
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
DeclarationView source
GrCommandTriggerts
export declare class GrCommandTrigger extends CommandPart {
constructor();
static ɵfac: i0.ɵɵFactoryDeclaration<GrCommandTrigger, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrCommandTrigger, "[grCommandTrigger]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCommandTrigger, "[grCommandTrigger]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCommandTrigger, never>
required
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

20 exports
View source packages/ui-headless/svelte/src/command/index.ts

Command

value
DeclarationView source
Commandts
export 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;
};
Name
Kind
Type
Requirement
Content
property
import("svelte/legacy").LegacyComponentType
required
Empty
property
import("svelte/legacy").LegacyComponentType
required
Group
property
import("svelte/legacy").LegacyComponentType
required
GroupLabel
property
import("svelte/legacy").LegacyComponentType
required
Input
property
import("svelte/legacy").LegacyComponentType
required
Item
property
import("svelte/legacy").LegacyComponentType
required
ItemText
property
import("svelte/legacy").LegacyComponentType
required
Positioner
property
import("svelte/legacy").LegacyComponentType
required
Root
property
import("svelte/legacy").LegacyComponentType
required
Trigger
property
import("svelte/legacy").LegacyComponentType
required
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
DeclarationView source
CommandContextValuets
export interface CommandContextValue {
readonly service: CommandService;
readonly connector: CommandApi;
readonly scope: PartScope;
readonly version: () => number;
readonly snapshot: () => CommandSnapshot;
}
Name
Kind
Type
Requirement
connector
property
CommandApi
required
scope
property
PartScope
required
service
property
CommandService
required
snapshot
property
() => CommandSnapshot
required
version
property
() => number
required
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
DeclarationView source
CommandOpenChangeDetailts
export interface CommandOpenChangeDetail {
readonly open: boolean;
readonly reason: CommandChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
CommandChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
CommandChangeReason
Requirement
required
DeclarationView source
CommandQueryChangeDetailts
export interface CommandQueryChangeDetail {
readonly query: string;
readonly reason: "input" | "programmatic";
}
Name
Kind
Type
Requirement
query
property
string
required
reason
property
"input" | "programmatic"
required
Name
query
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"input" | "programmatic"
Requirement
required
DeclarationView source
CommandValueChangeDetailts
export interface CommandValueChangeDetail {
readonly value: string;
readonly reason: "pointer" | "keyboard" | "programmatic";
}
Name
Kind
Type
Requirement
reason
property
"pointer" | "keyboard" | "programmatic"
required
value
property
string
required
Name
reason
Kind
property
Type
"pointer" | "keyboard" | "programmatic"
Requirement
required
Name
value
Kind
property
Type
string
Requirement
required

Content

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

createCommand

function
DeclarationView source
createCommandts
export declare function createCommand(inputGetter: () => CommandInput, options?: UseCommandOptions): UseCommandResult;
Name
Kind
Type
Requirement
inputGetter
parameter
() => CommandInput
required
options
parameter
UseCommandOptions
optional
return
return value
UseCommandResult
n/a
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

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

Group

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

GroupLabel

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

Input

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

Item

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

ItemText

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

Positioner

value
DeclarationView source
Positionerts
export declare const Positioner: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a
DeclarationView source
provideCommandContextts
export declare function provideCommandContext(value: CommandContextValue): void;
Name
Kind
Type
Requirement
value
parameter
CommandContextValue
required
return
return value
void
n/a
Name
value
Kind
parameter
Type
CommandContextValue
Requirement
required
Name
return
Kind
return value
Type
void
Requirement
n/a

Root

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

Trigger

value
DeclarationView source
Triggerts
export declare const Trigger: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a
DeclarationView source
useCommandContextts
export declare function useCommandContext(partName: string): CommandContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
CommandContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
CommandContextValue
Requirement
n/a

UseCommandOptions

interface
DeclarationView source
UseCommandOptionsts
export interface UseCommandOptions {
readonly onOpenChange?: (detail: CommandOpenChangeDetail) => void;
readonly onValueChange?: (detail: CommandValueChangeDetail) => void;
readonly onQueryChange?: (detail: CommandQueryChangeDetail) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: CommandOpenChangeDetail) => void
optional
onQueryChange
property
(detail: CommandQueryChangeDetail) => void
optional
onValueChange
property
(detail: CommandValueChangeDetail) => void
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

UseCommandResult

interface
DeclarationView source
UseCommandResultts
export interface UseCommandResult {
readonly service: CommandService;
readonly connector: CommandApi;
readonly scope: PartScope;
readonly version: () => number;
readonly snapshot: () => CommandSnapshot;
}
Name
Kind
Type
Requirement
connector
property
CommandApi
required
scope
property
PartScope
required
service
property
CommandService
required
snapshot
property
() => CommandSnapshot
required
version
property
() => number
required
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

21 exports
View source packages/ui-headless/solid/src/command/index.ts

Command

value
DeclarationView source
Commandts
export 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;
};
Name
Kind
Type
Requirement
Content
property
(props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element
required
Empty
property
(props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element
required
Group
property
typeof CommandGroup
required
GroupLabel
property
typeof CommandGroupLabel
required
Input
property
(props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element
required
Item
property
typeof CommandItem
required
ItemText
property
typeof CommandItemText
required
Positioner
property
(props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element
required
Root
property
typeof CommandRoot
required
RootProvider
property
typeof CommandRootProvider
required
Trigger
property
(props: { as?: string | import("solid-js").Component<Record<string, unknown>>; children?: import("solid-js").JSX.Element; } & Record<string, unknown>) => import("solid-js").JSX.Element
required
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
DeclarationView source
CommandContextts
export declare const CommandContext: import("solid-js").Context<CommandContextValue | undefined>;
DeclarationView source
CommandContextValuets
export interface CommandContextValue {
readonly service: CommandService;
readonly connector: CommandApi;
readonly scope: PartScope;
readonly snapshot: Accessor<CommandSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
CommandApi
required
scope
property
PartScope
required
service
property
CommandService
required
snapshot
property
Accessor<CommandSnapshot>
required
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
DeclarationView source
CommandOpenChangeDetailts
export interface CommandOpenChangeDetail {
readonly open: boolean;
readonly reason: CommandChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
CommandChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
CommandChangeReason
Requirement
required
DeclarationView source
CommandQueryChangeDetailts
export interface CommandQueryChangeDetail {
readonly query: string;
readonly reason: "input" | "programmatic";
}
Name
Kind
Type
Requirement
query
property
string
required
reason
property
"input" | "programmatic"
required
Name
query
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"input" | "programmatic"
Requirement
required
DeclarationView source
CommandValueChangeDetailts
export interface CommandValueChangeDetail {
readonly value: string;
readonly reason: "pointer" | "keyboard" | "programmatic";
}
Name
Kind
Type
Requirement
reason
property
"pointer" | "keyboard" | "programmatic"
required
value
property
string
required
Name
reason
Kind
property
Type
"pointer" | "keyboard" | "programmatic"
Requirement
required
Name
value
Kind
property
Type
string
Requirement
required

Content

value
DeclarationView source
Contentts
export declare const Content: (props: SimpleProps) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
SimpleProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
SimpleProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

Empty

value
DeclarationView source
Emptyts
export declare const Empty: (props: SimpleProps) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
SimpleProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
SimpleProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

Group

function
DeclarationView source
Groupts
export declare function CommandGroup(props: {
group: CommandGroup;
index?: number;
as?: AsProp;
children?: JSX.Element;
} & Record<string, unknown>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ group: CommandGroup; index?: number; as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
required
return
return value
JSX.Element
n/a
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

function
DeclarationView source
GroupLabelts
export declare function CommandGroupLabel(props: {
group: CommandGroup;
index?: number;
as?: AsProp;
children?: JSX.Element;
} & Record<string, unknown>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ group: CommandGroup; index?: number; as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
required
return
return value
JSX.Element
n/a
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

value
DeclarationView source
Inputts
export declare const Input: (props: SimpleProps) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
SimpleProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
SimpleProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

Item

function
DeclarationView source
Itemts
export declare function CommandItem(props: {
item: CommandItem;
index?: number;
as?: AsProp;
children?: JSX.Element;
} & JSX.HTMLAttributes<HTMLDivElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ item: CommandItem; index?: number; as?: AsProp; children?: JSX.Element; } & JSX.HTMLAttributes<HTMLDivElement>
required
return
return value
JSX.Element
n/a
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

function
DeclarationView source
ItemTextts
export declare function CommandItemText(props: {
item: CommandItem;
as?: AsProp;
children?: JSX.Element;
} & Record<string, unknown>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ item: CommandItem; as?: AsProp; children?: JSX.Element; } & Record<string, unknown>
required
return
return value
JSX.Element
n/a
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

value
DeclarationView source
Positionerts
export declare const Positioner: (props: SimpleProps) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
SimpleProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
SimpleProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

Root

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

RootProvider

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

Trigger

value
DeclarationView source
Triggerts
export declare const Trigger: (props: SimpleProps) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
SimpleProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
SimpleProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

useCommand

function
DeclarationView source
useCommandts
export declare function useCommand(input: Accessor<CommandInput>, options?: UseCommandOptions): UseCommandResult;
Name
Kind
Type
Requirement
input
parameter
Accessor<CommandInput>
required
options
parameter
UseCommandOptions
optional
return
return value
UseCommandResult
n/a
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
DeclarationView source
useCommandContextts
export declare function useCommandContext(partName: string): CommandContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
CommandContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
CommandContextValue
Requirement
n/a

UseCommandOptions

interface
DeclarationView source
UseCommandOptionsts
export interface UseCommandOptions {
readonly onOpenChange?: (detail: CommandOpenChangeDetail) => void;
readonly onValueChange?: (detail: CommandValueChangeDetail) => void;
readonly onQueryChange?: (detail: CommandQueryChangeDetail) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: CommandOpenChangeDetail) => void
optional
onQueryChange
property
(detail: CommandQueryChangeDetail) => void
optional
onValueChange
property
(detail: CommandValueChangeDetail) => void
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

UseCommandResult

interface
DeclarationView source
UseCommandResultts
export interface UseCommandResult {
readonly service: CommandService;
readonly connector: CommandApi;
readonly scope: PartScope;
readonly snapshot: Accessor<CommandSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
CommandApi
required
scope
property
PartScope
required
service
property
CommandService
required
snapshot
property
Accessor<CommandSnapshot>
required
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