Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@ckeditor/ckeditor5-editor-inline
Advanced tools
@ckeditor/ckeditor5-editor-inline - npm Package Compare versions
Comparing version 0.2.0 to 1.0.0-alpha.1
| Changelog | ||
| ========= | ||
| ## [1.0.0-alpha.1](https://github.com/ckeditor/ckeditor5-editor-inline/compare/v0.2.0...v1.0.0-alpha.1) (2017-10-03) | ||
| Internal changes only (updated dependencies, documentation, etc.). | ||
| ## [0.2.0](https://github.com/ckeditor/ckeditor5-editor-inline/compare/v0.1.1...v0.2.0) (2017-09-03) | ||
@@ -5,0 +10,0 @@ |
| { | ||
| "name": "@ckeditor/ckeditor5-editor-inline", | ||
| "version": "0.2.0", | ||
| "description": "Inline editor for CKEditor 5.", | ||
| "keywords": [], | ||
| "version": "1.0.0-alpha.1", | ||
| "description": "Inline 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-enter": "^1.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-heading": "^1.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-paragraph": "^1.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-typing": "^1.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-undo": "^1.0.0-alpha.1", | ||
| "eslint-config-ckeditor5": "^1.0.6", | ||
| "gulp": "^3.9.1", | ||
@@ -33,3 +39,8 @@ "guppy-pre-commit": "^0.4.0" | ||
| "url": "https://github.com/ckeditor/ckeditor5-editor-inline.git" | ||
| } | ||
| }, | ||
| "files": [ | ||
| "lang", | ||
| "src", | ||
| "theme" | ||
| ] | ||
| } |
@@ -11,6 +11,14 @@ CKEditor 5 inline editor creator | ||
| The inline editor implementation. More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-editor-inline>. | ||
| The inline editor implementation for CKEditor 5. | ||
| This package exposes the [`InlineEditor`](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_editor-inline_inlineeditor-InlineEditor.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 inline editor. This editor implementation is also available in the [inline build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-inline). Read more about [CKEditor 5 Builds](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/builds/index.html). | ||
| ## Documentation | ||
| See the [`@ckeditor/ckeditor5-editor-inline` package](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/editor-inline.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. |
@@ -19,4 +19,23 @@ /** | ||
| /** | ||
| * Inline editor. Uses an inline editable and a floating toolbar. | ||
| * The {@glink builds/guides/overview#Inline-editor inline editor} implementation. | ||
| * It uses an inline editable and a floating toolbar. | ||
| * See the {@glink examples/builds/inline-editor demo}. | ||
| * | ||
| * In order to create a inline editor instance, use the static | ||
| * {@link module:editor-inline/inlineeditor~InlineEditor#create `InlineEditor.create()`} method. | ||
| * | ||
| * # Inline editor and inline build | ||
| * | ||
| * The inline editor can be used directly from source (if you installed the | ||
| * [`@ckeditor/ckeditor5-editor-inline`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-inline) package) | ||
| * but it is also available in the {@glink builds/guides/overview#Inline-editor inline 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-inline/inlineeditor~InlineEditor#create `InlineEditor.create()`}. | ||
| * | ||
| * @extends module:core/editor/standardeditor~StandardEditor | ||
@@ -28,4 +47,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-inline/inlineeditor~InlineEditor#create `InlineEditor.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. | ||
| */ | ||
@@ -59,19 +83,40 @@ constructor( element, config ) { | ||
| /** | ||
| * Creates an inline editor instance. | ||
| * Creates a inline editor instance. | ||
| * | ||
| * InlineEditor.create( document.querySelector( '#editor' ), { | ||
| * plugins: [ Delete, Enter, Typing, Paragraph, Undo, Bold, Italic ], | ||
| * toolbar: [ 'bold', 'italic', 'undo', 'redo' ] | ||
| * } ) | ||
| * .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 module:editor-inline/inlineeditor~InlineEditor#constructor}'s parameters. | ||
| * @param {Object} config See {@link module:editor-inline/inlineeditor~InlineEditor#constructor}'s parameters. | ||
| * InlineEditor | ||
| * .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 InlineEditor from '@ckeditor/ckeditor5-editor-inline/src/inlineeditor'; | ||
| * 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 ... | ||
| * | ||
| * InlineEditor | ||
| * .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-inline/inlineeditor~InlineEditor} instance. | ||
| */ | ||
@@ -78,0 +123,0 @@ static create( element, config ) { |
Sorry, the diff of this file is not supported yet
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
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
Improved metrics
- Number of lines in readme file
- increased by50%
24
Worsened metrics
- Total package byte prevSize
- decreased by-56.19%
20757
- Dev dependency count
- increased by42.86%
10
- Number of package files
- decreased by-71.43%
8
- Lines of code
- decreased by-63.73%
404
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)