8
0
Piotrek Koszuliński 5872190b24 Internal: Remove gulp dependency for pre-commit linting. vor 8 Jahren
..
.github 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. vor 8 Jahren
bin 75ff987ef0 Moved "ckeditor.js" file to "src/" directory. vor 8 Jahren
build a1911afeed Internal: Build. vor 8 Jahren
sample c849672fa7 Docs: Improved the sample. See ckeditor/ckeditor5#535. vor 8 Jahren
src 80f4f6d660 Fix: It will be possible to configure toolbar offset without overriding preconfigured toolbar items. See ckeditor/ckeditor5#572. vor 8 Jahren
tests 463214f3b8 Tests: Fixed tests after recent dir structure changes. vor 8 Jahren
.editorconfig 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. vor 8 Jahren
.gitattributes 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. vor 8 Jahren
.gitignore 5872190b24 Internal: Remove gulp dependency for pre-commit linting. vor 8 Jahren
CHANGELOG.md 5872190b24 Internal: Remove gulp dependency for pre-commit linting. vor 8 Jahren
CONTRIBUTING.md 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. vor 8 Jahren
LICENSE.md c293614fea Other: The build name has been changed from `@ckeditor/ckeditor5-build-balloon-toolbar` to `@ckeditor/ckeditor5-build-balloon`. See ckeditor/ckeditor5#546 for more information. vor 8 Jahren
README.md 97c768e023 Docs: README page corrected. [skip ci] vor 8 Jahren
build-config.js 80f4f6d660 Fix: It will be possible to configure toolbar offset without overriding preconfigured toolbar items. See ckeditor/ckeditor5#572. vor 8 Jahren
package.json 900c793cd0 Release: v1.0.0-alpha.1. vor 8 Jahren
webpack.config.js 75ff987ef0 Moved "ckeditor.js" file to "src/" directory. vor 8 Jahren

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.