pixi-silk/history

History (undo and redo), recordSignals, recordGizmo, bindHistoryKeys.

import { History, bindHistoryKeys, recordGizmo, recordSignals } from 'pixi-silk/history';

Classes#

Class	Description
History	The default undo stack: steps in memory, transactions, merging and a depth limit.

Interface	Description
Command	One undoable change.
HistoryKeysOptions	Options of bindHistoryKeys.
HistoryLike	What undoable widgets need from a history. Implement it to plug in your own store: `record` gets changes that are already applied, `begin` and `end` bracket a gesture such as a drag.
HistoryOptions	Options of History.
HistoryState	The signals of a History.
HistoryStep	One entry of the stack: a label and the commands it undoes together.
RecordableGizmo	What recordGizmo needs from a gizmo, such as `TransformGizmo`.
RecordGizmoOptions	Options of recordGizmo.
RecordSignalsOptions	Options of recordSignals.
SignalRecorder	What recordSignals returns.
TransformSnapshot	Position, rotation and scale, the way a transform gizmo reads them.
TransformTarget	Something with a position, rotation and scale, such as a Pixi `Container`.

Function	Description
bindHistoryKeys	Binds cmd or ctrl + Z to undo, and shift + cmd or ctrl + Z and ctrl + Y to redo. Keys typed into inputs, text areas and editable elements are left alone. Returns the unbind function.
recordGizmo	Records every drag of a transform gizmo as one undoable step. The gizmo knows nothing about history: this watches its `dragging` signal. Returns the function that stops recording.
recordSignals	Records every change of `signals` into `history`, so undo works without writing commands. Changes made in the same synchronous run (one handler, one `batch`) become one step. Inside a transaction everything merges into the transaction’s step.