API for rete-history-plugin package

HistoryExtensions

extensions/index.ts

History plugin extensions

keyboard

extensions/keyboard.ts

Adds keyboard shortcuts for history undo/redo

keyboard(plugin: HistoryPlugin<Schemes, A>): void

Returns void

Presets

presets/index.ts

Presets for the history plugin

classic

presets/classic/index.ts

setup

presets/classic/index.ts

Classic preset for the history plugin. Tracks node adding/removing/translating, connection adding/removing.

setup(props: { timing: number }): Preset<S, HistoryActions<S>>

Returns Preset<S, HistoryActions<S>>

HistoryPlugin

index.ts

History plugin. Allows to undo/redo actions such as adding/removing nodes, connections, etc.

class HistoryPlugin<Schemes extends BaseSchemes, A extends HistoryAction>

Extends Scope<never, BaseArea, Root>

constructor

index.ts

constructor(props: { timing: number }): HistoryPlugin<Schemes, A>

Returns HistoryPlugin<Schemes, A>

add

index.ts

Adds an action to the history

add(action: A): void

Returns void

addPreset

index.ts

Adds a preset to the history plugin

addPreset(preset: Preset<Schemes, T>): void

Returns void

clear

index.ts

Clear history

clear(): void

Returns void

getHistorySnapshot

index.ts

Get produced history records

getHistorySnapshot(): HistoryRecord<A>[]

Returns HistoryRecord<A>[] History snapshot

getRecent

index.ts

Get recent history records produced in the last ms milliseconds

getRecent(ms: number): HistoryRecord<A>[]

Returns HistoryRecord<A>[] History records produced in the last

redo

index.ts

Asynchronously redoes an actions until the separated flag is encountered or the time between the current and previous action exceeds timing property which is 200ms by default

redo(): Promise<void>

Returns Promise<void>

separate

index.ts

separate(): void

Returns void

undo

index.ts

Asynchronously undoes an actions until the separated flag is encountered or the time between the current and previous action exceeds timing property which is 200ms by default

undo(): Promise<void>

Returns Promise<void>

HistoryAction

types.ts

Base interface for all actions

Examples

export class CustomAction<S extends BaseSchemes> implements HistoryAction {
 async undo() {
   // undo logic
 }
 async redo() {
   // redo logic
 }
}