- Name
command- Kind
- parameter
- Type
UiCommand- Requirement
- required
DocsAPI referenceHeadlesscommand-runner
command-runner 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.
1 of 1
@grassroot/ui-headless-core/command-runner
Core connector and vanilla API
runUiCommand
valuerunUiCommandts
export declare const runUiCommand: CommandRunner;Name
Kind
Type
Requirement
commandparameter
UiCommandrequired
scopeparameter
PartScoperequired
optionsparameter
{
announce?: (key: string, params: {
readonly [key: string]: string | number | null;
}, politeness: "polite" | "assertive") => void;
}optional
returnreturn value
voidn/a
- Name
scope- Kind
- parameter
- Type
PartScope- Requirement
- required
- Name
options- Kind
- parameter
- Type
{ announce?: (key: string, params: { readonly [key: string]: string | number | null; }, politeness: "polite" | "assertive") => void; }- 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.
This entry is core-only. No framework adapter package ships for command-runner yet — mount it through the vanilla API above.