Aleksander Nowodzinski 98e6346e2c Used the external stylelint-config-ckeditor5 package for stylelint configuration. 6 år sedan
..
.github df0f356383 Internal: Updated the GitHub PR template because all packages share the same issue tracker now (see ckeditor/ckeditor5#5576). 6 år sedan
build 3004661a46 Internal: Build. 6 år sedan
sample 3c4395f2b1 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. 7 år sedan
src 70a4d591b4 Feature: Enabled the indent feature in the build. 6 år sedan
tests 1fd8f69f17 All tests require an image that exists. It will not cause the 404 error. 6 år sedan
.editorconfig 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 år sedan
.eslintrc.js 80e44f1401 Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] 6 å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
.stylelintrc 98e6346e2c Used the external stylelint-config-ckeditor5 package for stylelint configuration. 6 år sedan
.travis.yml c522c7f4ea Internal: Upgraded CI environment to use Xenial version of the distro. See ckeditor/ckeditor#2041. 6 år sedan
CHANGELOG.md 61f7a1c9b5 Docs: Corrected the changelog. [skip ci] 6 år sedan
CONTRIBUTING.md 7db1df5d22 Docs: Made contributing guide link to our docs. [skip ci] 7 år sedan
LICENSE.md abb0740ceb Internal: Bumped the year. [skip ci] 7 år sedan
README.md e872d2e690 Docs: Removed gitter badge. See ckeditor/ckeditor5#2037. [skip ci] 6 år sedan
package.json 72a609124c Internal: Allowed empty input in the stylelint script to avoid errors when no files are found. Added missing stylelint-config-recommended dependency. 6 år sedan
webpack.config.js 328cfd212f Bumped style-loader to v1.0.0. Aligned the webpack config to the new loader API. 6 år sedan

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( 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 or https://ckeditor.com/legal/ckeditor-oss-license.