grassroot
Install

DocsAPI referenceHeadlessprop-bag

prop-bag 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/prop-bag

Core connector and vanilla API

5 exports
View source packages/ui-headless/core/src/prop-bag.ts

ClassifiedPartProps

interface
DeclarationView source
ClassifiedPartPropsts
interface ClassifiedPartProps {
  readonly attrs: PartProps;
  readonly events: Readonly<Record<string, unknown>>;
  readonly ref: unknown;
}
Name
Kind
Type
Requirement
attrs
property
PartProps
required
events
property
Readonly<Record<string, unknown>>
required
ref
property
unknown
required
Name
attrs
Kind
property
Type
PartProps
Requirement
required
Name
events
Kind
property
Type
Readonly<Record<string, unknown>>
Requirement
required
Name
ref
Kind
property
Type
unknown
Requirement
required

classifyPartProps

function

Splits framework-neutral connector props into attrs, events, and ref.

DeclarationView source
classifyPartPropsts
declare function classifyPartProps(props: PartProps): ClassifiedPartProps;
Name
Kind
Type
Requirement
props
parameter
PartProps
required
return
return value
ClassifiedPartProps
n/a
Name
props
Kind
parameter
Type
PartProps
Requirement
required
Name
return
Kind
return value
Type
ClassifiedPartProps
Requirement
n/a

isPartEventKey

function
DeclarationView source
isPartEventKeyts
declare function isPartEventKey(key: string): boolean;
Name
Kind
Type
Requirement
key
parameter
string
required
return
return value
boolean
n/a
Name
key
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
boolean
Requirement
n/a

PART_EVENT_KEY_RE

value
DeclarationView source
PART_EVENT_KEY_REts
export declare const PART_EVENT_KEY_RE: RegExp;

partEventName

function

Returns the lowercase DOM event name represented by a connector event key.

DeclarationView source
partEventNamets
declare function partEventName(key: string): string;
Name
Kind
Type
Requirement
key
parameter
string
required
return
return value
string
n/a
Name
key
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
string
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 prop-bag yet — mount it through the vanilla API above.