Package Exports

collaborative-editor
collaborative-editor/lib/index.js
collaborative-editor/lib/replicated-str/ReplicatedStr
collaborative-editor/lib/replicated-str/ReplicatedStr.js
collaborative-editor/lib/replicated-str/StoreStrFacade
collaborative-editor/lib/replicated-str/StoreStrFacade.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (collaborative-editor) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Collaborative plain text editor binding

This package provides binding for a generic text editor to a JSON CRDT str node.

collaborative-editor

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.