Vizel API / react/src / useVizelAutoSave

Function: useVizelAutoSave()

function useVizelAutoSave(editor, options?): UseVizelAutoSaveResult;

Defined in: packages/react/src/hooks/useVizelAutoSave.ts:56

Hook for auto-saving editor content with debouncing.

Parameters

Parameter	Type	Description
editor	Editor | null | undefined	The editor instance (or null while it is still initializing)
options	VizelAutoSaveOptions	Auto-save configuration options

Returns

UseVizelAutoSaveResult

Auto-save state and controls

Example

function Editor() {
  const editor = useVizelEditor({ ... });
  const { status, lastSaved, save } = useVizelAutoSave(editor, {
    debounceMs: 2000,
    storage: 'localStorage',
    key: 'my-document',
  });

  return (
    <div>
      <VizelEditor editor={editor} />
      <VizelSaveIndicator status={status} lastSaved={lastSaved} />
    </div>
  );
}