share / share/sharedb

Is it possible to use just Quill deltas without Quill in ShareDB?

Open
#559 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
6.5k
Forks
456
Avg merge
1d 5h
Merged PRs (30d)
5

Description

The documentation for the rich text type indicates that it is based on quilljs deltas.

However, the example in shareDB uses the Quill editor entirely, and I haven't found any examples online that don't.

I see that Quilljs is an editor with some quirks that I don't like:

  • looks like a somewhat abandoned project.
  • would add a lot of things to my project that I don't need or won't use
  • I prefer not to depend on a library for my editor if possible.

I would like to know if I can create my custom editor with content-editable and connect ShareDB to it using only quill deltas instead of requiring the full quill editor. If possible, would you recommend doing it? Or will I find myself with a headache trying to solve difficulties that Quilljs has already solved?

On the other hand, if it is not possible to use rich-text type without QuillJs, then I wonder what is the advantage of using rich-text type, since from what I see when connecting quilljs to a WebSocket the RTC already works fine without needing ShareDB. Maybe I'm not understanding well.

related reading
https://github.com/quilljs/quill/issues/993

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the rich-text documentation and the ShareDB Quill example, then compare the documented Delta interface with the integration points exposed to editors. A useful outcome would be a supported usage path or clear documentation explaining whether a custom contenteditable editor can use rich-text without Quill.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.