Vizel API / vue/src / useVizelVersionHistory

Function: useVizelVersionHistory()

function useVizelVersionHistory(getEditor, options?): UseVizelVersionHistoryResult;

Defined in: packages/vue/src/composables/useVizelVersionHistory.ts:53

Composable for managing document version history.

Parameters

Parameter	Type	Description
getEditor	() => Editor | null | undefined	Function that returns the editor instance
options	VizelVersionHistoryOptions	Version history configuration options

Returns

UseVizelVersionHistoryResult

Version history state and controls

Example

<script setup lang="ts">
import { useVizelEditor, useVizelVersionHistory } from '@vizel/vue';

const editor = useVizelEditor({ ... });
const { snapshots, saveVersion, restoreVersion } = useVizelVersionHistory(
  () => editor.value,
  { maxVersions: 20 }
);
</script>