@manifest-editor/client-vault
v2.3.0
Published
<p align="center"> <a href="https://github.com/digirati-co-uk/iiif-manifest-editor"><img src="https://raw.githubusercontent.com/digirati-co-uk/iiif-manifest-editor/main/apps/docs/content/img/logo.svg" width="360" alt="Manifest Editor"></a> </p> <p align
Downloads
1,390
Readme
@manifest-editor/client-vault
Getting started with Manifest Editor
For the complete editor, start with manifest-editor and its installation and integration guide. It combines the editor UI, presets, creators, and editing APIs. This package is one part of that workspace.
About
Client-side Vault adapters for synchronising IIIF state over WebSockets or a MessagePort. Intended for host integrations and live previews.
Quick start
npm install @manifest-editor/client-vaultimport { createClientVault } from "@manifest-editor/client-vault";
const vault = await createClientVault("ws://localhost:8081/vault/demo");
console.log(vault.getState());Start a compatible server first (see @manifest-editor/server-vault). A MessagePort connection requires a host bridge; it is not a WebSocket URL.
API overview
createClientVault(url, options?): connects and waits for initial state.ClientVault: WebSocket-backed Vault implementation.MessagePortClientVault: MessagePort-backed implementation for embedded previews.- Protocol types for messages and remote Vault actions.
See the source exports for the complete API and TypeScript definitions.
