@coffic/juice-editor

JuiceEditor

A powerful rich text editor which name comes from a Chinese word "聚思" (gather your thoughts).

Currently still under development and not yet stable.

Quick Start

1.Install JuiceEditor

npm install @coffic/juice-editor

2.Use JuiceEditor in your project

import { EditorFactory, Editor } from '@coffic/juice-editor'

const editor = EditorFactory.register('my-editor', {
    onBeforeCreate: () => {
        console.log('onBeforeCreate for label my-editor')
    },
    onCreate: (editor: Editor) => {
        console.log('onCreate for label my-editor')

        editor.enableLog()
    }
})

// When you type 'editor.', the IDE will suggest available APIs

3.Use in your template

<my-editor></my-editor>

Documentation

https://cofficlab.github.io/en/juiceEditor/

Playground

https://cofficlab.github.io/JuiceEditor-Playground/

Related Projects

• JuiceEditor-SwiftUI
• JuiceEditor-Playground
• JuiceEditor-Examples

Products based on JuiceEditor

• KuaiYiZhi APP
• KuaiYiZhi

Built based on the following projects

• Draw.io
• TailwindCSS
• Vue3
• Tiptap
• Heroicons
• RemixIcon

NPM Packages

• juice-editor
• juice-editor-draw

Maintainer

Work for Joy & Live for Love ➡️ https://github.com/nookery

Contributing

Show your ❤️ by ⭐️ing this repository! It means a lot.

Clone the repo, do something, make a PR.

Looking forward to your PRs, you amazing ideas.

License

JuiceEditor is released under a dual license:

1. For non-commercial use: MIT License
2. For commercial use or modifications: Please contact the author for a commercial license.

Any use of this software for commercial purposes or any modifications to the source code require explicit permission from the author.