Kamil Piechaczek f08d31252d Merge branch 'master' into t/ckeditor5/1236 7 years ago
..
.github 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 years ago
build 06f4b358f1 Internal: Build. 7 years ago
sample 3c4395f2b1 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. 7 years ago
src 4bffcabff0 Feature: Introduced the CKFinder integration plugin. 7 years ago
tests 1a3e983758 Code style in tests. 7 years ago
.editorconfig 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 years ago
.eslintrc.js ed90b8ca8b Added a configuration for ESLint. 7 years ago
.gitattributes 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 years ago
.gitignore 32fd78aace Internal: Added "package-lock.json" to ignored files. Closes #6. 7 years ago
.travis.yml 6e91aa0a61 Introduced a linter and Travis. 7 years ago
CHANGELOG.md cf22d73239 Docs: Corrected the changelog. [skip ci] 7 years ago
CONTRIBUTING.md 7db1df5d22 Docs: Made contributing guide link to our docs. [skip ci] 7 years ago
LICENSE.md 7ee9a6acb1 Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 years ago
README.md 738633f31b Docs: Fixed invalid merge in the readme. 7 years ago
package.json f08d31252d Merge branch 'master' into t/ckeditor5/1236 7 years ago
webpack.config.js 441305ff4f Removed unnecessary comment in `webpack.config.js`. 7 years ago

README.md

CKEditor 5 balloon editor build

npm version Dependency Status devDependency Status

The balloon editor build for CKEditor 5. Read more about the balloon editor build and see the demo.

CKEditor 5 balloon editor build screenshot

Documentation

See:

Quick start

First, install the build from npm:

npm install --save @ckeditor/ckeditor5-build-balloon

And use it in your website:

<div id="editor">
	<p>This is the editor content.</p>
</div>
<script src="./node_modules/@ckeditor/ckeditor5-build-balloon/build/ckeditor.js"></script>
<script>
	BalloonEditor
		.create( document.querySelector( '#editor' ) )
		.then( editor => {
			window.editor = editor;
		} )
		.catch( err => {
			console.error( err.stack );
		} );
</script>

Or in your JavaScript application:

import BalloonEditor from '@ckeditor/ckeditor5-build-balloon';

// Or using the CommonJS version:
// const BalloonEditor = require( '@ckeditor/ckeditor5-build-balloon' );

BalloonEditor
	.create( document.querySelector( '#editor' ) )
	.then( editor => {
		window.editor = editor;
	} )
	.catch( err => {
		console.error( err.stack );
	} );

Note: If you are planning to integrate CKEditor 5 deep into your application, it is actually more convenient and recommended to install and import the source modules directly (like it happens in ckeditor.js). Read more in the Advanced setup guide.

License

Licensed under the terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file.