Marek Lewandowski 4d81260297 Merge branch 'monorepo-pending' 5 年之前
..
.github a2f31c6fea Internal: Updated the GitHub PR template because all packages share the same issue tracker now (see ckeditor/ckeditor5#5576). 6 年之前
build 69559be21a Internal: Build. 5 年之前
sample 874c5bfa4c Minor improvements to error messages used in manual tests and a sample. [skip ci] 6 年之前
src 37e84c22c8 Add TextTransformation plugin to the build config 5 年之前
tests 813edd8fb9 Rename top suite of the balloon block editor build. 5 年之前
theme 72d05d8d48 Internal: Bumped the year. [skip ci] 6 年之前
.editorconfig f4df11ea30 Internal: Added config for package.json to .editorconfig. See #318. 6 年之前
.eslintrc.js 72d05d8d48 Internal: Bumped the year. [skip ci] 6 年之前
.gitattributes dff075ab80 Initial commit. 7 年之前
.gitignore dff075ab80 Initial commit. 7 年之前
.stylelintrc 83cd8c22a5 Used the external stylelint-config-ckeditor5 package for stylelint configuration. 6 年之前
.travis.yml 9542534c9e Internal: Updated the version of Node.js on Travis. See ckeditor/ckeditor5#6542. 5 年之前
CHANGELOG.md 7228e039d0 Docs: Corrected the changelog. [skip ci] 5 年之前
CONTRIBUTING.md dff075ab80 Initial commit. 7 年之前
LICENSE.md 72d05d8d48 Internal: Bumped the year. [skip ci] 6 年之前
README.md 874c5bfa4c Minor improvements to error messages used in manual tests and a sample. [skip ci] 6 年之前
package.json 4d81260297 Merge branch 'monorepo-pending' 5 年之前
webpack.config.js 928e7b64f3 Added data-cke attribute to style selector. 5 年之前

README.md

CKEditor 5 balloon block editor build

npm version Dependency Status devDependency Status

The build of CKEditor 5 featuring the balloon and block toolbars. Read more about the balloon block editor build and see the demo.

CKEditor 5 balloon block editor build screenshot

Documentation

See:

Quick start

First, install the build from npm:

npm install --save @ckeditor/ckeditor5-build-balloon-block

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-block/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-block';

// Or using the CommonJS version:
// const BalloonEditor = require( '@ckeditor/ckeditor5-build-balloon-block' );

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.

Note: You can configure the block toolbar items using the config.blockToolbar option.

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.