Aleksander Nowodzinski c0ee559693 Merge branch 'master' into t/ckeditor5-ui/144 8 年 前
..
.github 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 年 前
bin 75ff987ef0 Moved "ckeditor.js" file to "src/" directory. 8 年 前
build dbd2b0b7eb Bumped up `ckeditor5-dev` packages. 8 年 前
sample c849672fa7 Docs: Improved the sample. See ckeditor/ckeditor5#535. 8 年 前
src 7ff797f1b5 Aligned code to changed config.lang to config.languages. 8 年 前
tests 463214f3b8 Tests: Fixed tests after recent dir structure changes. 8 年 前
.editorconfig 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 年 前
.gitattributes 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 年 前
.gitignore 5872190b24 Internal: Remove gulp dependency for pre-commit linting. 8 年 前
CHANGELOG.md 5a0492947b Docs: Fixed links in the changelog. [skip ci] 8 年 前
CONTRIBUTING.md 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 年 前
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. 8 年 前
README.md 97c768e023 Docs: README page corrected. [skip ci] 8 年 前
build-config.js 7ff797f1b5 Aligned code to changed config.lang to config.languages. 8 年 前
package.json c0ee559693 Merge branch 'master' into t/ckeditor5-ui/144 8 年 前
webpack.config.js c0ee559693 Merge branch 'master' into t/ckeditor5-ui/144 8 年 前

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.