Vizel API / react/src / useVizelVersionHistory

Function: useVizelVersionHistory()

function useVizelVersionHistory(editor, options?): UseVizelVersionHistoryResult;

Defined in: packages/react/src/hooks/useVizelVersionHistory.ts:66

Hook for managing document version history.

Parameters

Parameter	Type	Description
editor	Editor | null | undefined	The editor instance (or null while it is still initializing)
options	VizelVersionHistoryOptions	Version history configuration options

Returns

UseVizelVersionHistoryResult

Version history state and controls

Example

function Editor() {
  const editor = useVizelEditor({ ... });
  const { snapshots, saveVersion, restoreVersion } = useVizelVersionHistory(
    editor,
    { maxVersions: 20, key: 'my-doc-versions' }
  );

  return (
    <div>
      <VizelEditor editor={editor} />
      <button onClick={() => saveVersion("Manual save")}>Save Version</button>
      <ul>
        {snapshots.map(s => (
          <li key={s.id}>
            {s.description} - {new Date(s.timestamp).toLocaleString()}
            <button onClick={() => restoreVersion(s.id)}>Restore</button>
          </li>
        ))}
      </ul>
    </div>
  );
}