grassroot
Install

DocsAPI referenceUI machinesdyslexic-toggle

dyslexic-toggle machine

The public state machine contract for @grassroot/ui-machines/dyslexic-toggle. The machine owns behaviour; the matching headless layer owns composition.

@grassroot/ui-machines/dyslexic-toggle

Package

10 exports
View source packages/ui-machines/src/dyslexic-toggle/index.ts

Service example

dyslexic-toggle.tsts
import { createService } from "@grassroot/statechart";
import { dyslexicToggleMachine } from "@grassroot/ui-machines/dyslexic-toggle";
 
const service = createService(dyslexicToggleMachine, { input: {} });
service.start();
service.send({ type: "…" });
service.stop();

Exports

DyslexicToggleCommand

type
DeclarationView source
DyslexicToggleCommandts
type DyslexicToggleCommand = CommandObject & ({
  readonly type: "ON_CHANGE_REQUEST";
  readonly on: boolean;
  readonly reason: DyslexicToggleReason;
} | {
  readonly type: "PERSIST";
  readonly on: boolean;
  readonly reason: DyslexicToggleReason;
} | {
  readonly type: "APPLY_FONT";
  readonly on: boolean;
  readonly reason: DyslexicToggleReason;
});

DyslexicToggleContext

type
DeclarationView source
DyslexicToggleContextts
type DyslexicToggleContext = {
  readonly mode: BindingMode;
  readonly on: boolean;
};
Name
Kind
Type
Requirement
mode
property
BindingMode
required
on
property
boolean
required
Name
mode
Kind
property
Type
BindingMode
Requirement
required
Name
on
Kind
property
Type
boolean
Requirement
required

DyslexicToggleDiagnosticCodes

value
DeclarationView source
DyslexicToggleDiagnosticCodests
export declare const DyslexicToggleDiagnosticCodes: readonly DiagnosticCatalogueEntry[];

DyslexicToggleEvent

type
DeclarationView source
DyslexicToggleEventts
type DyslexicToggleEvent = {
  readonly type: "TOGGLE";
  readonly reason: DyslexicToggleReason;
} | {
  readonly type: "RESET";
};

DyslexicToggleInput

type
DeclarationView source
DyslexicToggleInputts
type DyslexicToggleInput = {
  readonly on?: boolean;
  readonly defaultOn?: boolean;
  readonly disabled?: boolean;
};
Name
Kind
Type
Requirement
defaultOn
property
boolean
optional
disabled
property
boolean
optional
on
property
boolean
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

dyslexicToggleMachine

value
DeclarationView source
dyslexicToggleMachinets
export declare const dyslexicToggleMachine: Machine<DyslexicToggleInput, "ready", DyslexicToggleContext, DyslexicToggleEvent, DyslexicToggleCommand>;

DyslexicToggleReason

type
DeclarationView source
DyslexicToggleReasonts
type DyslexicToggleReason = "pointer" | "keyboard" | "programmatic";

dyslexicToggleReplaySequence

value
DeclarationView source
dyslexicToggleReplaySequencets
export declare const dyslexicToggleReplaySequence: readonly DyslexicToggleEvent[];

dyslexicToggleSelectors

value
DeclarationView source
dyslexicToggleSelectorsts
export declare const dyslexicToggleSelectors: {
  on: (snapshot: DyslexicToggleSnapshot) => boolean;
};
Name
Kind
Type
Requirement
on
property
(snapshot: DyslexicToggleSnapshot) => boolean
required
Name
on
Kind
property
Type
(snapshot: DyslexicToggleSnapshot) => boolean
Requirement
required

DyslexicToggleSnapshot

type
DeclarationView source
DyslexicToggleSnapshotts
type DyslexicToggleSnapshot = Snapshot<"ready", DyslexicToggleContext>;