1.3.0 • Published 9 months ago

collaborative-quill v1.3.0

Weekly downloads
-
License
-
Repository
github
Last release
9 months ago

Quill editor collaborative editing binding

Makes a rich-text Quill editor instance collaborative by binding it to a JSON CRDT document using the quill extension. This allows multiple users to edit the same document json-joy JSON CRDT document concurrently through the Quill editor.

Usage

Installation:

npm install json-joy quill quill-delta collaborative-quill

Usage:

import {bind} from 'collaborative-quill';
import {Model} from 'json-joy/lib/json-crdt';

// ...

const unbind = bind(str, editor);

// When done, unbind the binding.
binding.unbind();

React Usage

Installation:

npm install json-joy quill quill-delta collaborative-quill react react-dom

Usage:

import {ModelWithExt, ext} from 'json-joy/lib/json-crdt-extensions';
import {CollaborativeQuill} from 'collaborative-quill/lib/CollaborativeQuill';

const model = ModelWithExt.create(ext.quill.new('abc'));

const MyComponent = () => {
  return <CollaborativeQuill api={model.s.toExt()} />
};

Preview