Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@ckeditor/ckeditor5-editor-balloon
Advanced tools
@ckeditor/ckeditor5-editor-balloon - npm Package Compare versions
Comparing version 0.1.0 to 1.0.0-alpha.1
| Changelog | ||
| ========= | ||
| ## [1.0.0-alpha.1](https://github.com/ckeditor/ckeditor5-editor-balloon/compare/v0.1.0...v1.0.0-alpha.1) (2017-10-03) | ||
| ### Other changes | ||
| * The editor name has been changed from `@ckeditor/ckeditor5-build-balloon-toolbar` to `@ckeditor/ckeditor5-build-balloon` (the class name has been changed to `BalloonEditor`). See [ckeditor/ckeditor5#546](https://github.com/ckeditor/ckeditor5/issues/546) for more information. ([5fc4f60](https://github.com/ckeditor/ckeditor5-editor-balloon/commit/5fc4f60)) | ||
| ### BREAKING CHANGES | ||
| * The editor name has been changed. See [ckeditor/ckeditor5#546](https://github.com/ckeditor/ckeditor5/issues/546). | ||
| ## 0.1.0 (2017-09-03) | ||
@@ -5,0 +16,0 @@ |
| Software License Agreement | ||
| ========================== | ||
| **Balloon Toolbar Editor** – https://github.com/ckeditor/ckeditor5-editor-balloon <br> | ||
| **Balloon Editor** – https://github.com/ckeditor/ckeditor5-editor-balloon <br> | ||
| Copyright (c) 2003-2017, [CKSource](http://cksource.com) Frederico Knabben. All rights reserved. | ||
@@ -6,0 +6,0 @@ |
| { | ||
| "name": "@ckeditor/ckeditor5-editor-balloon", | ||
| "version": "0.1.0", | ||
| "description": "Balloon editor for CKEditor 5.", | ||
| "keywords": [], | ||
| "version": "1.0.0-alpha.1", | ||
| "description": "Balloon editor implementation for CKEditor 5.", | ||
| "keywords": [ | ||
| "ckeditor5", | ||
| "ckeditor5-editor" | ||
| ], | ||
| "dependencies": { | ||
| "@ckeditor/ckeditor5-core": "^0.9.0", | ||
| "@ckeditor/ckeditor5-engine": "^0.11.0", | ||
| "@ckeditor/ckeditor5-theme-lark": "^0.9.0", | ||
| "@ckeditor/ckeditor5-ui": "^0.10.0", | ||
| "@ckeditor/ckeditor5-utils": "^0.10.0" | ||
| "@ckeditor/ckeditor5-core": "^1.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-engine": "^1.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-theme-lark": "^1.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-ui": "^1.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-utils": "^1.0.0-alpha.1" | ||
| }, | ||
| "devDependencies": { | ||
| "@ckeditor/ckeditor5-dev-lint": "^3.1.0", | ||
| "@ckeditor/ckeditor5-basic-styles": "^0.9.0", | ||
| "@ckeditor/ckeditor5-paragraph": "^0.9.0", | ||
| "@ckeditor/ckeditor5-presets": "^0.3.0", | ||
| "eslint-config-ckeditor5": "^1.0.5", | ||
| "@ckeditor/ckeditor5-dev-lint": "^3.1.4", | ||
| "@ckeditor/ckeditor5-basic-styles": "^1.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-paragraph": "^1.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-essentials": "^1.0.0-alpha.1", | ||
| "eslint-config-ckeditor5": "^1.0.6", | ||
| "gulp": "^3.9.1", | ||
@@ -33,3 +36,8 @@ "guppy-pre-commit": "^0.4.0" | ||
| "url": "https://github.com/ckeditor/ckeditor5-editor-balloon.git" | ||
| } | ||
| }, | ||
| "files": [ | ||
| "lang", | ||
| "src", | ||
| "theme" | ||
| ] | ||
| } |
@@ -1,2 +0,2 @@ | ||
| CKEditor 5 balloon editor creator | ||
| CKEditor 5 balloon editor implementation | ||
| ========================================= | ||
@@ -11,6 +11,14 @@ | ||
| The balloon editor (Medium-like) implementation. More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-editor-balloon>. | ||
| The balloon editor implementation (Medium-like editor) for CKEditor 5. | ||
| This package contains the [`BallonEditor`](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_editor-balloon_ballooneditor-BallonEditor.html) class. Follow there to learn more about this type of editor and how to initialize it. | ||
| This package contains the source version of the balloon editor. This editor implementation is also available in the [balloon build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-balloon). Read more about [CKEditor 5 Builds](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/builds/index.html). | ||
| ## Documentation | ||
| See the [`@ckeditor/ckeditor5-editor-balloon` package](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/editor-balloon.html) page in [CKEditor 5 documentation](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/). | ||
| ## License | ||
| Licensed under the GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the `LICENSE.md` file. |
@@ -20,5 +20,23 @@ /** | ||
| /** | ||
| * The balloon editor. Uses an inline editable and a toolbar based | ||
| * on the {@link module:ui/toolbar/contextual/contextualtoolbar~ContextualToolbar}. | ||
| * The {@glink builds/guides/overview#Balloon-editor balloon editor} implementation (Medium-like editor). | ||
| * It uses an inline editable and a toolbar based on the {@link module:ui/toolbar/contextual/contextualtoolbar~ContextualToolbar}. | ||
| * See the {@glink examples/builds/balloon-editor demo}. | ||
| * | ||
| * In order to create a balloon editor instance, use the static | ||
| * {@link module:editor-balloon/ballooneditor~BalloonEditor#create `BalloonEditor.create()`} method. | ||
| * | ||
| * # Balloon editor and balloon build | ||
| * | ||
| * The balloon editor can be used directly from source (if you installed the | ||
| * [`@ckeditor/ckeditor5-editor-balloon`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-balloon) package) | ||
| * but it is also available in the {@glink builds/guides/overview#Balloon-editor balloon build}. | ||
| * | ||
| * {@glink builds/guides/overview Builds} are ready-to-use editors with plugins bundled in. When using the editor from | ||
| * source you need to take care of loading all plugins by yourself | ||
| * (through the {@link module:core/editor/editorconfig~EditorConfig#plugins `config.plugins`} option). | ||
| * Using the editor from source gives much better flexibility and allows easier customization. | ||
| * | ||
| * Read more about initializing the editor from source or as a build in | ||
| * {@link module:editor-balloon/ballooneditor~BalloonEditor#create `BalloonEditor.create()`}. | ||
| * | ||
| * @extends module:core/editor/standardeditor~StandardEditor | ||
@@ -30,4 +48,9 @@ */ | ||
| * | ||
| * @param {HTMLElement} element The DOM element that will be the source for the created editor. | ||
| * @param {Object} config The editor configuration. | ||
| * **Note:** do not use the constructor to create editor instances. Use the static | ||
| * {@link module:editor-balloon/ballooneditor~BalloonEditor#create `BalloonEditor.create()`} method instead. | ||
| * | ||
| * @protected | ||
| * @param {HTMLElement} element The DOM element that will be the source for the created editor | ||
| * (on which the editor will be initialized). | ||
| * @param {module:core/editor/editorconfig~EditorConfig} config The editor configuration. | ||
| */ | ||
@@ -66,17 +89,38 @@ constructor( element, config ) { | ||
| * | ||
| * BalloonEditor.create( document.querySelector( '#editor' ), { | ||
| * plugins: [ Delete, Enter, Typing, Paragraph, Undo, Bold, Italic ], | ||
| * toolbar: [ 'bold', 'italic' ] | ||
| * } ) | ||
| * .then( editor => { | ||
| * console.log( 'Editor was initialized', editor ); | ||
| * } ) | ||
| * .catch( err => { | ||
| * console.error( err.stack ); | ||
| * } ); | ||
| * Creating instance when using {@glink builds/index CKEditor build}: | ||
| * | ||
| * @param {HTMLElement} element See {@link #constructor}'s parameters. | ||
| * @param {Object} config See {@link #constructor}'s parameters. | ||
| * BalloonEditor | ||
| * .create( document.querySelector( '#editor' ) ) | ||
| * .then( editor => { | ||
| * console.log( 'Editor was initialized', editor ); | ||
| * } ) | ||
| * .catch( err => { | ||
| * console.error( err.stack ); | ||
| * } ); | ||
| * | ||
| * Creating instance when using CKEditor from source (make sure to specify the list of plugins to load and the toolbar): | ||
| * | ||
| * import BalloonEditor from '@ckeditor/ckeditor5-editor-balloon/src/ballooneditor'; | ||
| * import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials'; | ||
| * import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold'; | ||
| * import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic'; | ||
| * import ... | ||
| * | ||
| * BalloonEditor | ||
| * .create( document.querySelector( '#editor' ), { | ||
| * plugins: [ Essentials, Bold, Italic, ... ], | ||
| * toolbar: [ 'bold', 'italic', ... ] | ||
| * } ) | ||
| * .then( editor => { | ||
| * console.log( 'Editor was initialized', editor ); | ||
| * } ) | ||
| * .catch( err => { | ||
| * console.error( err.stack ); | ||
| * } ); | ||
| * | ||
| * @param {HTMLElement} element The DOM element that will be the source for the created editor | ||
| * (on which the editor will be initialized). | ||
| * @param {module:core/editor/editorconfig~EditorConfig} config The editor configuration. | ||
| * @returns {Promise} A promise resolved once the editor is ready. | ||
| * @returns {module:core/editor/standardeditor~StandardEditor} return.editor The editor instance. | ||
| * The promise returns the created {@link module:editor-balloon/ballooneditor~BalloonEditor} instance. | ||
| */ | ||
@@ -83,0 +127,0 @@ static create( element, config ) { |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Number of lines in readme file
- increased by50%
24
Worsened metrics
- Total package byte prevSize
- decreased by-89.59%
14972
- Number of package files
- decreased by-65.22%
8
- Lines of code
- decreased by-61.42%
245
- Number of medium supply chain risk alerts
- increased byInfinity%
1
Dependency changes
+ Added@ckeditor/ckeditor5-core@1.0.0-beta.4(transitive)
+ Added@ckeditor/ckeditor5-engine@1.0.0-beta.4(transitive)
+ Added@ckeditor/ckeditor5-theme-lark@1.0.0-beta.4(transitive)
+ Added@ckeditor/ckeditor5-ui@1.0.0-beta.4(transitive)
+ Added@ckeditor/ckeditor5-utils@1.0.0-beta.4(transitive)
- Removed@ckeditor/ckeditor5-core@0.9.0(transitive)
- Removed@ckeditor/ckeditor5-engine@0.11.0(transitive)
- Removed@ckeditor/ckeditor5-theme-lark@0.9.0(transitive)
- Removed@ckeditor/ckeditor5-ui@0.10.0(transitive)
- Removed@ckeditor/ckeditor5-utils@0.10.0(transitive)