Piotrek Koszuliński 3ef3bd83ac Docs: Changelog. [skip ci] 5 年 前
..
.github df0f356383 Internal: Updated the GitHub PR template because all packages share the same issue tracker now (see ckeditor/ckeditor5#5576). 6 年 前
build 251ee8dad8 Internal: Build. 5 年 前
sample 715ebc9f14 Minor improvements to error messages used in manual tests and a sample. [skip ci] 6 年 前
src f285cc51a8 Internal: Bumped the year. [skip ci] 6 年 前
tests f285cc51a8 Internal: Bumped the year. [skip ci] 6 年 前
.editorconfig 7e8437c94b Internal: Added config for package.json to .editorconfig. See #318. 6 年 前
.eslintrc.js f285cc51a8 Internal: Bumped the year. [skip ci] 6 年 前
.gitattributes 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 年 前
.gitignore 32fd78aace Internal: Added "package-lock.json" to ignored files. Closes #6. 7 年 前
.stylelintrc 98e6346e2c Used the external stylelint-config-ckeditor5 package for stylelint configuration. 6 年 前
.travis.yml c522c7f4ea Internal: Upgraded CI environment to use Xenial version of the distro. See ckeditor/ckeditor#2041. 6 年 前
CHANGELOG.md 3ef3bd83ac Docs: Changelog. [skip ci] 5 年 前
CONTRIBUTING.md 7db1df5d22 Docs: Made contributing guide link to our docs. [skip ci] 7 年 前
LICENSE.md f285cc51a8 Internal: Bumped the year. [skip ci] 6 年 前
README.md 715ebc9f14 Minor improvements to error messages used in manual tests and a sample. [skip ci] 6 年 前
package.json 5e8e856992 Release: v16.0.0. [skip ci] 6 年 前
webpack.config.js f285cc51a8 Internal: Bumped the year. [skip ci] 6 年 前

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.