Piotrek Koszuliński 9d26c2e86f Internal: Bumped the year. [skip ci] 8 years ago
..
.github 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 years ago
bin 9d26c2e86f Internal: Bumped the year. [skip ci] 8 years ago
build 9d26c2e86f Internal: Bumped the year. [skip ci] 8 years ago
sample c849672fa7 Docs: Improved the sample. See ckeditor/ckeditor5#535. 8 years ago
src 9d26c2e86f Internal: Bumped the year. [skip ci] 8 years ago
tests 9d26c2e86f Internal: Bumped the year. [skip ci] 8 years ago
.editorconfig 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 years ago
.gitattributes 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 years ago
.gitignore 5872190b24 Internal: Remove gulp dependency for pre-commit linting. 8 years ago
CHANGELOG.md 5a0492947b Docs: Fixed links in the changelog. [skip ci] 8 years ago
CONTRIBUTING.md 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 years ago
LICENSE.md 9d26c2e86f Internal: Bumped the year. [skip ci] 8 years ago
README.md 97c768e023 Docs: README page corrected. [skip ci] 8 years ago
build-config.js 9d26c2e86f Internal: Bumped the year. [skip ci] 8 years ago
package.json bb6d915ac4 Internal: Bumped ckeditor5-dev-utils version in package.json. 8 years ago
webpack.config.js 9d26c2e86f Internal: Bumped the year. [skip ci] 8 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.

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.