Piotrek Koszuliński f5099956cc Docs: Corrected the changelog. [skip ci] hace 6 años
..
.github 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. hace 8 años
build e4e8113e2e Internal: Build. hace 6 años
sample 3c4395f2b1 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. hace 7 años
src 80e44f1401 Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] hace 6 años
tests 80e44f1401 Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] hace 6 años
.editorconfig 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. hace 8 años
.eslintrc.js 80e44f1401 Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] hace 6 años
.gitattributes 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. hace 8 años
.gitignore 32fd78aace Internal: Added "package-lock.json" to ignored files. Closes #6. hace 7 años
.travis.yml 9c2c6cd213 Merge branch 'master' into t/ckeditor5/1655 hace 6 años
CHANGELOG.md f5099956cc Docs: Corrected the changelog. [skip ci] hace 6 años
CONTRIBUTING.md 7db1df5d22 Docs: Made contributing guide link to our docs. [skip ci] hace 7 años
LICENSE.md abb0740ceb Internal: Bumped the year. [skip ci] hace 6 años
README.md aa7dc59c6d Internal: Updated license section in README. See ckeditor/ckeditor5#1557. [skip ci] hace 6 años
package.json 75070a40ab Release: v12.1.0. [skip ci] hace 6 años
webpack.config.js 80e44f1401 Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] hace 6 años

README.md

CKEditor 5 balloon editor build

npm version Build Status BrowserStack 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.