DocsAPI referenceHeadlessinput-otp

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

Core connector and vanilla API

13 exports
View source packages/ui-headless/core/src/input-otp/index.ts

connectInputOTP

function
DeclarationView source
connectInputOTPts
declare function connectInputOTP(service: InputOTPService, scope: PartScope, options?: InputOTPConnectOptions): InputOTPApi;
Name
Kind
Type
Requirement
service
parameter
InputOTPService
required
scope
parameter
PartScope
required
options
parameter
InputOTPConnectOptions
optional
return
return value
InputOTPApi
n/a
Name
service
Kind
parameter
Type
InputOTPService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
InputOTPConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
InputOTPApi
Requirement
n/a
DeclarationView source
inputOTPAnatomyts
export declare const inputOTPAnatomy: {
readonly scope: "input-otp";
readonly parts: readonly ["root", "input"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "input"]
required
scope
property
"input-otp"
required
Name
parts
Kind
property
Type
readonly ["root", "input"]
Requirement
required
Name
scope
Kind
property
Type
"input-otp"
Requirement
required

InputOTPApi

interface
DeclarationView source
InputOTPApits
interface InputOTPApi {
rootProps(): PartProps;
inputProps(index: number): PartProps;
syncNativeState(): void;
readonly value: string;
readonly length: number;
readonly focusIndex: number;
}
Name
Kind
Type
Requirement
focusIndex
property
number
required
inputProps
method
(index: number) => PartProps
required
length
property
number
required
rootProps
method
() => PartProps
required
syncNativeState
method
() => void
required
value
property
string
required
Name
focusIndex
Kind
property
Type
number
Requirement
required
Name
inputProps
Kind
method
Type
(index: number) => PartProps
Requirement
required
Name
length
Kind
property
Type
number
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
syncNativeState
Kind
method
Type
() => void
Requirement
required
Name
value
Kind
property
Type
string
Requirement
required
DeclarationView source
InputOTPChangeDetailts
interface InputOTPChangeDetail {
readonly value: string;
readonly reason: InputOTPReason;
}
Name
Kind
Type
Requirement
reason
property
InputOTPReason
required
value
property
string
required
Name
reason
Kind
property
Type
InputOTPReason
Requirement
required
Name
value
Kind
property
Type
string
Requirement
required
DeclarationView source
InputOTPConnectOptionsts
interface InputOTPConnectOptions {
readonly ariaLabel?: string;
readonly messages?: Partial<InputOTPMessages>;
readonly onValueChange?: (detail: InputOTPChangeDetail) => void;
readonly onComplete?: (value: string) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
messages
property
Partial<InputOTPMessages>
optional
onComplete
property
(value: string) => void
optional
onValueChange
property
(detail: InputOTPChangeDetail) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
messages
Kind
property
Type
Partial<InputOTPMessages>
Requirement
optional
Name
onComplete
Kind
property
Type
(value: string) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: InputOTPChangeDetail) => void
Requirement
optional
DeclarationView source
inputOTPMessagests
export declare const inputOTPMessages: InputOTPMessages;
DeclarationView source
InputOTPMessagests
type InputOTPMessages = Pick<MessageTable, "rootLabel" | "digitLabel">;

InputOTPMount

interface
DeclarationView source
InputOTPMountts
interface InputOTPMount {
readonly service: InputOTPService;
readonly connector: InputOTPApi;
readonly root: HTMLElement;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
InputOTPApi
required
destroy
method
() => void
required
root
property
HTMLElement
required
service
property
InputOTPService
required
Name
connector
Kind
property
Type
InputOTPApi
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLElement
Requirement
required
Name
service
Kind
property
Type
InputOTPService
Requirement
required
DeclarationView source
InputOTPPartts
type InputOTPPart = (typeof inputOTPAnatomy.parts)[number];
DeclarationView source
InputOTPServicets
type InputOTPService = Service<InputOTPInput, "ready", InputOTPContext, InputOTPEvent, InputOTPCommand>;

mountInputOTP

function
DeclarationView source
mountInputOTPts
declare function mountInputOTP(container: HTMLElement, options?: MountInputOTPOptions): InputOTPMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountInputOTPOptions
optional
return
return value
InputOTPMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
MountInputOTPOptions
Requirement
optional
Name
return
Kind
return value
Type
InputOTPMount
Requirement
n/a
DeclarationView source
MountInputOTPOptionsts
interface MountInputOTPOptions extends InputOTPInput, Pick<InputOTPConnectOptions, "ariaLabel" | "messages"> {
readonly onValueChange?: (detail: InputOTPChangeDetail) => void;
readonly onComplete?: (value: string) => void;
}
Name
Kind
Type
Requirement
onComplete
property
(value: string) => void
optional
onValueChange
property
(detail: InputOTPChangeDetail) => void
optional
Name
onComplete
Kind
property
Type
(value: string) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: InputOTPChangeDetail) => void
Requirement
optional
DeclarationView source
runInputOTPCommandts
declare function runInputOTPCommand(command: InputOTPCommand, options?: InputOTPConnectOptions): void;
Name
Kind
Type
Requirement
command
parameter
InputOTPCommand
required
options
parameter
InputOTPConnectOptions
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
InputOTPCommand
Requirement
required
Name
options
Kind
parameter
Type
InputOTPConnectOptions
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.

React example follows below.

React imports

@grassroot/ui-headless-react/input-otpts
import { Root, RootProvider } from "@grassroot/ui-headless-react/input-otp";

Vue imports

@grassroot/ui-headless-vue/input-otpts
<script setup lang="ts">
import { Root, RootProvider } from "@grassroot/ui-headless-vue/input-otp";
</script>

Angular imports

@grassroot/ui-headless-angular/input-otpts
import { GrInputOTPRoot, GrInputOTPRootProvider } from "@grassroot/ui-headless-angular/input-otp";

Svelte imports

@grassroot/ui-headless-svelte/input-otpts
<script lang="ts">
import { Root, RootProvider } from "@grassroot/ui-headless-svelte/input-otp";
</script>

Solid imports

@grassroot/ui-headless-solid/input-otpts
import { Root, RootProvider } from "@grassroot/ui-headless-solid/input-otp";

@grassroot/ui-headless-react/input-otp

React adapter

9 exports
View source packages/ui-headless/react/src/input-otp/index.ts

Input

value
DeclarationView source
Inputts
export declare const Input: import("react").ForwardRefExoticComponent<InputOTPInputProps & import("react").RefAttributes<HTMLInputElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

InputOTPInputProps

interface
DeclarationView source
InputOTPInputPropsts
interface InputOTPInputProps extends InputHTMLAttributes<HTMLInputElement> {
readonly index: number;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
children
property
ReactNode
optional
index
property
number
required
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
index
Kind
property
Type
number
Requirement
required

InputOTPRootProps

interface
DeclarationView source
InputOTPRootPropsts
interface InputOTPRootProps extends Omit<HTMLAttributes<HTMLDivElement>, "defaultValue">, InputOTPInput {
readonly ariaLabel?: string;
readonly id?: string;
readonly onValueChange?: (detail: InputOTPChangeDetail) => void;
readonly onComplete?: (value: string) => void;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
children
property
ReactNode
optional
id
property
string
optional
onComplete
property
(value: string) => void
optional
onValueChange
property
(detail: InputOTPChangeDetail) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
onComplete
Kind
property
Type
(value: string) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: InputOTPChangeDetail) => void
Requirement
optional
DeclarationView source
InputOTPRootProviderPropsts
interface InputOTPRootProviderProps extends HTMLAttributes<HTMLDivElement> {
readonly value: UseInputOTPResult;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
children
property
ReactNode
optional
value
property
UseInputOTPResult
required
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
value
Kind
property
Type
UseInputOTPResult
Requirement
required

Root

value
DeclarationView source
Rootts
export declare const Root: import("react").ForwardRefExoticComponent<InputOTPRootProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

RootProvider

value
DeclarationView source
RootProviderts
export declare const RootProvider: import("react").ForwardRefExoticComponent<InputOTPRootProviderProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

useInputOTP

function
DeclarationView source
useInputOTPts
declare function useInputOTP(input: InputOTPInput, options?: UseInputOTPOptions): UseInputOTPResult;
Name
Kind
Type
Requirement
input
parameter
InputOTPInput
required
options
parameter
UseInputOTPOptions
optional
return
return value
UseInputOTPResult
n/a
Name
input
Kind
parameter
Type
InputOTPInput
Requirement
required
Name
options
Kind
parameter
Type
UseInputOTPOptions
Requirement
optional
Name
return
Kind
return value
Type
UseInputOTPResult
Requirement
n/a

UseInputOTPOptions

interface
DeclarationView source
UseInputOTPOptionsts
interface UseInputOTPOptions {
readonly id?: string;
readonly ariaLabel?: string;
readonly onValueChange?: (detail: InputOTPChangeDetail) => void;
readonly onComplete?: (value: string) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
id
property
string
optional
onComplete
property
(value: string) => void
optional
onValueChange
property
(detail: InputOTPChangeDetail) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
onComplete
Kind
property
Type
(value: string) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: InputOTPChangeDetail) => void
Requirement
optional

UseInputOTPResult

interface
DeclarationView source
UseInputOTPResultts
interface UseInputOTPResult {
readonly service: InputOTPService;
readonly connector: InputOTPApi;
readonly scope: PartScope;
readonly snapshot: InputOTPSnapshot;
}
Name
Kind
Type
Requirement
connector
property
InputOTPApi
required
scope
property
PartScope
required
service
property
InputOTPService
required
snapshot
property
InputOTPSnapshot
required
Name
connector
Kind
property
Type
InputOTPApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
InputOTPService
Requirement
required
Name
snapshot
Kind
property
Type
InputOTPSnapshot
Requirement
required

@grassroot/ui-headless-vue/input-otp

Vue adapter

5 exports
View source packages/ui-headless/vue/src/input-otp/index.ts

Input

value
DeclarationView source
Inputts
export declare const Input: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
index: {
type: NumberConstructor;
required: true;
};
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
index: {
type: NumberConstructor;
required: true;
};
}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

Root

value
DeclarationView source
Rootts
export declare const Root: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
length: NumberConstructor;
value: PropType<string | undefined>;
defaultValue: PropType<string | undefined>;
disabled: BooleanConstructor;
ariaLabel: StringConstructor;
id: StringConstructor;
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
valueChange: (_detail: InputOTPChangeDetail) => true;
complete: (_value: string) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
length: NumberConstructor;
value: PropType<string | undefined>;
defaultValue: PropType<string | undefined>;
disabled: BooleanConstructor;
ariaLabel: StringConstructor;
id: StringConstructor;
}>> & Readonly<{
onComplete?: ((_value: string) => any) | undefined;
onValueChange?: ((_detail: InputOTPChangeDetail) => any) | undefined;
}>, {
disabled: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

RootProvider

value
DeclarationView source
RootProviderts
export declare const RootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
value: {
type: PropType<UseInputOTPResult>;
required: true;
};
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
value: {
type: PropType<UseInputOTPResult>;
required: true;
};
}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

useInputOTP

function
DeclarationView source
useInputOTPts
declare function useInputOTP(input: () => InputOTPInput, options?: () => InputOTPOptions): UseInputOTPResult;
Name
Kind
Type
Requirement
input
parameter
() => InputOTPInput
required
options
parameter
() => InputOTPOptions
optional
return
return value
UseInputOTPResult
n/a
Name
input
Kind
parameter
Type
() => InputOTPInput
Requirement
required
Name
options
Kind
parameter
Type
() => InputOTPOptions
Requirement
optional
Name
return
Kind
return value
Type
UseInputOTPResult
Requirement
n/a

UseInputOTPResult

interface
DeclarationView source
UseInputOTPResultts
interface UseInputOTPResult {
readonly service: InputOTPService;
readonly connector: InputOTPApi;
readonly scope: PartScope;
readonly snapshot: ShallowRef<InputOTPSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
InputOTPApi
required
scope
property
PartScope
required
service
property
InputOTPService
required
snapshot
property
ShallowRef<InputOTPSnapshot>
required
Name
connector
Kind
property
Type
InputOTPApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
InputOTPService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<InputOTPSnapshot>
Requirement
required

@grassroot/ui-headless-angular/input-otp

Angular adapter

5 exports
View source packages/ui-headless/angular/src/input-otp/index.ts
DeclarationView source
createInputOTPStorets
export declare function createInputOTPStore(initial: InputOTPInput, options?: InputOTPOptions): InputOTPStore;
Name
Kind
Type
Requirement
initial
parameter
InputOTPInput
required
options
parameter
InputOTPOptions
optional
return
return value
InputOTPStore
n/a
Name
initial
Kind
parameter
Type
InputOTPInput
Requirement
required
Name
options
Kind
parameter
Type
InputOTPOptions
Requirement
optional
Name
return
Kind
return value
Type
InputOTPStore
Requirement
n/a
DeclarationView source
GrInputOTPInputts
export declare class GrInputOTPInput implements OnDestroy {
readonly index: import("@angular/core").InputSignal<number>;
private readonly store;
private readonly element;
private readonly listeners;
private readonly consumer;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrInputOTPInput, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrInputOTPInput, "[grInputOtpInput]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
index
property
import("@angular/core").InputSignal<number>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrInputOTPInput, "[grInputOtpInput]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrInputOTPInput, never>
required
store
property
any
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
index
Kind
property
Type
import("@angular/core").InputSignal<number>
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrInputOTPInput, "[grInputOtpInput]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrInputOTPInput, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
DeclarationView source
GrInputOTPRootts
export declare class GrInputOTPRoot implements OnDestroy {
readonly length: import("@angular/core").InputSignal<number | undefined>;
readonly value: import("@angular/core").InputSignal<string | undefined>;
readonly defaultValue: import("@angular/core").InputSignal<string | undefined>;
readonly disabled: import("@angular/core").InputSignal<boolean>;
readonly ariaLabel: import("@angular/core").InputSignal<string | undefined>;
readonly valueChange: import("@angular/core").OutputEmitterRef<InputOTPChangeDetail>;
readonly complete: import("@angular/core").OutputEmitterRef<string>;
readonly store: InputOTPStore;
private readonly host;
private readonly listeners;
private last;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrInputOTPRoot, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<GrInputOTPRoot, "gr-input-otp-root", never, { "length": { "alias": "length"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; "complete": "complete"; }, never, ["*"], true, never>;
}
Name
Kind
Type
Requirement
ariaLabel
property
import("@angular/core").InputSignal<string | undefined>
required
complete
property
import("@angular/core").OutputEmitterRef<string>
required
defaultValue
property
import("@angular/core").InputSignal<string | undefined>
required
disabled
property
import("@angular/core").InputSignal<boolean>
required
host
property
any
required
last
property
any
required
length
property
import("@angular/core").InputSignal<number | undefined>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrInputOTPRoot, "gr-input-otp-root", never, { "length": { "alias": "length"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; "complete": "complete"; }, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrInputOTPRoot, never>
required
store
property
InputOTPStore
required
value
property
import("@angular/core").InputSignal<string | undefined>
required
valueChange
property
import("@angular/core").OutputEmitterRef<InputOTPChangeDetail>
required
Name
ariaLabel
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
complete
Kind
property
Type
import("@angular/core").OutputEmitterRef<string>
Requirement
required
Name
defaultValue
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
disabled
Kind
property
Type
import("@angular/core").InputSignal<boolean>
Requirement
required
Name
host
Kind
property
Type
any
Requirement
required
Name
last
Kind
property
Type
any
Requirement
required
Name
length
Kind
property
Type
import("@angular/core").InputSignal<number | undefined>
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵcmp
Kind
property
Type
i0.ɵɵComponentDeclaration<GrInputOTPRoot, "gr-input-otp-root", never, { "length": { "alias": "length"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; "complete": "complete"; }, never, ["*"], true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrInputOTPRoot, never>
Requirement
required
Name
store
Kind
property
Type
InputOTPStore
Requirement
required
Name
value
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
valueChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<InputOTPChangeDetail>
Requirement
required
DeclarationView source
GrInputOTPRootProviderts
export declare class GrInputOTPRootProvider implements OnDestroy {
private readonly store;
private readonly host;
private readonly listeners;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrInputOTPRootProvider, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<GrInputOTPRootProvider, "gr-input-otp-root-provider", never, {}, {}, never, ["*"], true, never>;
}
Name
Kind
Type
Requirement
host
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrInputOTPRootProvider, "gr-input-otp-root-provider", never, {}, {}, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrInputOTPRootProvider, never>
required
store
property
any
required
Name
host
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵcmp
Kind
property
Type
i0.ɵɵComponentDeclaration<GrInputOTPRootProvider, "gr-input-otp-root-provider", never, {}, {}, never, ["*"], true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrInputOTPRootProvider, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

InputOTPStore

interface
DeclarationView source
InputOTPStorets
export interface InputOTPStore {
readonly service: InputOTPService;
readonly connector: InputOTPApi;
readonly scope: PartScope;
readonly version: WritableSignal<number>;
start(): void;
stop(): void;
sync(input: Record<string, unknown>): void;
syncOptions(options: Record<string, unknown>): void;
}
Name
Kind
Type
Requirement
connector
property
InputOTPApi
required
scope
property
PartScope
required
service
property
InputOTPService
required
start
method
() => void
required
stop
method
() => void
required
sync
method
(input: Record<string, unknown>) => void
required
syncOptions
method
(options: Record<string, unknown>) => void
required
version
property
WritableSignal<number>
required
Name
connector
Kind
property
Type
InputOTPApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
InputOTPService
Requirement
required
Name
start
Kind
method
Type
() => void
Requirement
required
Name
stop
Kind
method
Type
() => void
Requirement
required
Name
sync
Kind
method
Type
(input: Record<string, unknown>) => void
Requirement
required
Name
syncOptions
Kind
method
Type
(options: Record<string, unknown>) => void
Requirement
required
Name
version
Kind
property
Type
WritableSignal<number>
Requirement
required

@grassroot/ui-headless-svelte/input-otp

Svelte adapter

6 exports
View source packages/ui-headless/svelte/src/input-otp/index.ts

createInputOTP

function
DeclarationView source
createInputOTPts
export declare function createInputOTP(input: () => InputOTPInput, options?: UseInputOTPOptions): UseInputOTPResult;
Name
Kind
Type
Requirement
input
parameter
() => InputOTPInput
required
options
parameter
UseInputOTPOptions
optional
return
return value
UseInputOTPResult
n/a
Name
input
Kind
parameter
Type
() => InputOTPInput
Requirement
required
Name
options
Kind
parameter
Type
UseInputOTPOptions
Requirement
optional
Name
return
Kind
return value
Type
UseInputOTPResult
Requirement
n/a

Input

value
DeclarationView source
Inputts
export declare const Input: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

Root

value
DeclarationView source
Rootts
export declare const Root: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

RootProvider

value
DeclarationView source
RootProviderts
export declare const RootProvider: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

UseInputOTPOptions

interface
DeclarationView source
UseInputOTPOptionsts
export interface UseInputOTPOptions {
readonly id?: string;
readonly ariaLabel?: string;
readonly onValueChange?: (detail: InputOTPChangeDetail) => void;
readonly onComplete?: (value: string) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
id
property
string
optional
onComplete
property
(value: string) => void
optional
onValueChange
property
(detail: InputOTPChangeDetail) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
onComplete
Kind
property
Type
(value: string) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: InputOTPChangeDetail) => void
Requirement
optional

UseInputOTPResult

interface
DeclarationView source
UseInputOTPResultts
export interface UseInputOTPResult {
readonly service: InputOTPService;
readonly connector: InputOTPApi;
readonly scope: ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>;
readonly version: () => number;
}
Name
Kind
Type
Requirement
connector
property
InputOTPApi
required
scope
property
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>
required
service
property
InputOTPService
required
version
property
() => number
required
Name
connector
Kind
property
Type
InputOTPApi
Requirement
required
Name
scope
Kind
property
Type
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>
Requirement
required
Name
service
Kind
property
Type
InputOTPService
Requirement
required
Name
version
Kind
property
Type
() => number
Requirement
required

@grassroot/ui-headless-solid/input-otp

Solid adapter

7 exports
View source packages/ui-headless/solid/src/input-otp/index.ts

Input

function
DeclarationView source
Inputts
export declare function Input(props: InputOTPInputProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
InputOTPInputProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
InputOTPInputProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

InputOTPInputProps

interface
DeclarationView source
InputOTPInputPropsts
export interface InputOTPInputProps extends JSX.InputHTMLAttributes<HTMLInputElement> {
readonly index: number;
}
Name
Kind
Type
Requirement
index
property
number
required
Name
index
Kind
property
Type
number
Requirement
required

InputOTPRootProps

interface
DeclarationView source
InputOTPRootPropsts
export interface InputOTPRootProps extends Omit<JSX.HTMLAttributes<HTMLDivElement>, "value" | "defaultValue">, InputOTPInput {
readonly ariaLabel?: string;
readonly id?: string;
readonly onValueChange?: (detail: InputOTPChangeDetail) => void;
readonly onComplete?: (value: string) => void;
readonly children?: JSX.Element;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
children
property
JSX.Element
optional
id
property
string
optional
onComplete
property
(value: string) => void
optional
onValueChange
property
(detail: InputOTPChangeDetail) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
children
Kind
property
Type
JSX.Element
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
onComplete
Kind
property
Type
(value: string) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: InputOTPChangeDetail) => void
Requirement
optional

Root

function
DeclarationView source
Rootts
export declare function Root(props: InputOTPRootProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
InputOTPRootProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
InputOTPRootProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

RootProvider

function
DeclarationView source
RootProviderts
export declare function RootProvider(props: {
readonly value: UseInputOTPResult;
readonly children?: JSX.Element;
} & JSX.HTMLAttributes<HTMLDivElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ readonly value: UseInputOTPResult; readonly children?: JSX.Element; } & JSX.HTMLAttributes<HTMLDivElement>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ readonly value: UseInputOTPResult; readonly children?: JSX.Element; } & JSX.HTMLAttributes<HTMLDivElement>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

useInputOTP

function
DeclarationView source
useInputOTPts
export declare function useInputOTP(input: () => InputOTPInput, options?: UseInputOTPOptions): UseInputOTPResult;
Name
Kind
Type
Requirement
input
parameter
() => InputOTPInput
required
options
parameter
UseInputOTPOptions
optional
return
return value
UseInputOTPResult
n/a
Name
input
Kind
parameter
Type
() => InputOTPInput
Requirement
required
Name
options
Kind
parameter
Type
UseInputOTPOptions
Requirement
optional
Name
return
Kind
return value
Type
UseInputOTPResult
Requirement
n/a

UseInputOTPResult

interface
DeclarationView source
UseInputOTPResultts
export interface UseInputOTPResult {
readonly service: InputOTPService;
readonly connector: InputOTPApi;
readonly scope: PartScope;
readonly snapshot: Accessor<number>;
}
Name
Kind
Type
Requirement
connector
property
InputOTPApi
required
scope
property
PartScope
required
service
property
InputOTPService
required
snapshot
property
Accessor<number>
required
Name
connector
Kind
property
Type
InputOTPApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
InputOTPService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<number>
Requirement
required