Piotrek Koszuliński 4c2c548c40 Internal: Updated dependencies. [skip ci] há 7 anos atrás
..
.github 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. há 8 anos atrás
bin 9d26c2e86f Internal: Bumped the year. [skip ci] há 8 anos atrás
build 77bddbb9ba Internal: Build. há 7 anos atrás
sample f17787ba75 Internal: Updated links to CKEditor 5 website. [skip ci] há 7 anos atrás
src 1841d92b06 Removed duplicated "ImageUpload" plugin. há 7 anos atrás
tests f17787ba75 Internal: Updated links to CKEditor 5 website. [skip ci] há 7 anos atrás
.editorconfig 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. há 8 anos atrás
.gitattributes 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. há 8 anos atrás
.gitignore 32fd78aace Internal: Added "package-lock.json" to ignored files. Closes #6. há 8 anos atrás
CHANGELOG.md 1ae966f3f4 Docs: Corrected the changelog. [skip ci] há 7 anos atrás
CONTRIBUTING.md 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. há 8 anos atrás
LICENSE.md 9d26c2e86f Internal: Bumped the year. [skip ci] há 8 anos atrás
README.md 9e3532d3e1 Merge branch 'stable' há 7 anos atrás
build-config.js 1841d92b06 Removed duplicated "ImageUpload" plugin. há 7 anos atrás
package.json 4c2c548c40 Internal: Updated dependencies. [skip ci] há 7 anos atrás
webpack.config.js 84f25cf775 Other: Unify `getPostCssConfig()` from @ckeditor/ckeditor5-dev-utils package. há 7 anos atrás

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 GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the LICENSE.md file.