JSPM

collaborative-quill

1.3.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 88
  • Score
    100M100P100Q65458F

Binding for collaborative editing support in Quill rich-text editor.

Package Exports

  • collaborative-quill
  • collaborative-quill/lib/CollaborativeQuill
  • collaborative-quill/lib/CollaborativeQuill/index.js
  • collaborative-quill/lib/index.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-quill) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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