Piotrek Koszuliński 63e2395e9f Bump, bump. 7 år sedan
..
.github 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 år sedan
bin 31942dee1e Switched to webpack@4.12 and UglifyJsWebpackPlugin. 7 år sedan
build 4918aa585b Changed RegExp for preserved comments. 7 år sedan
sample f17787ba75 Internal: Updated links to CKEditor 5 website. [skip ci] 7 år sedan
src 1841d92b06 Removed duplicated "ImageUpload" plugin. 7 år sedan
tests f17787ba75 Internal: Updated links to CKEditor 5 website. [skip ci] 7 år sedan
.editorconfig 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 år sedan
.gitattributes 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 år sedan
.gitignore 32fd78aace Internal: Added "package-lock.json" to ignored files. Closes #6. 8 år sedan
CHANGELOG.md 936a4b8000 Docs: Corrected the changelog. [skip ci] 7 år sedan
CONTRIBUTING.md 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 år sedan
LICENSE.md 7ee9a6acb1 Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 år sedan
README.md 7ee9a6acb1 Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 år sedan
build-config.js 1841d92b06 Removed duplicated "ImageUpload" plugin. 7 år sedan
package.json 63e2395e9f Bump, bump. 7 år sedan
webpack.config.js aa05297c3a Switched back to banner with exclamation mark. 7 år sedan

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 the CommonJS version:
// 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 terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file.