mobx-bonsai
    Preparing search index...

    Class UndoManager<TAttachedState>

    Manages undo/redo functionality for a mobx-bonsai node tree. Automatically groups changes that occur within a single MobX action.

    Type Parameters

    • TAttachedState = unknown
    Index

    Constructors

    Properties

    clearRedo: () => void = ...

    Clears the redo queue.

    clearUndo: () => void = ...

    Clears the undo queue.

    rootNode: object

    The root node being tracked.

    store: UndoStore

    The UndoStore holding the undo/redo queues.

    Accessors

    • get canRedo(): boolean

      Whether redo is possible.

      Returns boolean

    • get canUndo(): boolean

      Whether undo is possible.

      Returns boolean

    • get isUndoRecordingDisabled(): boolean

      Whether undo recording is currently disabled.

      Returns boolean

    • get maxRedoLevels(): number

      Maximum number of redo levels to keep.

      Returns number

    • get maxUndoLevels(): number

      Maximum number of undo levels to keep.

      Returns number

    • get redoLevels(): number

      Number of redo steps available.

      Returns number

    • get undoLevels(): number

      Number of undo steps available.

      Returns number

    Methods

    • Disposes the undo manager, stopping change tracking.

      Returns void

    • Redoes the last undone change.

      Returns void

      if called while inside a MobX action

      if there are no redo events

    • Undoes the last change.

      Returns void

      if called while inside a MobX action

      if there are no undo events

    • Executes a function without recording changes.

      Type Parameters

      • T

      Parameters

      • fn: () => T

      Returns T