grassroot
Install

DocsAPI referenceHeadlesshidden-input

hidden-input 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/hidden-input

Core connector and vanilla API

5 exports
View source packages/ui-headless/core/src/hidden-input.ts

hiddenInputDescriptor

function
DeclarationView source
hiddenInputDescriptorts
declare function hiddenInputDescriptor(options: {
  name?: string;
  value: string | undefined;
  disabled?: boolean;
  required?: boolean;
}): HiddenInputDescriptor;
Name
Kind
Type
Requirement
options
parameter
{ name?: string; value: string | undefined; disabled?: boolean; required?: boolean; }
required
return
return value
HiddenInputDescriptor
n/a
Name
options
Kind
parameter
Type
{ name?: string; value: string | undefined; disabled?: boolean; required?: boolean; }
Requirement
required
Name
return
Kind
return value
Type
HiddenInputDescriptor
Requirement
n/a

hiddenInputDescriptors

function
DeclarationView source
hiddenInputDescriptorsts
declare function hiddenInputDescriptors(options: {
  name?: string;
  values: readonly string[];
  disabled?: boolean;
  required?: boolean;
}): readonly HiddenInputDescriptor[];
Name
Kind
Type
Requirement
options
parameter
{ name?: string; values: readonly string[]; disabled?: boolean; required?: boolean; }
required
return
return value
readonly HiddenInputDescriptor[]
n/a
Name
options
Kind
parameter
Type
{ name?: string; values: readonly string[]; disabled?: boolean; required?: boolean; }
Requirement
required
Name
return
Kind
return value
Type
readonly HiddenInputDescriptor[]
Requirement
n/a

hiddenInputProps

function
DeclarationView source
hiddenInputPropsts
declare function hiddenInputProps(options: {
  descriptor: HiddenInputDescriptor;
  scope: PartScope;
  dataScope: string;
  extra?: PartProps;
}): PartProps;
Name
Kind
Type
Requirement
options
parameter
{ descriptor: HiddenInputDescriptor; scope: PartScope; dataScope: string; extra?: PartProps; }
required
return
return value
PartProps
n/a
Name
options
Kind
parameter
Type
{ descriptor: HiddenInputDescriptor; scope: PartScope; dataScope: string; extra?: PartProps; }
Requirement
required
Name
return
Kind
return value
Type
PartProps
Requirement
n/a

restoreNativeChecked

function
DeclarationView source
restoreNativeCheckedts
declare function restoreNativeChecked(input: {
  checked: boolean;
} | null, committed: boolean): void;
Name
Kind
Type
Requirement
input
parameter
{ checked: boolean; } | null
required
committed
parameter
boolean
required
return
return value
void
n/a
Name
input
Kind
parameter
Type
{ checked: boolean; } | null
Requirement
required
Name
committed
Kind
parameter
Type
boolean
Requirement
required
Name
return
Kind
return value
Type
void
Requirement
n/a

restoreNativeValue

function
DeclarationView source
restoreNativeValuets
declare function restoreNativeValue(input: {
  value: string;
} | null, committed: string): void;
Name
Kind
Type
Requirement
input
parameter
{ value: string; } | null
required
committed
parameter
string
required
return
return value
void
n/a
Name
input
Kind
parameter
Type
{ value: string; } | null
Requirement
required
Name
committed
Kind
parameter
Type
string
Requirement
required
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 hidden-input yet — mount it through the vanilla API above.