grassroot
Install

DocsAPI referenceHeadlessassistant-branch-picker

assistant-branch-picker 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-branch-picker

Core connector and vanilla API

5 exports
View source packages/ui-headless/core/src/assistant-branch-picker/index.ts

assistantBranchPickerAnatomy

value
DeclarationView source
assistantBranchPickerAnatomyts
export declare const assistantBranchPickerAnatomy: {
  readonly scope: "assistant-branch-picker";
  readonly parts: readonly ["root", "previous", "next", "number", "count"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "previous", "next", "number", "count"]
required
scope
property
"assistant-branch-picker"
required
Name
parts
Kind
property
Type
readonly ["root", "previous", "next", "number", "count"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-branch-picker"
Requirement
required

AssistantBranchPickerApi

interface
DeclarationView source
AssistantBranchPickerApits
interface AssistantBranchPickerApi {
  rootProps(): PartProps;
  previousProps(): PartProps;
  nextProps(): PartProps;
  numberProps(): PartProps;
  countProps(): PartProps;
  readonly canPrevious: boolean;
  readonly canNext: boolean;
}
Name
Kind
Type
Requirement
canNext
property
boolean
required
canPrevious
property
boolean
required
countProps
method
() => PartProps
required
nextProps
method
() => PartProps
required
numberProps
method
() => PartProps
required
previousProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
Name
canNext
Kind
property
Type
boolean
Requirement
required
Name
canPrevious
Kind
property
Type
boolean
Requirement
required
Name
countProps
Kind
method
Type
() => PartProps
Requirement
required
Name
nextProps
Kind
method
Type
() => PartProps
Requirement
required
Name
numberProps
Kind
method
Type
() => PartProps
Requirement
required
Name
previousProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required

AssistantBranchPickerConnectOptions

interface
DeclarationView source
AssistantBranchPickerConnectOptionsts
interface AssistantBranchPickerConnectOptions {
  readonly branches: readonly string[];
  readonly currentIndex: number;
  readonly isRunning?: boolean;
  readonly switchBranchDuringRun?: boolean;
  readonly onSwitch?: (branchId: string) => void;
}
Name
Kind
Type
Requirement
branches
property
readonly string[]
required
currentIndex
property
number
required
isRunning
property
boolean
optional
onSwitch
property
(branchId: string) => void
optional
switchBranchDuringRun
property
boolean
optional
Name
branches
Kind
property
Type
readonly string[]
Requirement
required
Name
currentIndex
Kind
property
Type
number
Requirement
required
Name
isRunning
Kind
property
Type
boolean
Requirement
optional
Name
onSwitch
Kind
property
Type
(branchId: string) => void
Requirement
optional
Name
switchBranchDuringRun
Kind
property
Type
boolean
Requirement
optional

AssistantBranchPickerPart

type
DeclarationView source
AssistantBranchPickerPartts
type AssistantBranchPickerPart = (typeof assistantBranchPickerAnatomy.parts)[number];

connectAssistantBranchPicker

function
DeclarationView source
connectAssistantBranchPickerts
declare function connectAssistantBranchPicker(scope: PartScope, options: AssistantBranchPickerConnectOptions): AssistantBranchPickerApi;
Name
Kind
Type
Requirement
scope
parameter
PartScope
required
options
parameter
AssistantBranchPickerConnectOptions
required
return
return value
AssistantBranchPickerApi
n/a
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantBranchPickerConnectOptions
Requirement
required
Name
return
Kind
return value
Type
AssistantBranchPickerApi
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-branch-picker yet — mount it through the vanilla API above.