An open API service indexing awesome lists of open source software.

https://github.com/ckeditor/ckeditor5-collaboration-samples

Collaboration integration examples for CKEditor 5
https://github.com/ckeditor/ckeditor5-collaboration-samples

Last synced: 12 months ago
JSON representation

Collaboration integration examples for CKEditor 5

Awesome Lists containing this project

README

          

# A collection of collaboration features samples for CKEditor 5

This repository contains code samples and example integrations of [CKEditor 5 collaboration features](https://ckeditor.com/collaboration/) for "vanilla JS" applications and JavaScript frameworks.

## Contents

### Vanilla JS samples

* `/real-time-collaboration-editor-classic` – A sample of the CKEditor 5 [classic editor](https://github.com/ckeditor/ckeditor5-editor-classic) with [real-time-collaboration features](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/real-time-collaboration/real-time-collaboration.html) and [revision history](https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html).

* `/real-time-collaboration-editor-document` – A document-styled sample of the CKEditor 5 [decoupled editor](https://github.com/ckeditor/ckeditor5-editor-decoupled) with [real-time-collaboration features](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/real-time-collaboration/real-time-collaboration.html) and [revision history](https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html).

* `/real-time-collaboration-editor-multi-root` – A sample of the CKEditor 5 [multi-root editor](https://ckeditor.com/docs/ckeditor5/latest/examples/framework/multi-root-editor.html) with [real-time-collaboration features](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/real-time-collaboration/real-time-collaboration.html) and [revision history](https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html).

* `/real-time-collaboration-comments-outside-of-editor` – A sample integration of [comments outside of editor](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/comments/comments-outside-editor.html) and [real-time collaboration features](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/real-time-collaboration/real-time-collaboration.html).

* `/real-time-collaboration-with-context` – A sample integration of [context](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/context-and-collaboration-features.html) and [real-time collaboration features](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/real-time-collaboration/real-time-collaboration.html).

* `/collaboration-editor-classic` – A sample of the CKEditor 5 [classic editor](https://github.com/ckeditor/ckeditor5-editor-classic) with offline [track changes](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/track-changes/track-changes.html), [comments](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/comments/comments.html) and [revision history](https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html).

* `/collaboration-comments-outside-of-editor` – A sample integration of [comments outside of editor](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/comments/comments-outside-editor.html) with offline [track changes](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/track-changes/track-changes.html) and [comments](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/comments/comments.html).

### Framework integration samples

* `/real-time-collaboration-for-angular` – A sample integration of the CKEditor 5 WYSIWYG editor with [real-time-collaboration features](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/real-time-collaboration/real-time-collaboration.html) and [revision history](https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html) inside the [Angular](https://angular.io/) application.

* `/real-time-collaboration-for-react` – A sample integration of the CKEditor 5 WYSIWYG editor with [real-time-collaboration features](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/real-time-collaboration/real-time-collaboration.html) and [revision history](https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html) inside the [React](https://reactjs.org/) application.

* `/real-time-collaboration-for-vue` – A sample integration of the CKEditor 5 WYSIWYG editor with [real-time-collaboration features](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/real-time-collaboration/real-time-collaboration.html) and [revision history](https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html) inside the [Vue](https://vuejs.org/) application.

* `/real-time-collaboration-for-next` – A sample integration of the CKEditor 5 WYSIWYG editor with [real-time-collaboration features](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/real-time-collaboration/real-time-collaboration.html) and [revision history](https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html) inside the [Next.js](https://nextjs.org/) application.

* `/real-time-collaboration-editor-multi-root-for-react` – A sample of the CKEditor 5 [multi-root editor](https://ckeditor.com/docs/ckeditor5/latest/getting-started/installation/react/react-multiroot.html) with [real-time-collaboration features](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/real-time-collaboration/real-time-collaboration.html) and [revision history](https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html) inside the [React](https://reactjs.org/) application.

* `/collaboration-for-angular` – A sample integration of the CKEditor 5 WYSIWYG editor with offline [track changes](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/track-changes/track-changes.html), [comments](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/comments/comments.html) and [revision history](https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html) inside the [Angular](https://angular.io/) application.

* `/collaboration-for-react` – A sample integration of the CKEditor 5 WYSIWYG editor with offline [track changes](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/track-changes/track-changes.html), [comments](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/comments/comments.html) and [revision history](https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html) inside the [React](https://reactjs.org/) application.

* `/collaboration-for-vue` – A sample integration of the CKEditor 5 WYSIWYG editor with offline [track changes](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/track-changes/track-changes.html), [comments](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/comments/comments.html) and [revision history](https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html) inside the [Vue](https://vuejs.org/) application.

* `/collaboration-for-next` – A sample integration of the CKEditor 5 WYSIWYG editor with offline [track changes](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/track-changes/track-changes.html), [comments](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/comments/comments.html) and [revision history](https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html) inside the [Next.js](https://nextjs.org/) application.

## Development

Refer to [DEV-README.md](DEV-README.md) file for development related documentation.

## License

For license details see: [LICENSE.md](https://github.com/ckeditor/ckeditor5-collaboration-samples/blob/master/LICENSE.md).