Maciej Gołaszewski feceaf384c Other: Renamed 'headings' ui component to 'heading'. 7 年之前
..
.github 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 年之前
bin 9d26c2e86f Internal: Bumped the year. [skip ci] 8 年之前
build f386edfd92 Renamed build/lang to build/translations. 7 年之前
sample b0202764bd Docs: Updated links with anchors. See ckeditor/ckeditor5#826. [skip ci] 7 年之前
src feceaf384c Other: Renamed 'headings' ui component to 'heading'. 7 年之前
tests 9d26c2e86f Internal: Bumped the year. [skip ci] 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 32fd78aace Internal: Added "package-lock.json" to ignored files. Closes #6. 7 年之前
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 9d26c2e86f Internal: Bumped the year. [skip ci] 8 年之前
README.md b0202764bd Docs: Updated links with anchors. See ckeditor/ckeditor5#826. [skip ci] 7 年之前
build-config.js feceaf384c Other: Renamed 'headings' ui component to 'heading'. 7 年之前
package.json 0623840568 Internal: Downgraded webpack-sources because https://github.com/ckeditor/ckeditor5/issues/658 is still a problem. 8 年之前
webpack.config.js 9d26c2e86f Internal: Bumped the year. [skip ci] 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.