https://github.com/cofficlab/juiceeditor
A rich text editor
https://github.com/cofficlab/juiceeditor
editor rich-text-editor
Last synced: about 1 year ago
JSON representation
A rich text editor
- Host: GitHub
- URL: https://github.com/cofficlab/juiceeditor
- Owner: CofficLab
- License: mit
- Created: 2023-11-08T10:27:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T04:26:51.000Z (over 1 year ago)
- Last Synced: 2024-10-30T04:58:11.772Z (over 1 year ago)
- Topics: editor, rich-text-editor
- Language: TypeScript
- Homepage: https://cofficlab.github.io/en/juiceEditor/
- Size: 81.8 MB
- Stars: 5
- Watchers: 0
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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
### JavaScript/TypeScript
1. Install JuiceEditor
```bash
npm install @coffic/juice-editor
```
2. Use JuiceEditor in your project
```js
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
```html
```
### Swift Package
## Documentation
## Playground
## Related Projects
- [JuiceEditorKit](https://github.com/CofficLab/JuiceEditorKit)
- [JuiceEditor-Playground](https://github.com/cofficlab/JuiceEditor-Playground)
- [JuiceEditor-Examples](https://github.com/cofficlab/JuiceEditor-Examples)
## Products based on JuiceEditor
- [KuaiYiZhi APP](https://apps.apple.com/cn/app/%E5%BF%AB%E6%98%93%E7%9F%A5/id6457892799)
- [KuaiYiZhi](https://www.kuaiyizhi.cn)
## Built based on the following projects
- [Draw.io](https://github.com/jgraph/drawio)
- [TailwindCSS](https://tailwindcss.com/)
- [Vue3](https://v3.vuejs.org/)
- [Tiptap](https://tiptap.dev/)
- [Heroicons](https://heroicons.com)
- [RemixIcon](https://remixicon.com)
## NPM Packages
- [juice-editor](https://www.npmjs.com/package/@coffic/juice-editor)
- [juice-editor-draw](https://www.npmjs.com/package/@coffic/juice-editor-draw)
## Maintainer
Work for Joy & Live for Love ➡️
## 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](LICENSE)
2. For commercial use or modifications: Please [contact the author](https://github.com/nookery) 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.