grassroot
Install

DocsAPI referenceHeadlessassistant-suggestion

assistant-suggestion 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/assistant-suggestion

Core connector and vanilla API

6 exports
View source packages/ui-headless/core/src/assistant-suggestion/index.ts

assistantSuggestionAnatomy

value
DeclarationView source
assistantSuggestionAnatomyts
export declare const assistantSuggestionAnatomy: {
  readonly scope: "assistant-suggestion";
  readonly parts: readonly ["root", "title", "description", "trigger"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "title", "description", "trigger"]
required
scope
property
"assistant-suggestion"
required
Name
parts
Kind
property
Type
readonly ["root", "title", "description", "trigger"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-suggestion"
Requirement
required

AssistantSuggestionApi

interface
DeclarationView source
AssistantSuggestionApits
interface AssistantSuggestionApi {
  rootProps(): PartProps;
  titleProps(): PartProps;
  descriptionProps(): PartProps;
  triggerProps(): PartProps;
}
Name
Kind
Type
Requirement
descriptionProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
titleProps
method
() => PartProps
required
triggerProps
method
() => PartProps
required
Name
descriptionProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
titleProps
Kind
method
Type
() => PartProps
Requirement
required
Name
triggerProps
Kind
method
Type
() => PartProps
Requirement
required

AssistantSuggestionClientLike

type
DeclarationView source
AssistantSuggestionClientLikets
type AssistantSuggestionClientLike = {
  readonly composer?: {
    readonly setText: (text: string) => unknown;
    readonly send: (options?: {
      readonly steer?: boolean;
    }) => unknown;
  };
};
Name
Kind
Type
Requirement
composer
property
{ readonly setText: (text: string) => unknown; readonly send: (options?: { readonly steer?: boolean; }) => unknown; }
optional
Name
composer
Kind
property
Type
{ readonly setText: (text: string) => unknown; readonly send: (options?: { readonly steer?: boolean; }) => unknown; }
Requirement
optional

AssistantSuggestionConnectOptions

interface
DeclarationView source
AssistantSuggestionConnectOptionsts
interface AssistantSuggestionConnectOptions {
  readonly client: AssistantSuggestionClientLike;
  readonly text: string;
  readonly send?: boolean;
  readonly onTrigger?: () => void;
}
Name
Kind
Type
Requirement
client
property
AssistantSuggestionClientLike
required
onTrigger
property
() => void
optional
send
property
boolean
optional
text
property
string
required
Name
client
Kind
property
Type
AssistantSuggestionClientLike
Requirement
required
Name
onTrigger
Kind
property
Type
() => void
Requirement
optional
Name
send
Kind
property
Type
boolean
Requirement
optional
Name
text
Kind
property
Type
string
Requirement
required

AssistantSuggestionPart

type
DeclarationView source
AssistantSuggestionPartts
type AssistantSuggestionPart = (typeof assistantSuggestionAnatomy.parts)[number];

connectAssistantSuggestion

function
DeclarationView source
connectAssistantSuggestionts
declare function connectAssistantSuggestion(scope: PartScope, options: AssistantSuggestionConnectOptions): AssistantSuggestionApi;
Name
Kind
Type
Requirement
scope
parameter
PartScope
required
options
parameter
AssistantSuggestionConnectOptions
required
return
return value
AssistantSuggestionApi
n/a
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantSuggestionConnectOptions
Requirement
required
Name
return
Kind
return value
Type
AssistantSuggestionApi
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 assistant-suggestion yet — mount it through the vanilla API above.