Piotrek Koszuliński 4cda1c44d8 Merge branch 'master' into t/ckeditor5/645 7 vuotta sitten
..
.github 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 vuotta sitten
bin 9d26c2e86f Internal: Bumped the year. [skip ci] 8 vuotta sitten
build 9d26c2e86f Internal: Bumped the year. [skip ci] 8 vuotta sitten
sample c849672fa7 Docs: Improved the sample. See ckeditor/ckeditor5#535. 8 vuotta sitten
src 4cda1c44d8 Merge branch 'master' into t/ckeditor5/645 7 vuotta sitten
tests 9d26c2e86f Internal: Bumped the year. [skip ci] 8 vuotta sitten
.editorconfig 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 vuotta sitten
.gitattributes 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 vuotta sitten
.gitignore 5872190b24 Internal: Remove gulp dependency for pre-commit linting. 8 vuotta sitten
CHANGELOG.md 5a0492947b Docs: Fixed links in the changelog. [skip ci] 8 vuotta sitten
CONTRIBUTING.md 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 vuotta sitten
LICENSE.md 9d26c2e86f Internal: Bumped the year. [skip ci] 8 vuotta sitten
README.md 97c768e023 Docs: README page corrected. [skip ci] 8 vuotta sitten
build-config.js 4cda1c44d8 Merge branch 'master' into t/ckeditor5/645 7 vuotta sitten
package.json 0623840568 Internal: Downgraded webpack-sources because https://github.com/ckeditor/ckeditor5/issues/658 is still a problem. 8 vuotta sitten
webpack.config.js 9d26c2e86f Internal: Bumped the year. [skip ci] 8 vuotta sitten

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.

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 CommonJS verion:
// 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 GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the LICENSE.md file.