Aleksander Nowodzinski 8c059bfee0 Feature: Enabled the indent feature in the build. 6 years ago
..
.github dff075ab80 Initial commit. 7 years ago
build 224bd88043 Internal: Build. 6 years ago
sample 77d2778821 Fixed naming. 6 years ago
src 8c059bfee0 Feature: Enabled the indent feature in the build. 6 years ago
tests e8d4eff340 All tests require an image that exists. It will not cause the 404 error. 6 years ago
theme af62da4192 Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] 6 years ago
.editorconfig dff075ab80 Initial commit. 7 years ago
.eslintrc.js af62da4192 Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] 6 years ago
.gitattributes dff075ab80 Initial commit. 7 years ago
.gitignore dff075ab80 Initial commit. 7 years ago
.travis.yml 4591c862d0 Internal: Upgraded CI environment to use Xenial version of the distro. See ckeditor/ckeditor#2041. 6 years ago
CHANGELOG.md ba9e35f477 Docs: Corrected the changelog. [skip ci] 6 years ago
CONTRIBUTING.md dff075ab80 Initial commit. 7 years ago
LICENSE.md f6a6e23573 Bumped up the year. 6 years ago
README.md a1bac8c6b7 Docs: Removed gitter badge. See ckeditor/ckeditor5#2037. [skip ci] 6 years ago
package.json 8c059bfee0 Feature: Enabled the indent feature in the build. 6 years ago
webpack.config.js 9c46228e49 Bumped style-loader to v1.0.0. Aligned the webpack config to the new loader API. 6 years ago

README.md

CKEditor 5 balloon block editor build

npm version Dependency Status devDependency Status

The build of CKEditor 5 featuring the balloon and block toolbars. Read more about the balloon block editor build and see the demo.

CKEditor 5 balloon block editor build screenshot

Documentation

See:

Quick start

First, install the build from npm:

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

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-block/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-block';

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

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.

Note: You can configure the block toolbar items using the config.blockToolbar option.

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.