grassroot
Install

DocsAPI referenceHeadlessdyslexic-toggle

dyslexic-toggle 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.

Machine API

@grassroot/ui-headless-core/dyslexic-toggle

Core connector and vanilla API

11 exports
View source packages/ui-headless/core/src/dyslexic-toggle/index.ts

connectDyslexicToggle

function
DeclarationView source
connectDyslexicTogglets
declare function connectDyslexicToggle(service: DyslexicToggleService, scope: PartScope, options?: DyslexicToggleConnectOptions): DyslexicToggleApi;
Name
Kind
Type
Requirement
service
parameter
DyslexicToggleService
required
scope
parameter
PartScope
required
options
parameter
DyslexicToggleConnectOptions
optional
return
return value
DyslexicToggleApi
n/a
Name
service
Kind
parameter
Type
DyslexicToggleService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
DyslexicToggleConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
DyslexicToggleApi
Requirement
n/a

dyslexicToggleAnatomy

value
DeclarationView source
dyslexicToggleAnatomyts
export declare const dyslexicToggleAnatomy: {
  readonly scope: "dyslexic-toggle";
  readonly parts: readonly ["root"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root"]
required
scope
property
"dyslexic-toggle"
required
Name
parts
Kind
property
Type
readonly ["root"]
Requirement
required
Name
scope
Kind
property
Type
"dyslexic-toggle"
Requirement
required

DyslexicToggleApi

interface
DeclarationView source
DyslexicToggleApits
interface DyslexicToggleApi {
  rootProps(): PartProps;
  readonly on: boolean;
  readonly disabled: boolean;
}
Name
Kind
Type
Requirement
disabled
property
boolean
required
on
property
boolean
required
rootProps
method
() => PartProps
required
Name
disabled
Kind
property
Type
boolean
Requirement
required
Name
on
Kind
property
Type
boolean
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required

DyslexicToggleChangeDetail

interface
DeclarationView source
DyslexicToggleChangeDetailts
interface DyslexicToggleChangeDetail {
  readonly on: boolean;
  readonly reason: "pointer" | "keyboard" | "programmatic";
}
Name
Kind
Type
Requirement
on
property
boolean
required
reason
property
"pointer" | "keyboard" | "programmatic"
required
Name
on
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
"pointer" | "keyboard" | "programmatic"
Requirement
required

DyslexicToggleConnectOptions

interface
DeclarationView source
DyslexicToggleConnectOptionsts
interface DyslexicToggleConnectOptions {
  readonly ariaLabel?: string;
  readonly onChange?: (detail: DyslexicToggleChangeDetail) => void;
  readonly onPersist?: (on: boolean) => void;
  readonly onApplyFont?: (on: boolean) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
onApplyFont
property
(on: boolean) => void
optional
onChange
property
(detail: DyslexicToggleChangeDetail) => void
optional
onPersist
property
(on: boolean) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
onApplyFont
Kind
property
Type
(on: boolean) => void
Requirement
optional
Name
onChange
Kind
property
Type
(detail: DyslexicToggleChangeDetail) => void
Requirement
optional
Name
onPersist
Kind
property
Type
(on: boolean) => void
Requirement
optional

DyslexicToggleMount

interface
DeclarationView source
DyslexicToggleMountts
interface DyslexicToggleMount {
  readonly service: DyslexicToggleService;
  readonly connector: DyslexicToggleApi;
  readonly root: HTMLButtonElement;
  destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
DyslexicToggleApi
required
destroy
method
() => void
required
root
property
HTMLButtonElement
required
service
property
DyslexicToggleService
required
Name
connector
Kind
property
Type
DyslexicToggleApi
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLButtonElement
Requirement
required
Name
service
Kind
property
Type
DyslexicToggleService
Requirement
required

DyslexicTogglePart

type
DeclarationView source
DyslexicTogglePartts
type DyslexicTogglePart = (typeof dyslexicToggleAnatomy.parts)[number];

DyslexicToggleService

type
DeclarationView source
DyslexicToggleServicets
type DyslexicToggleService = Service<DyslexicToggleInput, "ready", DyslexicToggleContext, DyslexicToggleEvent, DyslexicToggleCommand>;

mountDyslexicToggle

function
DeclarationView source
mountDyslexicTogglets
declare function mountDyslexicToggle(container: HTMLElement, options?: MountDyslexicToggleOptions): DyslexicToggleMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountDyslexicToggleOptions
optional
return
return value
DyslexicToggleMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
MountDyslexicToggleOptions
Requirement
optional
Name
return
Kind
return value
Type
DyslexicToggleMount
Requirement
n/a

MountDyslexicToggleOptions

interface
DeclarationView source
MountDyslexicToggleOptionsts
interface MountDyslexicToggleOptions {
  readonly on?: boolean;
  readonly defaultOn?: boolean;
  readonly disabled?: boolean;
  readonly ariaLabel?: string;
  readonly onChange?: (detail: DyslexicToggleChangeDetail) => void;
  readonly onPersist?: (on: boolean) => void;
  readonly onApplyFont?: (on: boolean) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
defaultOn
property
boolean
optional
disabled
property
boolean
optional
on
property
boolean
optional
onApplyFont
property
(on: boolean) => void
optional
onChange
property
(detail: DyslexicToggleChangeDetail) => void
optional
onPersist
property
(on: boolean) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
defaultOn
Kind
property
Type
boolean
Requirement
optional
Name
disabled
Kind
property
Type
boolean
Requirement
optional
Name
on
Kind
property
Type
boolean
Requirement
optional
Name
onApplyFont
Kind
property
Type
(on: boolean) => void
Requirement
optional
Name
onChange
Kind
property
Type
(detail: DyslexicToggleChangeDetail) => void
Requirement
optional
Name
onPersist
Kind
property
Type
(on: boolean) => void
Requirement
optional

runDyslexicToggleCommand

function
DeclarationView source
runDyslexicToggleCommandts
declare function runDyslexicToggleCommand(command: DyslexicToggleCommand, options?: DyslexicToggleConnectOptions): void;
Name
Kind
Type
Requirement
command
parameter
DyslexicToggleCommand
required
options
parameter
DyslexicToggleConnectOptions
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
DyslexicToggleCommand
Requirement
required
Name
options
Kind
parameter
Type
DyslexicToggleConnectOptions
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/dyslexic-togglets
import { Root, RootProvider } from "@grassroot/ui-headless-react/dyslexic-toggle";

Vue imports

@grassroot/ui-headless-vue/dyslexic-togglets
<script setup lang="ts">
import { DyslexicToggleRoot, DyslexicToggleRootProvider } from "@grassroot/ui-headless-vue/dyslexic-toggle";
</script>

Angular imports

@grassroot/ui-headless-angular/dyslexic-togglets
import { GrDyslexicToggleRoot, GrDyslexicToggleRootProvider } from "@grassroot/ui-headless-angular/dyslexic-toggle";

Svelte imports

@grassroot/ui-headless-svelte/dyslexic-togglets
<script lang="ts">
  import { Root, RootProvider } from "@grassroot/ui-headless-svelte/dyslexic-toggle";
</script>

Solid imports

@grassroot/ui-headless-solid/dyslexic-togglets
import { Root, RootProvider } from "@grassroot/ui-headless-solid/dyslexic-toggle";

@grassroot/ui-headless-react/dyslexic-toggle

React adapter

7 exports
View source packages/ui-headless/react/src/dyslexic-toggle/index.ts

DyslexicToggleRootProps

interface
DeclarationView source
DyslexicToggleRootPropsts
interface DyslexicToggleRootProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, "defaultValue" | "onChange" | "disabled"> {
  readonly on?: boolean;
  readonly defaultOn?: boolean;
  readonly disabled?: boolean;
  readonly ariaLabel?: string;
  readonly id?: string;
  readonly onChange?: (detail: DyslexicToggleChangeDetail) => void;
  readonly onPersist?: (on: boolean) => void;
  readonly onApplyFont?: (on: boolean) => void;
  readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
children
property
ReactNode
optional
defaultOn
property
boolean
optional
disabled
property
boolean
optional
id
property
string
optional
on
property
boolean
optional
onApplyFont
property
(on: boolean) => void
optional
onChange
property
(detail: DyslexicToggleChangeDetail) => void
optional
onPersist
property
(on: boolean) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
defaultOn
Kind
property
Type
boolean
Requirement
optional
Name
disabled
Kind
property
Type
boolean
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
on
Kind
property
Type
boolean
Requirement
optional
Name
onApplyFont
Kind
property
Type
(on: boolean) => void
Requirement
optional
Name
onChange
Kind
property
Type
(detail: DyslexicToggleChangeDetail) => void
Requirement
optional
Name
onPersist
Kind
property
Type
(on: boolean) => void
Requirement
optional

DyslexicToggleRootProviderProps

interface
DeclarationView source
DyslexicToggleRootProviderPropsts
interface DyslexicToggleRootProviderProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, "defaultValue" | "onChange" | "disabled" | "value"> {
  readonly value: UseDyslexicToggleResult;
  readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
children
property
ReactNode
optional
value
property
UseDyslexicToggleResult
required
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
value
Kind
property
Type
UseDyslexicToggleResult
Requirement
required

Root

value
DeclarationView source
Rootts
export declare const Root: import("react").ForwardRefExoticComponent<DyslexicToggleRootProps & import("react").RefAttributes<HTMLButtonElement>>;
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<DyslexicToggleRootProviderProps & import("react").RefAttributes<HTMLButtonElement>>;
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

useDyslexicToggle

function
DeclarationView source
useDyslexicTogglets
declare function useDyslexicToggle(input: DyslexicToggleInput, options?: UseDyslexicToggleOptions): UseDyslexicToggleResult;
Name
Kind
Type
Requirement
input
parameter
DyslexicToggleInput
required
options
parameter
UseDyslexicToggleOptions
optional
return
return value
UseDyslexicToggleResult
n/a
Name
input
Kind
parameter
Type
DyslexicToggleInput
Requirement
required
Name
options
Kind
parameter
Type
UseDyslexicToggleOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDyslexicToggleResult
Requirement
n/a

UseDyslexicToggleOptions

interface
DeclarationView source
UseDyslexicToggleOptionsts
interface UseDyslexicToggleOptions extends DyslexicToggleConnectOptions {
  readonly id?: string;
  readonly onChange?: (detail: DyslexicToggleChangeDetail) => void;
}
Name
Kind
Type
Requirement
id
property
string
optional
onChange
property
(detail: DyslexicToggleChangeDetail) => void
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
onChange
Kind
property
Type
(detail: DyslexicToggleChangeDetail) => void
Requirement
optional

UseDyslexicToggleResult

interface
DeclarationView source
UseDyslexicToggleResultts
interface UseDyslexicToggleResult {
  readonly service: DyslexicToggleService;
  readonly connector: DyslexicToggleApi;
  readonly scope: PartScope;
  readonly snapshot: DyslexicToggleSnapshot;
}
Name
Kind
Type
Requirement
connector
property
DyslexicToggleApi
required
scope
property
PartScope
required
service
property
DyslexicToggleService
required
snapshot
property
DyslexicToggleSnapshot
required
Name
connector
Kind
property
Type
DyslexicToggleApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
DyslexicToggleService
Requirement
required
Name
snapshot
Kind
property
Type
DyslexicToggleSnapshot
Requirement
required

@grassroot/ui-headless-vue/dyslexic-toggle

Vue adapter

4 exports
View source packages/ui-headless/vue/src/dyslexic-toggle/index.ts

DyslexicToggleRoot

value
DeclarationView source
DyslexicToggleRootts
export declare const DyslexicToggleRoot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  on: BooleanConstructor;
  defaultOn: BooleanConstructor;
  disabled: BooleanConstructor;
  ariaLabel: StringConstructor;
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
  change: (_detail: DyslexicToggleChangeDetail) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  on: BooleanConstructor;
  defaultOn: BooleanConstructor;
  disabled: BooleanConstructor;
  ariaLabel: StringConstructor;
}>> & Readonly<{
  onChange?: ((_detail: DyslexicToggleChangeDetail) => any) | undefined;
}>, {
  asChild: boolean;
  on: boolean;
  defaultOn: boolean;
  disabled: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

DyslexicToggleRootProvider

value
DeclarationView source
DyslexicToggleRootProviderts
export declare const DyslexicToggleRootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  on: BooleanConstructor;
  defaultOn: BooleanConstructor;
  disabled: BooleanConstructor;
  ariaLabel: StringConstructor;
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
  change: (_detail: DyslexicToggleChangeDetail) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  on: BooleanConstructor;
  defaultOn: BooleanConstructor;
  disabled: BooleanConstructor;
  ariaLabel: StringConstructor;
}>> & Readonly<{
  onChange?: ((_detail: DyslexicToggleChangeDetail) => any) | undefined;
}>, {
  asChild: boolean;
  on: boolean;
  defaultOn: boolean;
  disabled: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

useDyslexicToggle

function
DeclarationView source
useDyslexicTogglets
declare function useDyslexicToggle(input: () => DyslexicToggleInput, options?: () => DyslexicToggleOptions): UseDyslexicToggleResult;
Name
Kind
Type
Requirement
input
parameter
() => DyslexicToggleInput
required
options
parameter
() => DyslexicToggleOptions
optional
return
return value
UseDyslexicToggleResult
n/a
Name
input
Kind
parameter
Type
() => DyslexicToggleInput
Requirement
required
Name
options
Kind
parameter
Type
() => DyslexicToggleOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDyslexicToggleResult
Requirement
n/a

UseDyslexicToggleResult

interface
DeclarationView source
UseDyslexicToggleResultts
interface UseDyslexicToggleResult {
  readonly service: DyslexicToggleService;
  readonly connector: DyslexicToggleApi;
  readonly scope: PartScope;
  readonly snapshot: ShallowRef<DyslexicToggleSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
DyslexicToggleApi
required
scope
property
PartScope
required
service
property
DyslexicToggleService
required
snapshot
property
ShallowRef<DyslexicToggleSnapshot>
required
Name
connector
Kind
property
Type
DyslexicToggleApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
DyslexicToggleService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<DyslexicToggleSnapshot>
Requirement
required

@grassroot/ui-headless-angular/dyslexic-toggle

Angular adapter

5 exports
View source packages/ui-headless/angular/src/dyslexic-toggle/index.ts

createDyslexicToggleStore

function
DeclarationView source
createDyslexicToggleStorets
export declare function createDyslexicToggleStore(initial: DyslexicToggleInput, options?: CreateDyslexicToggleStoreOptions): DyslexicToggleStore;
Name
Kind
Type
Requirement
initial
parameter
DyslexicToggleInput
required
options
parameter
CreateDyslexicToggleStoreOptions
optional
return
return value
DyslexicToggleStore
n/a
Name
initial
Kind
parameter
Type
DyslexicToggleInput
Requirement
required
Name
options
Kind
parameter
Type
CreateDyslexicToggleStoreOptions
Requirement
optional
Name
return
Kind
return value
Type
DyslexicToggleStore
Requirement
n/a

CreateDyslexicToggleStoreOptions

interface
DeclarationView source
CreateDyslexicToggleStoreOptionsts
export interface CreateDyslexicToggleStoreOptions {
    readonly ariaLabel?: string;
    readonly onChange?: (detail: DyslexicToggleChangeDetail) => void;
    readonly onPersist?: (on: boolean) => void;
    readonly onApplyFont?: (on: boolean) => void;
    readonly onCommit?: () => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
onApplyFont
property
(on: boolean) => void
optional
onChange
property
(detail: DyslexicToggleChangeDetail) => void
optional
onCommit
property
() => void
optional
onPersist
property
(on: boolean) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
onApplyFont
Kind
property
Type
(on: boolean) => void
Requirement
optional
Name
onChange
Kind
property
Type
(detail: DyslexicToggleChangeDetail) => void
Requirement
optional
Name
onCommit
Kind
property
Type
() => void
Requirement
optional
Name
onPersist
Kind
property
Type
(on: boolean) => void
Requirement
optional

DyslexicToggleStore

interface
DeclarationView source
DyslexicToggleStorets
export interface DyslexicToggleStore {
    readonly service: DyslexicToggleService;
    readonly connector: DyslexicToggleApi;
    readonly scope: PartScope;
    readonly version: WritableSignal<number>;
    start(): void;
    stop(): void;
    sync(input: DyslexicToggleInput): void;
}
Name
Kind
Type
Requirement
connector
property
DyslexicToggleApi
required
scope
property
PartScope
required
service
property
DyslexicToggleService
required
start
method
() => void
required
stop
method
() => void
required
sync
method
(input: DyslexicToggleInput) => void
required
version
property
WritableSignal<number>
required
Name
connector
Kind
property
Type
DyslexicToggleApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
DyslexicToggleService
Requirement
required
Name
start
Kind
method
Type
() => void
Requirement
required
Name
stop
Kind
method
Type
() => void
Requirement
required
Name
sync
Kind
method
Type
(input: DyslexicToggleInput) => void
Requirement
required
Name
version
Kind
property
Type
WritableSignal<number>
Requirement
required

GrDyslexicToggleRoot

class
DeclarationView source
GrDyslexicToggleRootts
export declare class GrDyslexicToggleRoot implements OnDestroy {
    readonly on: import("@angular/core").InputSignal<boolean | undefined>;
    readonly defaultOn: import("@angular/core").InputSignal<boolean | undefined>;
    readonly disabled: import("@angular/core").InputSignal<boolean | undefined>;
    readonly ariaLabel: import("@angular/core").InputSignal<string | undefined>;
    readonly change: import("@angular/core").OutputEmitterRef<DyslexicToggleChangeDetail>;
    readonly store: DyslexicToggleStore;
    private readonly host;
    private readonly listeners;
    private last;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrDyslexicToggleRoot, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<GrDyslexicToggleRoot, "gr-dyslexic-toggle-root", never, { "on": { "alias": "on"; "required": false; "isSignal": true; }; "defaultOn": { "alias": "defaultOn"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "change": "change"; }, never, ["*"], true, never>;
}
Name
Kind
Type
Requirement
ariaLabel
property
import("@angular/core").InputSignal<string | undefined>
required
change
property
import("@angular/core").OutputEmitterRef<DyslexicToggleChangeDetail>
required
defaultOn
property
import("@angular/core").InputSignal<boolean | undefined>
required
disabled
property
import("@angular/core").InputSignal<boolean | undefined>
required
host
property
any
required
last
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
on
property
import("@angular/core").InputSignal<boolean | undefined>
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrDyslexicToggleRoot, "gr-dyslexic-toggle-root", never, { "on": { "alias": "on"; "required": false; "isSignal": true; }; "defaultOn": { "alias": "defaultOn"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "change": "change"; }, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDyslexicToggleRoot, never>
required
store
property
DyslexicToggleStore
required
Name
ariaLabel
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
change
Kind
property
Type
import("@angular/core").OutputEmitterRef<DyslexicToggleChangeDetail>
Requirement
required
Name
defaultOn
Kind
property
Type
import("@angular/core").InputSignal<boolean | undefined>
Requirement
required
Name
disabled
Kind
property
Type
import("@angular/core").InputSignal<boolean | undefined>
Requirement
required
Name
host
Kind
property
Type
any
Requirement
required
Name
last
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
on
Kind
property
Type
import("@angular/core").InputSignal<boolean | undefined>
Requirement
required
Name
ɵcmp
Kind
property
Type
i0.ɵɵComponentDeclaration<GrDyslexicToggleRoot, "gr-dyslexic-toggle-root", never, { "on": { "alias": "on"; "required": false; "isSignal": true; }; "defaultOn": { "alias": "defaultOn"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "change": "change"; }, never, ["*"], true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDyslexicToggleRoot, never>
Requirement
required
Name
store
Kind
property
Type
DyslexicToggleStore
Requirement
required

GrDyslexicToggleRootProvider

class
DeclarationView source
GrDyslexicToggleRootProviderts
export declare class GrDyslexicToggleRootProvider implements OnDestroy {
    private readonly store;
    private readonly host;
    private readonly listeners;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrDyslexicToggleRootProvider, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<GrDyslexicToggleRootProvider, "gr-dyslexic-toggle-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<GrDyslexicToggleRootProvider, "gr-dyslexic-toggle-root-provider", never, {}, {}, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDyslexicToggleRootProvider, 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<GrDyslexicToggleRootProvider, "gr-dyslexic-toggle-root-provider", never, {}, {}, never, ["*"], true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDyslexicToggleRootProvider, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

@grassroot/ui-headless-svelte/dyslexic-toggle

Svelte adapter

5 exports
View source packages/ui-headless/svelte/src/dyslexic-toggle/index.ts

createDyslexicToggle

function
DeclarationView source
createDyslexicTogglets
export declare function createDyslexicToggle(input: () => DyslexicToggleInput, options?: UseDyslexicToggleOptions): UseDyslexicToggleResult;
Name
Kind
Type
Requirement
input
parameter
() => DyslexicToggleInput
required
options
parameter
UseDyslexicToggleOptions
optional
return
return value
UseDyslexicToggleResult
n/a
Name
input
Kind
parameter
Type
() => DyslexicToggleInput
Requirement
required
Name
options
Kind
parameter
Type
UseDyslexicToggleOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDyslexicToggleResult
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

UseDyslexicToggleOptions

interface
DeclarationView source
UseDyslexicToggleOptionsts
export interface UseDyslexicToggleOptions {
    readonly id?: string;
    readonly ariaLabel?: string;
    readonly onChange?: (detail: import("@grassroot/ui-headless-core/dyslexic-toggle").DyslexicToggleChangeDetail) => void;
    readonly onPersist?: (on: boolean) => void;
    readonly onApplyFont?: (on: boolean) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
id
property
string
optional
onApplyFont
property
(on: boolean) => void
optional
onChange
property
(detail: import("@grassroot/ui-headless-core/dyslexic-toggle").DyslexicToggleChangeDetail) => void
optional
onPersist
property
(on: boolean) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
onApplyFont
Kind
property
Type
(on: boolean) => void
Requirement
optional
Name
onChange
Kind
property
Type
(detail: import("@grassroot/ui-headless-core/dyslexic-toggle").DyslexicToggleChangeDetail) => void
Requirement
optional
Name
onPersist
Kind
property
Type
(on: boolean) => void
Requirement
optional

UseDyslexicToggleResult

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

@grassroot/ui-headless-solid/dyslexic-toggle

Solid adapter

7 exports
View source packages/ui-headless/solid/src/dyslexic-toggle/index.ts

DyslexicToggleRootProps

interface
DeclarationView source
DyslexicToggleRootPropsts
export interface DyslexicToggleRootProps extends Omit<JSX.ButtonHTMLAttributes<HTMLButtonElement>, "disabled" | "onChange">, DyslexicToggleInput {
    readonly ariaLabel?: string;
    readonly id?: string;
    readonly onChange?: (detail: DyslexicToggleChangeDetail) => void;
    readonly onPersist?: (on: boolean) => void;
    readonly onApplyFont?: (on: boolean) => void;
    readonly children?: JSX.Element;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
children
property
JSX.Element
optional
id
property
string
optional
onApplyFont
property
(on: boolean) => void
optional
onChange
property
(detail: DyslexicToggleChangeDetail) => void
optional
onPersist
property
(on: boolean) => 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
onApplyFont
Kind
property
Type
(on: boolean) => void
Requirement
optional
Name
onChange
Kind
property
Type
(detail: DyslexicToggleChangeDetail) => void
Requirement
optional
Name
onPersist
Kind
property
Type
(on: boolean) => void
Requirement
optional

DyslexicToggleRootProviderProps

interface
DeclarationView source
DyslexicToggleRootProviderPropsts
export interface DyslexicToggleRootProviderProps extends Omit<JSX.ButtonHTMLAttributes<HTMLButtonElement>, "disabled" | "onChange" | "value"> {
    readonly value: UseDyslexicToggleResult;
    readonly children?: JSX.Element;
}
Name
Kind
Type
Requirement
children
property
JSX.Element
optional
value
property
UseDyslexicToggleResult
required
Name
children
Kind
property
Type
JSX.Element
Requirement
optional
Name
value
Kind
property
Type
UseDyslexicToggleResult
Requirement
required

Root

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

RootProvider

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

useDyslexicToggle

function
DeclarationView source
useDyslexicTogglets
export declare function useDyslexicToggle(input: Accessor<DyslexicToggleInput>, options?: UseDyslexicToggleOptions): UseDyslexicToggleResult;
Name
Kind
Type
Requirement
input
parameter
Accessor<DyslexicToggleInput>
required
options
parameter
UseDyslexicToggleOptions
optional
return
return value
UseDyslexicToggleResult
n/a
Name
input
Kind
parameter
Type
Accessor<DyslexicToggleInput>
Requirement
required
Name
options
Kind
parameter
Type
UseDyslexicToggleOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDyslexicToggleResult
Requirement
n/a

UseDyslexicToggleOptions

interface
DeclarationView source
UseDyslexicToggleOptionsts
export interface UseDyslexicToggleOptions {
    readonly id?: string;
    readonly ariaLabel?: string;
    readonly onChange?: (detail: DyslexicToggleChangeDetail) => void;
    readonly onPersist?: (on: boolean) => void;
    readonly onApplyFont?: (on: boolean) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
id
property
string
optional
onApplyFont
property
(on: boolean) => void
optional
onChange
property
(detail: DyslexicToggleChangeDetail) => void
optional
onPersist
property
(on: boolean) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
onApplyFont
Kind
property
Type
(on: boolean) => void
Requirement
optional
Name
onChange
Kind
property
Type
(detail: DyslexicToggleChangeDetail) => void
Requirement
optional
Name
onPersist
Kind
property
Type
(on: boolean) => void
Requirement
optional

UseDyslexicToggleResult

interface
DeclarationView source
UseDyslexicToggleResultts
export interface UseDyslexicToggleResult {
    readonly service: DyslexicToggleService;
    readonly connector: DyslexicToggleApi;
    readonly scope: ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>;
    readonly snapshot: Accessor<DyslexicToggleSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
DyslexicToggleApi
required
scope
property
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>
required
service
property
DyslexicToggleService
required
snapshot
property
Accessor<DyslexicToggleSnapshot>
required
Name
connector
Kind
property
Type
DyslexicToggleApi
Requirement
required
Name
scope
Kind
property
Type
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>
Requirement
required
Name
service
Kind
property
Type
DyslexicToggleService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<DyslexicToggleSnapshot>
Requirement
required