@ckeditor/ckeditor5-utils
Advanced tools
@ckeditor/ckeditor5-utils - npm Package Compare versions
Comparing version 12.0.0 to 12.1.0
| Changelog | ||
| ========= | ||
| ## [12.1.0](https://github.com/ckeditor/ckeditor5-utils/compare/v12.0.0...v12.1.0) (2019-04-10) | ||
| ### Features | ||
| * Added `isSafari` property and `isSafari()` helper to the `env` module. See: [ckeditor/ckeditor5#1463](https://github.com/ckeditor/ckeditor5/issues/1463). ([f1ba6ae](https://github.com/ckeditor/ckeditor5-utils/commit/f1ba6ae)) | ||
| * Made `FocusTracker#focusedElement` observable to bring support for multi-root editors (see [ckeditor/ckeditor5#1599](https://github.com/ckeditor/ckeditor5/issues/1599)). ([952d440](https://github.com/ckeditor/ckeditor5-utils/commit/952d440)) | ||
| ## [12.0.0](https://github.com/ckeditor/ckeditor5-utils/compare/v11.1.0...v12.0.0) (2019-02-28) | ||
@@ -5,0 +13,0 @@ |
| { | ||
| "name": "@ckeditor/ckeditor5-utils", | ||
| "version": "12.0.0", | ||
| "version": "12.1.0", | ||
| "description": "Miscellaneous utils used by CKEditor 5.", | ||
@@ -12,9 +12,8 @@ "keywords": [ | ||
| "dependencies": { | ||
| "ckeditor5": "^12.0.0", | ||
| "ckeditor5": "^12.1.0", | ||
| "lodash-es": "^4.17.10" | ||
| }, | ||
| "devDependencies": { | ||
| "@ckeditor/ckeditor5-core": "^12.0.0", | ||
| "@ckeditor/ckeditor5-engine": "^13.0.0", | ||
| "del": "^2.2.0", | ||
| "@ckeditor/ckeditor5-core": "^12.1.0", | ||
| "@ckeditor/ckeditor5-engine": "^13.1.0", | ||
| "eslint": "^5.5.0", | ||
@@ -21,0 +20,0 @@ "eslint-config-ckeditor5": "^1.0.11", |
@@ -14,2 +14,5 @@ /** | ||
| // To check if component is loaded more than once. | ||
| import './version'; | ||
| const _listeningTo = Symbol( 'listeningTo' ); | ||
@@ -16,0 +19,0 @@ const _emitterId = Symbol( 'emitterId' ); |
@@ -42,3 +42,11 @@ /** | ||
| */ | ||
| isGecko: isGecko( userAgent ) | ||
| isGecko: isGecko( userAgent ), | ||
| /** | ||
| * Indicates that the application is running in Safari. | ||
| * | ||
| * @static | ||
| * @member {Boolean} module:utils/env~env#isSafari | ||
| */ | ||
| isSafari: isSafari( userAgent ) | ||
| }; | ||
@@ -77,1 +85,11 @@ | ||
| } | ||
| /** | ||
| * Checks if User Agent represented by the string is Safari. | ||
| * | ||
| * @param {String} userAgent **Lowercase** `navigator.userAgent` string. | ||
| * @returns {Boolean} Whether User Agent is Safari or not. | ||
| */ | ||
| export function isSafari( userAgent ) { | ||
| return userAgent.indexOf( ' applewebkit/' ) > -1 && userAgent.indexOf( 'chrome' ) === -1; | ||
| } |
@@ -42,8 +42,13 @@ /** | ||
| /** | ||
| * Currently focused element. | ||
| * The currently focused element. | ||
| * | ||
| * While {@link #isFocused `isFocused`} remains `true`, the focus can | ||
| * move between different UI elements. This property tracks those | ||
| * elements and tells which one is currently focused. | ||
| * | ||
| * @readonly | ||
| * @member {HTMLElement} | ||
| * @observable | ||
| * @member {HTMLElement|null} | ||
| */ | ||
| this.focusedElement = null; | ||
| this.set( 'focusedElement', null ); | ||
@@ -50,0 +55,0 @@ /** |
@@ -19,12 +19,109 @@ /** | ||
| /** | ||
| * This error is thrown when the `CKEDITOR_VERSION` global is being set more than once. This happens when in | ||
| * two scenarios described above. | ||
| * This error is thrown when due to a mistake in how CKEditor 5 was installed or initialized, some | ||
| * of its modules were duplicated (evaluated and executed twice). Module duplication leads to inevitable runtime | ||
| * errors. | ||
| * | ||
| * # Some packages were duplicated | ||
| * There are many situations in which some modules can be loaded twice. In the worst case scenario, | ||
| * you may need to check your project for each of those issues and fix them all. | ||
| * | ||
| * CKEditor 5 was built from source packages which were duplicated during installation via npm. | ||
| * # Trying to add a plugin to an existing build | ||
| * | ||
| * If you import an existing CKEditor 5 build and a plugin like this: | ||
| * | ||
| * import ClassicEditor from '@ckeditor/ckeditor5-build-classic'; | ||
| * import Highlight from '@ckeditor/ckeditor5-highlight/src/highlight'; | ||
| * | ||
| * Then your project loads some CKEditor 5 packages twice. How does it happen? | ||
| * | ||
| * The build package contains a file which is already compiled with webpack, | ||
| * meaning that it contains all the necessary code from e.g. `@ckeditor/ckeditor5-engine` and `@ckeditor/ckeditor5-utils`. | ||
| * | ||
| * However, the `Highlight` plugin imports some of the modules from those packages too. If you ask webpack to | ||
| * build such a project, you will end up with those modules being included (and run) twice – first, because they are | ||
| * included inside the build package, and second because they are required by the `Highlight` plugin. | ||
| * | ||
| * Therefore, **you must never add plugins to an existing build** unless your plugin has no dependencies. | ||
| * | ||
| * Adding plugins to a build is done by taking the source version of this build (so, before it was built with webpack) | ||
| * and adding plugins there. In this situation, webpack will know that it only needs to load each plugins once. | ||
| * | ||
| * Read more in the {@glink builds/guides/integration/installing-plugins "Installing plugins"} guide. | ||
| * | ||
| * # Confused an editor build with an editor implementation | ||
| * | ||
| * This scenario is very similar to the previous one, but has a different origin. | ||
| * | ||
| * Let's assume, that you wanted to use CKEditor 5 from source, as explained in the | ||
| * {@glink builds/guides/integration/advanced-setup#scenario-2-building-from-source "Building from source"} section | ||
| * or in the {@glink framework/guides/quick-start "Quick start"} guide of the CKEditor 5 Framework. | ||
| * | ||
| * The correct way to do so is to import an editor and plugins and run them together like this: | ||
| * | ||
| * import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor'; | ||
| * import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials'; | ||
| * import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; | ||
| * import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold'; | ||
| * import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic'; | ||
| * | ||
| * ClassicEditor | ||
| * .create( document.querySelector( '#editor' ), { | ||
| * plugins: [ Essentials, Paragraph, Bold, Italic ], | ||
| * toolbar: [ 'bold', 'italic' ] | ||
| * } ) | ||
| * .then( editor => { | ||
| * console.log( 'Editor was initialized', editor ); | ||
| * } ) | ||
| * .catch( error => { | ||
| * console.error( error.stack ); | ||
| * } ); | ||
| * | ||
| * However, you might have mistakenly import a build instead of a source `ClassicEditor`. In which case | ||
| * your imports will look like this: | ||
| * | ||
| * import ClassicEditor from '@ckeditor/ckeditor5-build-classic'; | ||
| * import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials'; | ||
| * import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; | ||
| * import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold'; | ||
| * import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic'; | ||
| * | ||
| * This creates the same situation as in the previous section because you use a build together with source plugins. | ||
| * | ||
| * Remember: `@ckeditor/ckeditor5-build-*` packages contain editor builds and `@ckeditor/ckeditor5-editor-*` source editors. | ||
| * | ||
| * # Loading two+ builds on one page | ||
| * | ||
| * If you use CKEditor 5 builds, you might have loaded two (or more) `ckeditor.js` files in one web page | ||
| * – check your web page for duplicated `<script>` elements or make sure your page builder/bundler includes CKEditor only once. | ||
| * | ||
| * If you want to use two different types of editors at once, see the | ||
| * {@glink builds/guides/integration/advanced-setup#scenario-3-using-two-different-editors "Using two different editors"} | ||
| * section. | ||
| * | ||
| * # Using outdated packages | ||
| * | ||
| * Building CKEditor 5 from source require using multiple npm packages. Those packages have their dependencies | ||
| * to other packages. If you use the latest version of let's say `@ckeditor/ckeditor5-editor-classic` with | ||
| * and outdated version of `@ckeditor/ckeditor5-image`, npm or yarn will need to install two different versions of | ||
| * `@ckeditor/ckeditor5-core` because `@ckeditor/ckeditor5-editor-classic` and `@ckeditor/ckeditor5-image` may require | ||
| * different versions of the core package. | ||
| * | ||
| * The solution to this issue is to update all packages to their latest version. We recommend | ||
| * using tools like [`node-check-updates`](https://www.npmjs.com/package/npm-check-updates) which simplify this process. | ||
| * | ||
| * # Conflicting version of dependencies | ||
| * | ||
| * This is a special case of the previous scenario. If you use CKEditor 5 with some 3rd party plugins, | ||
| * it may happen that even if you use the latest versions of the official packages and the latest version of | ||
| * those 3rd party packages, there will be a conflict between some of their dependencies. | ||
| * | ||
| * Such a problem can be resolved by either downgrading CKEditor 5 packages (which we do not recommend) or | ||
| * asking the author of the 3rd party package to upgrade its depdendencies (or forking his project and doing this yourself). | ||
| * | ||
| * # Packages were duplicated in `node_modules` | ||
| * | ||
| * In some situations, especially when calling `npm install` multiple times, it may happen | ||
| * than npm will not correctly "deduplicate" packages. | ||
| * | ||
| * Normally, npm deduplicates all packages so e.g. `@ckeditor/ckeditor5-core` is installed only once in `node_modules/`. | ||
| * However, subsequent `npm install` calls or conflicting version dependencies may cause npm to install some packages | ||
| * more than once. Furthermore, [npm in version 5+](https://github.com/npm/npm/issues/16991) | ||
| * is also known for randomly failing to deduplicate packages. | ||
| * However, it was known to fail to do so from time to time. | ||
| * | ||
@@ -35,25 +132,15 @@ * We recommend checking if any of the below steps helps: | ||
| * is known to help in majority of cases, | ||
| * * if you use `yarn.lock` or `package-lock.json`, remove it before `npm install`, | ||
| * * check whether all CKEditor 5 packages are up to date and reinstall them | ||
| * if you changed anything (`rm -rf node_modules && npm install`), | ||
| * * downgrade npm to version 4 if you use a newer version. | ||
| * if you changed anything (`rm -rf node_modules && npm install`). | ||
| * | ||
| * If all packages are correct and compatible with each other the above steps are known to help. If not, you may | ||
| * try to check with `npm ls` how many times `@ckeditor/ckeditor5-core` is installed. If more than once, verify | ||
| * which package causes that. | ||
| * try to check with `npm ls` how many times packages like `@ckeditor/ckeditor5-core`, `@ckeditor/ckeditor5-engine` and | ||
| *`@ckeditor/ckeditor5-utils` are installed. If more than once, verify which package causes that. | ||
| * | ||
| * # Two+ builds are loaded | ||
| * | ||
| * If you use CKEditor 5 builds, you might have loaded two (or more) `ckeditor.js` files in one web page | ||
| * – check your web page for duplicated `<script>` elements or make sure your page builder/bundler includes CKEditor only once. | ||
| * | ||
| * @error ckeditor-version-collision | ||
| * @param {String} collidingVersion The version of the build which has already been (incorrectly) loaded. | ||
| * @param {String} version The version of the build which is supposed to be loaded. | ||
| * @error ckeditor-duplicated-modules | ||
| */ | ||
| log.error( 'ckeditor-version-collision: The global CKEDITOR_VERSION constant has already been set.', { | ||
| collidingVersion: windowOrGlobal.CKEDITOR_VERSION, | ||
| version | ||
| } ); | ||
| log.error( 'ckeditor-duplicated-modules: Some CKEditor 5 modules are duplicated.' ); | ||
| } else { | ||
| windowOrGlobal.CKEDITOR_VERSION = version; | ||
| } |
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
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
- Total package byte prevSize
- increased by3.04%
213435
- Dev dependency count
- decreased by-14.29%
6
- Lines of code
- increased by2.04%
5492
Dependency changes
Updatedckeditor5@^12.1.0