Skip to content

Vizel API / svelte/src / createVizelAutoSave

Function: createVizelAutoSave()

ts
function createVizelAutoSave(getEditor, options?): CreateVizelAutoSaveResult;

Defined in: packages/svelte/src/runes/createVizelAutoSave.svelte.ts:53

Svelte 5 rune for auto-saving editor content with debouncing.

Parameters

ParameterTypeDescription
getEditor() => Editor | null | undefinedFunction that returns the editor instance
optionsVizelAutoSaveOptionsAuto-save configuration options

Returns

CreateVizelAutoSaveResult

Auto-save state and controls

Example

svelte
<script lang="ts">
import { createVizelEditor, createVizelAutoSave, VizelEditor, VizelSaveIndicator } from '@vizel/svelte';

const editor = createVizelEditor({ ... });
const autoSave = createVizelAutoSave(() => editor.current, {
  debounceMs: 2000,
  storage: 'localStorage',
  key: 'my-document',
});
</script>

<VizelEditor editor={editor.current} />
<VizelSaveIndicator status={autoSave.status} lastSaved={autoSave.lastSaved} />

Released under the MIT License.