Marek Lewandowski b0fcb34a33 Internal: Fixed blog post URL for the 11.0.0 release. [skip ci] 6 years ago
..
.github df0f356383 Internal: Updated the GitHub PR template because all packages share the same issue tracker now (see ckeditor/ckeditor5#5576). 6 years ago
build 82cf6095ae Internal: Build. 6 years ago
sample 715ebc9f14 Minor improvements to error messages used in manual tests and a sample. [skip ci] 6 years ago
src 70a4d591b4 Feature: Enabled the indent feature in the build. 6 years ago
tests 715ebc9f14 Minor improvements to error messages used in manual tests and a sample. [skip ci] 6 years ago
.editorconfig 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 years ago
.eslintrc.js 80e44f1401 Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] 6 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
.stylelintrc 98e6346e2c Used the external stylelint-config-ckeditor5 package for stylelint configuration. 6 years ago
.travis.yml c522c7f4ea Internal: Upgraded CI environment to use Xenial version of the distro. See ckeditor/ckeditor#2041. 6 years ago
CHANGELOG.md b0fcb34a33 Internal: Fixed blog post URL for the 11.0.0 release. [skip ci] 6 years ago
CONTRIBUTING.md 7db1df5d22 Docs: Made contributing guide link to our docs. [skip ci] 7 years ago
LICENSE.md abb0740ceb Internal: Bumped the year. [skip ci] 6 years ago
README.md 715ebc9f14 Minor improvements to error messages used in manual tests and a sample. [skip ci] 6 years ago
package.json 5e8e856992 Release: v16.0.0. [skip ci] 6 years ago
webpack.config.js 44417a5e3c Replaced UglifyJS with Terser. 6 years ago

README.md

CKEditor 5 balloon editor build

npm version Build Status
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( error => {
			console.error( 'There was a problem initializing the editor.', error );
		} );
</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( error => {
		console.error( 'There was a problem initializing the editor.', error );
	} );

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 or https://ckeditor.com/legal/ckeditor-oss-license.