collaborative-editor
v2.8.0
Published
JSON CRDT str node bindings to any generic plain text editor.
Downloads
208
Maintainers
Readme
Collaborative plain text editor binding
This package provides binding for a generic text editor to a JSON CRDT str
node.
Usage
Installation:
npm install json-joy collaborative-editor
Simple integration for any plain text editor, for the most basic integration
you only need to implement the .get()
and .set()
methods:
import {StrBinding, EditorFacade} from 'collaborative-editor';
import {Model} from 'json-joy/lib/json-crdt';
const str = model.api.str(['path', 'to', 'string']);
const unbind = StrBinding.bind(str, {
get: () => input.value,
set: (value: string) => input.value = value,
}, true);
For a better integration, implement as many EditorFacade
methods as possible:
import {StrBinding, EditorFacade} from 'collaborative-editor';
const editor: EditorFacade = {
// ...
};
const str = model.api.str(['path', 'to', 'string']);
const binding = new StrBinding(str, editor);
binding.syncFromModel();
binding.bind(polling);
// When done, unbind the binding.
binding.unbind();
Preview
- See demo.