grassroot
Install

DocsAPI referenceUI machinesdiff-viewer

diff-viewer machine

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

@grassroot/ui-machines/diff-viewer

Package

11 exports
View source packages/ui-machines/src/diff-viewer/index.ts

Service example

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

Exports

DiffViewerCommand

type
DeclarationView source
DiffViewerCommandts
type DiffViewerCommand = CommandObject & {
  readonly type: "MODE_CHANGE_REQUEST";
  readonly mode: DiffViewerMode;
  readonly reason: DiffViewerReason;
};
Name
Kind
Type
Requirement
mode
property
DiffViewerMode
required
reason
property
DiffViewerReason
required
type
property
string
required
Name
mode
Kind
property
Type
DiffViewerMode
Requirement
required
Name
reason
Kind
property
Type
DiffViewerReason
Requirement
required
Name
type
Kind
property
Type
string
Requirement
required

DiffViewerContext

type
DeclarationView source
DiffViewerContextts
type DiffViewerContext = {
  readonly mode: BindingMode;
  readonly view: DiffViewerMode;
};
Name
Kind
Type
Requirement
mode
property
BindingMode
required
view
property
DiffViewerMode
required
Name
mode
Kind
property
Type
BindingMode
Requirement
required
Name
view
Kind
property
Type
DiffViewerMode
Requirement
required

DiffViewerDiagnosticCodes

value
DeclarationView source
DiffViewerDiagnosticCodests
export declare const DiffViewerDiagnosticCodes: readonly DiagnosticCatalogueEntry[];

DiffViewerEvent

type
DeclarationView source
DiffViewerEventts
type DiffViewerEvent = {
  readonly type: "SET";
  readonly mode: DiffViewerMode;
  readonly reason: DiffViewerReason;
} | {
  readonly type: "TOGGLE";
  readonly reason: DiffViewerReason;
} | {
  readonly type: "RESET";
};

DiffViewerInput

type
DeclarationView source
DiffViewerInputts
type DiffViewerInput = {
  readonly mode?: DiffViewerMode;
  readonly defaultMode?: DiffViewerMode;
  readonly disabled?: boolean;
};
Name
Kind
Type
Requirement
defaultMode
property
DiffViewerMode
optional
disabled
property
boolean
optional
mode
property
DiffViewerMode
optional
Name
defaultMode
Kind
property
Type
DiffViewerMode
Requirement
optional
Name
disabled
Kind
property
Type
boolean
Requirement
optional
Name
mode
Kind
property
Type
DiffViewerMode
Requirement
optional

diffViewerMachine

value
DeclarationView source
diffViewerMachinets
export declare const diffViewerMachine: Machine<DiffViewerInput, "ready", DiffViewerContext, DiffViewerEvent, DiffViewerCommand>;

DiffViewerMode

type
DeclarationView source
DiffViewerModets
type DiffViewerMode = "unified" | "split";

DiffViewerReason

type
DeclarationView source
DiffViewerReasonts
type DiffViewerReason = "pointer" | "keyboard" | "programmatic";

diffViewerReplaySequence

value
DeclarationView source
diffViewerReplaySequencets
export declare const diffViewerReplaySequence: readonly DiffViewerEvent[];

diffViewerSelectors

value
DeclarationView source
diffViewerSelectorsts
export declare const diffViewerSelectors: {
  mode: (snapshot: DiffViewerSnapshot) => DiffViewerMode;
};
Name
Kind
Type
Requirement
mode
property
(snapshot: DiffViewerSnapshot) => DiffViewerMode
required
Name
mode
Kind
property
Type
(snapshot: DiffViewerSnapshot) => DiffViewerMode
Requirement
required

DiffViewerSnapshot

type
DeclarationView source
DiffViewerSnapshotts
type DiffViewerSnapshot = Snapshot<"ready", DiffViewerContext>;