Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@ckeditor/ckeditor5-highlight
Advanced tools
@ckeditor/ckeditor5-highlight - npm Package Compare versions
Comparing version 1.0.0-beta.1 to 1.0.0-beta.2
| Changelog | ||
| ========= | ||
| ## [1.0.0-beta.2](https://github.com/ckeditor/ckeditor5-highlight/compare/v1.0.0-beta.1...v1.0.0-beta.2) (2018-04-10) | ||
| Internal changes only (updated dependencies, documentation, etc.). | ||
| ## [1.0.0-beta.1](https://github.com/ckeditor/ckeditor5-highlight/compare/v0.0.1...v1.0.0-beta.1) (2018-03-15) | ||
@@ -5,0 +10,0 @@ |
| { | ||
| "name": "@ckeditor/ckeditor5-highlight", | ||
| "version": "1.0.0-beta.1", | ||
| "version": "1.0.0-beta.2", | ||
| "description": "Highilght feature for CKEditor 5.", | ||
@@ -10,21 +10,21 @@ "keywords": [ | ||
| "dependencies": { | ||
| "@ckeditor/ckeditor5-core": "^1.0.0-beta.1", | ||
| "@ckeditor/ckeditor5-engine": "^1.0.0-beta.1", | ||
| "@ckeditor/ckeditor5-ui": "^1.0.0-beta.1" | ||
| "@ckeditor/ckeditor5-core": "^1.0.0-beta.2", | ||
| "@ckeditor/ckeditor5-engine": "^1.0.0-beta.2", | ||
| "@ckeditor/ckeditor5-ui": "^1.0.0-beta.2" | ||
| }, | ||
| "devDependencies": { | ||
| "@ckeditor/ckeditor5-block-quote": "^1.0.0-beta.1", | ||
| "@ckeditor/ckeditor5-cloudservices": "^1.0.0-beta.1", | ||
| "@ckeditor/ckeditor5-editor-classic": "^1.0.0-beta.1", | ||
| "@ckeditor/ckeditor5-enter": "^1.0.0-beta.1", | ||
| "@ckeditor/ckeditor5-heading": "^1.0.0-beta.1", | ||
| "@ckeditor/ckeditor5-image": "^1.0.0-beta.1", | ||
| "@ckeditor/ckeditor5-list": "^1.0.0-beta.1", | ||
| "@ckeditor/ckeditor5-paragraph": "^1.0.0-beta.1", | ||
| "@ckeditor/ckeditor5-typing": "^1.0.0-beta.1", | ||
| "@ckeditor/ckeditor5-utils": "^1.0.0-beta.1", | ||
| "@ckeditor/ckeditor5-block-quote": "^1.0.0-beta.2", | ||
| "@ckeditor/ckeditor5-cloud-services": "^1.0.0-beta.2", | ||
| "@ckeditor/ckeditor5-editor-classic": "^1.0.0-beta.2", | ||
| "@ckeditor/ckeditor5-enter": "^1.0.0-beta.2", | ||
| "@ckeditor/ckeditor5-heading": "^1.0.0-beta.2", | ||
| "@ckeditor/ckeditor5-image": "^1.0.0-beta.2", | ||
| "@ckeditor/ckeditor5-list": "^1.0.0-beta.2", | ||
| "@ckeditor/ckeditor5-paragraph": "^1.0.0-beta.2", | ||
| "@ckeditor/ckeditor5-typing": "^1.0.0-beta.2", | ||
| "@ckeditor/ckeditor5-utils": "^1.0.0-beta.2", | ||
| "eslint": "^4.15.0", | ||
| "eslint-config-ckeditor5": "^1.0.7", | ||
| "husky": "^0.14.3", | ||
| "lint-staged": "^6.0.0" | ||
| "lint-staged": "^7.0.0" | ||
| }, | ||
@@ -37,3 +37,3 @@ "engines": { | ||
| "license": "(GPL-2.0 OR LGPL-2.1 OR MPL-1.1)", | ||
| "homepage": "https://ckeditor5.github.io", | ||
| "homepage": "https://ckeditor.com", | ||
| "bugs": "https://github.com/ckeditor/ckeditor5-highlight/issues", | ||
@@ -40,0 +40,0 @@ "repository": { |
@@ -16,3 +16,3 @@ CKEditor 5 highlight feature | ||
| See the [`@ckeditor/ckeditor5-highlight` package](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/highlight.html) page in [CKEditor 5 documentation](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/). | ||
| See the [`@ckeditor/ckeditor5-highlight` package](https://docs.ckeditor.com/ckeditor5/latest/api/highlight.html) page in [CKEditor 5 documentation](https://docs.ckeditor.com/ckeditor5/latest/). | ||
@@ -19,0 +19,0 @@ ## License |
@@ -21,3 +21,3 @@ /** | ||
| * | ||
| * Read more about the feature in the {@glink api/highlight highlight package} page. | ||
| * For a detailed overview, check the {@glink features/highlight highlight feature} documentation. | ||
| * | ||
@@ -43,3 +43,3 @@ * @extends module:core/plugin~Plugin | ||
| /** | ||
| * The highlight option descriptor. See the {@link module:highlight/highlight~HighlightConfig} to learn more. | ||
| * The highlight option descriptor. See {@link module:highlight/highlight~HighlightConfig} to learn more. | ||
| * | ||
@@ -57,9 +57,10 @@ * { | ||
| * @property {String} model The unique attribute value in the model. | ||
| * @property {String} color The CSS var() used for the highlighter. The color is used in the user interface to represent the highlighter. | ||
| * There is possibility to use default color format like rgb, hex or hsl, but you need to care about color of `<mark>` | ||
| * @property {String} color The CSS `var()` used for the highlighter. The color is used in the user interface to represent the highlighter. | ||
| * There is a possibility to use the default color format like rgb, hex or hsl, but you need to care about the color of `<mark>` | ||
| * by adding CSS classes definition. | ||
| * @property {String} class The CSS class used on the `<mark>` element in the view. It should match the `color` setting. | ||
| * @property {'marker'|'pen'} type The type of highlighter: | ||
| * - `'marker'` – uses the `color` as a `background-color` style, | ||
| * - `'pen'` – uses the `color` as a font `color` style. | ||
| * | ||
| * * `'marker'` – Uses the `color` as the `background-color` style, | ||
| * * `'pen'` – Uses the `color` as the font `color` style. | ||
| */ | ||
@@ -76,7 +77,7 @@ | ||
| /** | ||
| * The configuration of the {@link module:highlight/highlight~Highlight Highlight feature}. | ||
| * The configuration of the {@link module:highlight/highlight~Highlight highlight feature}. | ||
| * | ||
| * ClassicEditor | ||
| * .create( editorElement, { | ||
| * highlight: ... // Highlight feature config. | ||
| * highlight: ... // Highlight feature configuration. | ||
| * } ) | ||
@@ -92,3 +93,3 @@ * .then( ... ) | ||
| /** | ||
| * The available highlighters options. The default value is: | ||
| * The available highlight options. The default value is: | ||
| * | ||
@@ -141,6 +142,7 @@ * options: [ | ||
| * There are two types of highlighters available: | ||
| * - `'marker'` - rendered as a `<mark>` element, styled with the `background-color`, | ||
| * - `'pen'` - rendered as a `<mark>` element, styled with the font `color`. | ||
| * | ||
| * **Note**: The highlight feature provides a style sheet with the CSS classes and corresponding colors defined | ||
| * * `'marker'` – Rendered as a `<mark>` element, styled with the `background-color`. | ||
| * * `'pen'` – Rendered as a `<mark>` element, styled with the font `color`. | ||
| * | ||
| * **Note**: The highlight feature provides a stylesheet with the CSS classes and corresponding colors defined | ||
| * as CSS variables. | ||
@@ -164,9 +166,9 @@ * | ||
| * | ||
| * **Note**: It is possible to define the `color` property directly as `rgba(R, G, B, A)`, | ||
| * It is possible to define the `color` property directly as `rgba(R, G, B, A)`, | ||
| * `#RRGGBB[AA]` or `hsla(H, S, L, A)`. In such situation, the color will **only** apply to the UI of | ||
| * the editor and the `<mark>` elements in the content must be styled by custom classes provided by | ||
| * a dedicated style sheet. | ||
| * a dedicated stylesheet. | ||
| * | ||
| * **Note**: It is recommended for the `color` property to correspond to the class in the content | ||
| * style sheet because it represents the highlighter in the user interface of the editor. | ||
| * stylesheet because it represents the highlighter in the user interface of the editor. | ||
| * | ||
@@ -173,0 +175,0 @@ * ClassicEditor |
@@ -19,3 +19,3 @@ /** | ||
| * | ||
| * **Note**: Executing the command without the value removes the attribute from the model. If the selection is collapsed | ||
| * **Note**: Executing the command without a value removes the attribute from the model. If the selection is collapsed | ||
| * inside a text with the highlight attribute, the command will remove the attribute from the entire range | ||
@@ -51,3 +51,3 @@ * of that text. | ||
| * @param {Object} [options] Options for the executed command. | ||
| * @param {String} [options.value] a value to apply. | ||
| * @param {String} [options.value] The value to apply. | ||
| * | ||
@@ -54,0 +54,0 @@ * @fires execute |
@@ -17,3 +17,3 @@ /** | ||
| * attribute in the {@link module:engine/model/model~Model model} which renders in the {@link module:engine/view/view view} | ||
| * as a `<mark>` element with the class attribute (`<span class="marker-green">...</span>`) depending | ||
| * as a `<mark>` element with a `class` attribute (`<mark class="marker-green">...</mark>`) depending | ||
| * on the {@link module:highlight/highlight~HighlightConfig configuration}. | ||
@@ -96,5 +96,5 @@ * | ||
| // Converts options array to a converter definition. | ||
| // Converts the options array to a converter definition. | ||
| // | ||
| // @param {Array.<module:highlight/highlight~HighlightOption>} options Array with configured options. | ||
| // @param {Array.<module:highlight/highlight~HighlightOption>} options An array with configured options. | ||
| // @returns {module:engine/conversion/conversion~ConverterDefinition} | ||
@@ -114,3 +114,3 @@ function _buildDefinition( options ) { | ||
| name: 'mark', | ||
| class: option.class | ||
| classes: option.class | ||
| }; | ||
@@ -117,0 +117,0 @@ } |
@@ -25,6 +25,6 @@ /** | ||
| /** | ||
| * The default Highlight UI plugin. It introduces: | ||
| * The default highlight UI plugin. It introduces: | ||
| * | ||
| * * the `'highlight'` dropdown, | ||
| * * `'removeHighlight'` and `'highlight:*'` buttons. | ||
| * * The `'highlight'` dropdown, | ||
| * * The `'removeHighlight'` and `'highlight:*'` buttons. | ||
| * | ||
@@ -98,3 +98,3 @@ * The default configuration includes the following buttons: | ||
| /** | ||
| * Creates remove highlight button. | ||
| * Creates the "Remove highlight" button. | ||
| * | ||
@@ -110,3 +110,3 @@ * @private | ||
| /** | ||
| * Creates toolbar button from provided highlight option. | ||
| * Creates a toolbar button from the provided highlight option. | ||
| * | ||
@@ -132,6 +132,6 @@ * @param {module:highlight/highlight~HighlightOption} option | ||
| * | ||
| * @param {String} name Name of a button. | ||
| * @param {String} label Label for button. | ||
| * @param {String} icon Button's icon. | ||
| * @param {Function} [decorateButton=()=>{}] Additional method for extending button. | ||
| * @param {String} name The name of the button. | ||
| * @param {String} label The label for the button. | ||
| * @param {String} icon The button icon. | ||
| * @param {Function} [decorateButton=()=>{}] Additional method for extending the button. | ||
| * @private | ||
@@ -166,3 +166,3 @@ */ | ||
| /** | ||
| * Creates split button dropdown UI from provided highlight options. | ||
| * Creates the split button dropdown UI from the provided highlight options. | ||
| * | ||
@@ -169,0 +169,0 @@ * @param {Array.<module:highlight/highlight~HighlightOption>} options |
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 by9.47%
43712
- Number of package files
- increased by13.64%
25
- Lines of code
- increased by0.32%
628