@ckeditor/ckeditor5-highlight 35.4.0 → 36.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +1 -1
- package/build/highlight.js +2 -2
- package/package.json +21 -16
- package/src/highlight.js +13 -174
- package/src/highlight.ts +225 -0
- package/src/highlightcommand.js +73 -93
- package/src/highlightcommand.ts +113 -0
- package/src/highlightediting.js +92 -107
- package/src/highlightediting.ts +139 -0
- package/src/highlightui.js +183 -232
- package/src/highlightui.ts +282 -0
- package/src/index.js +1 -3
- package/src/index.ts +12 -0
- package/theme/highlight.css +1 -1
package/LICENSE.md
CHANGED
@@ -2,7 +2,7 @@ Software License Agreement
|
|
2
2
|
==========================
|
3
3
|
|
4
4
|
**CKEditor 5 highlight feature** – https://github.com/ckeditor/ckeditor5-highlight <br>
|
5
|
-
Copyright (c) 2003-
|
5
|
+
Copyright (c) 2003-2023, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
|
6
6
|
|
7
7
|
Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).
|
8
8
|
|
package/build/highlight.js
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
!function(e){const t=e.en=e.en||{};t.dictionary=Object.assign(t.dictionary||{},{"Blue marker":"Blue marker","Green marker":"Green marker","Green pen":"Green pen",Highlight:"Highlight","Pink marker":"Pink marker","Red pen":"Red pen","Remove highlight":"Remove highlight","Text highlight toolbar":"Text highlight toolbar","Yellow marker":"Yellow marker"})}(window.CKEDITOR_TRANSLATIONS||(window.CKEDITOR_TRANSLATIONS={})),
|
2
2
|
/*!
|
3
|
-
* @license Copyright (c) 2003-
|
3
|
+
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
|
4
4
|
* For licensing, see LICENSE.md.
|
5
|
-
*/(()=>{var e={458:(e,t,i)=>{"use strict";i.d(t,{Z:()=>o});var r=i(609),n=i.n(r)()((function(e){return e[1]}));n.push([e.id,":root{--ck-highlight-marker-yellow:#fdfd77;--ck-highlight-marker-green:#62f962;--ck-highlight-marker-pink:#fc7899;--ck-highlight-marker-blue:#72ccfd;--ck-highlight-pen-red:#e71313;--ck-highlight-pen-green:#128a00}.ck-content .marker-yellow{background-color:var(--ck-highlight-marker-yellow)}.ck-content .marker-green{background-color:var(--ck-highlight-marker-green)}.ck-content .marker-pink{background-color:var(--ck-highlight-marker-pink)}.ck-content .marker-blue{background-color:var(--ck-highlight-marker-blue)}.ck-content .pen-red{background-color:transparent;color:var(--ck-highlight-pen-red)}.ck-content .pen-green{background-color:transparent;color:var(--ck-highlight-pen-green)}",""]);const o=n},609:e=>{"use strict";e.exports=function(e){var t=[];return t.toString=function(){return this.map((function(t){var i=e(t);return t[2]?"@media ".concat(t[2]," {").concat(i,"}"):i})).join("")},t.i=function(e,i,r){"string"==typeof e&&(e=[[null,e,""]]);var n={};if(r)for(var o=0;o<this.length;o++){var l=this[o][0];null!=l&&(n[l]=!0)}for(var a=0;a<e.length;a++){var c=[].concat(e[a]);r&&n[c[0]]||(i&&(c[2]?c[2]="".concat(i," and ").concat(c[2]):c[2]=i),t.push(c))}},t}},62:(e,t,i)=>{"use strict";var r,n=function(){return void 0===r&&(r=Boolean(window&&document&&document.all&&!window.atob)),r},o=function(){var e={};return function(t){if(void 0===e[t]){var i=document.querySelector(t);if(window.HTMLIFrameElement&&i instanceof window.HTMLIFrameElement)try{i=i.contentDocument.head}catch(e){i=null}e[t]=i}return e[t]}}(),l=[];function a(e){for(var t=-1,i=0;i<l.length;i++)if(l[i].identifier===e){t=i;break}return t}function c(e,t){for(var i={},r=[],n=0;n<e.length;n++){var o=e[n],c=t.base?o[0]+t.base:o[0],s=i[c]||0,h="".concat(c," ").concat(s);i[c]=s+1;var g=a(h),d={css:o[1],media:o[2],sourceMap:o[3]};-1!==g?(l[g].references++,l[g].updater(d)):l.push({identifier:h,updater:v(d,t),references:1}),r.push(h)}return r}function s(e){var t=document.createElement("style"),r=e.attributes||{};if(void 0===r.nonce){var n=i.nc;n&&(r.nonce=n)}if(Object.keys(r).forEach((function(e){t.setAttribute(e,r[e])})),"function"==typeof e.insert)e.insert(t);else{var l=o(e.insert||"head");if(!l)throw new Error("Couldn't find a style target. This probably means that the value for the 'insert' parameter is invalid.");l.appendChild(t)}return t}var h,g=(h=[],function(e,t){return h[e]=t,h.filter(Boolean).join("\n")});function d(e,t,i,r){var n=i?"":r.media?"@media ".concat(r.media," {").concat(r.css,"}"):r.css;if(e.styleSheet)e.styleSheet.cssText=g(t,n);else{var o=document.createTextNode(n),l=e.childNodes;l[t]&&e.removeChild(l[t]),l.length?e.insertBefore(o,l[t]):e.appendChild(o)}}function u(e,t,i){var r=i.css,n=i.media,o=i.sourceMap;if(n?e.setAttribute("media",n):e.removeAttribute("media"),o&&"undefined"!=typeof btoa&&(r+="\n/*# sourceMappingURL=data:application/json;base64,".concat(btoa(unescape(encodeURIComponent(JSON.stringify(o))))," */")),e.styleSheet)e.styleSheet.cssText=r;else{for(;e.firstChild;)e.removeChild(e.firstChild);e.appendChild(document.createTextNode(r))}}var m=null,p=0;function v(e,t){var i,r,n;if(t.singleton){var o=p++;i=m||(m=s(t)),r=d.bind(null,i,o,!1),n=d.bind(null,i,o,!0)}else i=s(t),r=u.bind(null,i,t),n=function(){!function(e){if(null===e.parentNode)return!1;e.parentNode.removeChild(e)}(i)};return r(e),function(t){if(t){if(t.css===e.css&&t.media===e.media&&t.sourceMap===e.sourceMap)return;r(e=t)}else n()}}e.exports=function(e,t){(t=t||{}).singleton||"boolean"==typeof t.singleton||(t.singleton=n());var i=c(e=e||[],t);return function(e){if(e=e||[],"[object Array]"===Object.prototype.toString.call(e)){for(var r=0;r<i.length;r++){var n=a(i[r]);l[n].references--}for(var o=c(e,t),s=0;s<i.length;s++){var h=a(i[s]);0===l[h].references&&(l[h].updater(),l.splice(h,1))}i=o}}}},704:(e,t,i)=>{e.exports=i(79)("./src/core.js")},273:(e,t,i)=>{e.exports=i(79)("./src/ui.js")},79:e=>{"use strict";e.exports=CKEditor5.dll}},t={};function i(r){var n=t[r];if(void 0!==n)return n.exports;var o=t[r]={id:r,exports:{}};return e[r](o,o.exports,i),o.exports}i.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return i.d(t,{a:t}),t},i.d=(e,t)=>{for(var r in t)i.o(t,r)&&!i.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},i.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),i.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},i.nc=void 0;var r={};(()=>{"use strict";i.r(r),i.d(r,{Highlight:()=>d,HighlightEditing:()=>n,HighlightUI:()=>h});var e=i(704);class t extends e.Command{refresh(){const e=this.editor.model,t=e.document;this.value=t.selection.getAttribute("highlight"),this.isEnabled=e.schema.checkAttributeInSelection(t.selection,"highlight")}execute(e={}){const t=this.editor.model,i=t.document.selection,r=e.value;t.change((e=>{if(i.isCollapsed){const t=i.getFirstPosition();if(i.hasAttribute("highlight")){const i=e=>e.item.hasAttribute("highlight")&&e.item.getAttribute("highlight")===this.value,n=t.getLastMatchingPosition(i,{direction:"backward"}),o=t.getLastMatchingPosition(i),l=e.createRange(n,o);r&&this.value!==r?(t.isEqual(o)||e.setAttribute("highlight",r,l),e.setSelectionAttribute("highlight",r)):(t.isEqual(o)||e.removeAttribute("highlight",l),e.removeSelectionAttribute("highlight"))}else r&&e.setSelectionAttribute("highlight",r)}else{const n=t.schema.getValidRanges(i.getRanges(),"highlight");for(const t of n)r?e.setAttribute("highlight",r,t):e.removeAttribute("highlight",t)}}))}}class n extends e.Plugin{static get pluginName(){return"HighlightEditing"}constructor(e){super(e),e.config.define("highlight",{options:[{model:"yellowMarker",class:"marker-yellow",title:"Yellow marker",color:"var(--ck-highlight-marker-yellow)",type:"marker"},{model:"greenMarker",class:"marker-green",title:"Green marker",color:"var(--ck-highlight-marker-green)",type:"marker"},{model:"pinkMarker",class:"marker-pink",title:"Pink marker",color:"var(--ck-highlight-marker-pink)",type:"marker"},{model:"blueMarker",class:"marker-blue",title:"Blue marker",color:"var(--ck-highlight-marker-blue)",type:"marker"},{model:"redPen",class:"pen-red",title:"Red pen",color:"var(--ck-highlight-pen-red)",type:"pen"},{model:"greenPen",class:"pen-green",title:"Green pen",color:"var(--ck-highlight-pen-green)",type:"pen"}]})}init(){const e=this.editor;e.model.schema.extend("$text",{allowAttributes:"highlight"});const i=e.config.get("highlight.options");e.conversion.attributeToElement(function(e){const t={model:{key:"highlight",values:[]},view:{}};for(const i of e)t.model.values.push(i.model),t.view[i.model]={name:"mark",classes:i.class};return t}(i)),e.commands.add("highlight",new t(e))}}var o=i(273);var l=i(62),a=i.n(l),c=i(458),s={injectType:"singletonStyleTag",attributes:{"data-cke":!0},insert:"head",singleton:!0};a()(c.Z,s);c.Z.locals;class h extends e.Plugin{get localizedOptionTitles(){const e=this.editor.t;return{"Yellow marker":e("Yellow marker"),"Green marker":e("Green marker"),"Pink marker":e("Pink marker"),"Blue marker":e("Blue marker"),"Red pen":e("Red pen"),"Green pen":e("Green pen")}}static get pluginName(){return"HighlightUI"}init(){const e=this.editor.config.get("highlight.options");for(const t of e)this._addHighlighterButton(t);this._addRemoveHighlightButton(),this._addDropdown(e)}_addRemoveHighlightButton(){const t=this.editor.t,i=this.editor.commands.get("highlight");this._addButton("removeHighlight",t("Remove highlight"),e.icons.eraser,null,(e=>{e.bind("isEnabled").to(i,"isEnabled")}))}_addHighlighterButton(e){const t=this.editor.commands.get("highlight");this._addButton("highlight:"+e.model,e.title,g(e.type),e.model,(function(i){i.bind("isEnabled").to(t,"isEnabled"),i.bind("isOn").to(t,"value",(t=>t===e.model)),i.iconView.fillColor=e.color,i.isToggleable=!0}))}_addButton(e,t,i,r,n){const l=this.editor;l.ui.componentFactory.add(e,(e=>{const a=new o.ButtonView(e),c=this.localizedOptionTitles[t]?this.localizedOptionTitles[t]:t;return a.set({label:c,icon:i,tooltip:!0}),a.on("execute",(()=>{l.execute("highlight",{value:r}),l.editing.view.focus()})),n(a),a}))}_addDropdown(e){const t=this.editor,i=t.t,r=t.ui.componentFactory,n=e[0],l=e.reduce(((e,t)=>(e[t.model]=t,e)),{});r.add("highlight",(a=>{const c=t.commands.get("highlight"),s=(0,o.createDropdown)(a,o.SplitButtonView),h=s.buttonView;h.set({label:i("Highlight"),tooltip:!0,lastExecuted:n.model,commandValue:n.model,isToggleable:!0}),h.bind("icon").to(c,"value",(e=>g(u(e,"type")))),h.bind("color").to(c,"value",(e=>u(e,"color"))),h.bind("commandValue").to(c,"value",(e=>u(e,"model"))),h.bind("isOn").to(c,"value",(e=>!!e)),h.delegate("execute").to(s);const d=e.map((e=>{const t=r.create("highlight:"+e.model);return this.listenTo(t,"execute",(()=>{s.buttonView.set({lastExecuted:e.model})})),t}));function u(e,t){const i=e&&e!==h.lastExecuted?e:h.lastExecuted;return l[i][t]}return s.bind("isEnabled").toMany(d,"isEnabled",((...e)=>e.some((e=>e)))),d.push(new o.ToolbarSeparatorView),d.push(r.create("removeHighlight")),(0,o.addToolbarToDropdown)(s,d,{enableActiveItemFocusOnDropdownOpen:!0}),function(e){const t=e.buttonView.actionView;t.iconView.bind("fillColor").to(e.buttonView,"color")}(s),s.toolbarView.ariaLabel=i("Text highlight toolbar"),h.on("execute",(()=>{t.execute("highlight",{value:h.commandValue})})),this.listenTo(s,"execute",(()=>{t.editing.view.focus()})),s}))}}function g(e){return"marker"===e?'<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path class="ck-icon__fill" d="M10.798 1.59 3.002 12.875l1.895 1.852 2.521 1.402 6.997-12.194z"/><path d="m2.556 16.727.234-.348c-.297-.151-.462-.293-.498-.426-.036-.137.002-.416.115-.837.094-.25.15-.449.169-.595a4.495 4.495 0 0 0 0-.725c-.209-.621-.303-1.041-.284-1.26.02-.218.178-.506.475-.862l6.77-9.414c.539-.91 1.605-.85 3.199.18 1.594 1.032 2.188 1.928 1.784 2.686l-5.877 10.36c-.158.412-.333.673-.526.782-.193.108-.604.179-1.232.21-.362.131-.608.237-.738.318-.13.081-.305.238-.526.47-.293.265-.504.397-.632.397-.096 0-.27-.075-.524-.226l-.31.41-1.6-1.12zm-.279.415 1.575 1.103-.392.515H1.19l1.087-1.618zm8.1-13.656-4.953 6.9L8.75 12.57l4.247-7.574c.175-.25-.188-.647-1.092-1.192-.903-.546-1.412-.652-1.528-.32zM8.244 18.5 9.59 17h9.406v1.5H8.245z"/></svg>':'<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path class="ck-icon__fill" d="M10.126 2.268 2.002 13.874l1.895 1.852 2.521 1.402L14.47 5.481l-1.543-2.568-2.801-.645z"/><path d="m4.5 18.088-2.645-1.852-.04-2.95-.006-.005.006-.008v-.025l.011.008L8.73 2.97c.165-.233.356-.417.567-.557l-1.212.308L4.604 7.9l-.83-.558 3.694-5.495 2.708-.69 1.65 1.145.046.018.85-1.216 2.16 1.512-.856 1.222c.828.967 1.144 2.141.432 3.158L7.55 17.286l.006.005-3.055.797H4.5zm-.634.166-1.976.516-.026-1.918 2.002 1.402zM9.968 3.817l-.006-.004-6.123 9.184 3.277 2.294 6.108-9.162.005.003c.317-.452-.16-1.332-1.064-1.966-.891-.624-1.865-.776-2.197-.349zM8.245 18.5 9.59 17h9.406v1.5H8.245z"/></svg>'}class d extends e.Plugin{static get requires(){return[n,h]}static get pluginName(){return"Highlight"}}})(),(window.CKEditor5=window.CKEditor5||{}).highlight=r})();
|
5
|
+
*/(()=>{var e={458:(e,t,i)=>{"use strict";i.d(t,{Z:()=>o});var r=i(609),n=i.n(r)()((function(e){return e[1]}));n.push([e.id,":root{--ck-highlight-marker-yellow:#fdfd77;--ck-highlight-marker-green:#62f962;--ck-highlight-marker-pink:#fc7899;--ck-highlight-marker-blue:#72ccfd;--ck-highlight-pen-red:#e71313;--ck-highlight-pen-green:#128a00}.ck-content .marker-yellow{background-color:var(--ck-highlight-marker-yellow)}.ck-content .marker-green{background-color:var(--ck-highlight-marker-green)}.ck-content .marker-pink{background-color:var(--ck-highlight-marker-pink)}.ck-content .marker-blue{background-color:var(--ck-highlight-marker-blue)}.ck-content .pen-red{background-color:transparent;color:var(--ck-highlight-pen-red)}.ck-content .pen-green{background-color:transparent;color:var(--ck-highlight-pen-green)}",""]);const o=n},609:e=>{"use strict";e.exports=function(e){var t=[];return t.toString=function(){return this.map((function(t){var i=e(t);return t[2]?"@media ".concat(t[2]," {").concat(i,"}"):i})).join("")},t.i=function(e,i,r){"string"==typeof e&&(e=[[null,e,""]]);var n={};if(r)for(var o=0;o<this.length;o++){var l=this[o][0];null!=l&&(n[l]=!0)}for(var a=0;a<e.length;a++){var c=[].concat(e[a]);r&&n[c[0]]||(i&&(c[2]?c[2]="".concat(i," and ").concat(c[2]):c[2]=i),t.push(c))}},t}},62:(e,t,i)=>{"use strict";var r,n=function(){return void 0===r&&(r=Boolean(window&&document&&document.all&&!window.atob)),r},o=function(){var e={};return function(t){if(void 0===e[t]){var i=document.querySelector(t);if(window.HTMLIFrameElement&&i instanceof window.HTMLIFrameElement)try{i=i.contentDocument.head}catch(e){i=null}e[t]=i}return e[t]}}(),l=[];function a(e){for(var t=-1,i=0;i<l.length;i++)if(l[i].identifier===e){t=i;break}return t}function c(e,t){for(var i={},r=[],n=0;n<e.length;n++){var o=e[n],c=t.base?o[0]+t.base:o[0],s=i[c]||0,h="".concat(c," ").concat(s);i[c]=s+1;var g=a(h),d={css:o[1],media:o[2],sourceMap:o[3]};-1!==g?(l[g].references++,l[g].updater(d)):l.push({identifier:h,updater:v(d,t),references:1}),r.push(h)}return r}function s(e){var t=document.createElement("style"),r=e.attributes||{};if(void 0===r.nonce){var n=i.nc;n&&(r.nonce=n)}if(Object.keys(r).forEach((function(e){t.setAttribute(e,r[e])})),"function"==typeof e.insert)e.insert(t);else{var l=o(e.insert||"head");if(!l)throw new Error("Couldn't find a style target. This probably means that the value for the 'insert' parameter is invalid.");l.appendChild(t)}return t}var h,g=(h=[],function(e,t){return h[e]=t,h.filter(Boolean).join("\n")});function d(e,t,i,r){var n=i?"":r.media?"@media ".concat(r.media," {").concat(r.css,"}"):r.css;if(e.styleSheet)e.styleSheet.cssText=g(t,n);else{var o=document.createTextNode(n),l=e.childNodes;l[t]&&e.removeChild(l[t]),l.length?e.insertBefore(o,l[t]):e.appendChild(o)}}function u(e,t,i){var r=i.css,n=i.media,o=i.sourceMap;if(n?e.setAttribute("media",n):e.removeAttribute("media"),o&&"undefined"!=typeof btoa&&(r+="\n/*# sourceMappingURL=data:application/json;base64,".concat(btoa(unescape(encodeURIComponent(JSON.stringify(o))))," */")),e.styleSheet)e.styleSheet.cssText=r;else{for(;e.firstChild;)e.removeChild(e.firstChild);e.appendChild(document.createTextNode(r))}}var m=null,p=0;function v(e,t){var i,r,n;if(t.singleton){var o=p++;i=m||(m=s(t)),r=d.bind(null,i,o,!1),n=d.bind(null,i,o,!0)}else i=s(t),r=u.bind(null,i,t),n=function(){!function(e){if(null===e.parentNode)return!1;e.parentNode.removeChild(e)}(i)};return r(e),function(t){if(t){if(t.css===e.css&&t.media===e.media&&t.sourceMap===e.sourceMap)return;r(e=t)}else n()}}e.exports=function(e,t){(t=t||{}).singleton||"boolean"==typeof t.singleton||(t.singleton=n());var i=c(e=e||[],t);return function(e){if(e=e||[],"[object Array]"===Object.prototype.toString.call(e)){for(var r=0;r<i.length;r++){var n=a(i[r]);l[n].references--}for(var o=c(e,t),s=0;s<i.length;s++){var h=a(i[s]);0===l[h].references&&(l[h].updater(),l.splice(h,1))}i=o}}}},704:(e,t,i)=>{e.exports=i(79)("./src/core.js")},273:(e,t,i)=>{e.exports=i(79)("./src/ui.js")},79:e=>{"use strict";e.exports=CKEditor5.dll}},t={};function i(r){var n=t[r];if(void 0!==n)return n.exports;var o=t[r]={id:r,exports:{}};return e[r](o,o.exports,i),o.exports}i.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return i.d(t,{a:t}),t},i.d=(e,t)=>{for(var r in t)i.o(t,r)&&!i.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},i.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),i.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},i.nc=void 0;var r={};(()=>{"use strict";i.r(r),i.d(r,{Highlight:()=>d,HighlightEditing:()=>n,HighlightUI:()=>h});var e=i(704);class t extends e.Command{refresh(){const e=this.editor.model,t=e.document;this.value=t.selection.getAttribute("highlight"),this.isEnabled=e.schema.checkAttributeInSelection(t.selection,"highlight")}execute(e={}){const t=this.editor.model,i=t.document.selection,r=e.value;t.change((e=>{if(i.isCollapsed){const t=i.getFirstPosition();if(i.hasAttribute("highlight")){const i=e=>e.item.hasAttribute("highlight")&&e.item.getAttribute("highlight")===this.value,n=t.getLastMatchingPosition(i,{direction:"backward"}),o=t.getLastMatchingPosition(i),l=e.createRange(n,o);r&&this.value!==r?(t.isEqual(o)||e.setAttribute("highlight",r,l),e.setSelectionAttribute("highlight",r)):(t.isEqual(o)||e.removeAttribute("highlight",l),e.removeSelectionAttribute("highlight"))}else r&&e.setSelectionAttribute("highlight",r)}else{const n=t.schema.getValidRanges(i.getRanges(),"highlight");for(const t of n)r?e.setAttribute("highlight",r,t):e.removeAttribute("highlight",t)}}))}}class n extends e.Plugin{static get pluginName(){return"HighlightEditing"}constructor(e){super(e),e.config.define("highlight",{options:[{model:"yellowMarker",class:"marker-yellow",title:"Yellow marker",color:"var(--ck-highlight-marker-yellow)",type:"marker"},{model:"greenMarker",class:"marker-green",title:"Green marker",color:"var(--ck-highlight-marker-green)",type:"marker"},{model:"pinkMarker",class:"marker-pink",title:"Pink marker",color:"var(--ck-highlight-marker-pink)",type:"marker"},{model:"blueMarker",class:"marker-blue",title:"Blue marker",color:"var(--ck-highlight-marker-blue)",type:"marker"},{model:"redPen",class:"pen-red",title:"Red pen",color:"var(--ck-highlight-pen-red)",type:"pen"},{model:"greenPen",class:"pen-green",title:"Green pen",color:"var(--ck-highlight-pen-green)",type:"pen"}]})}init(){const e=this.editor;e.model.schema.extend("$text",{allowAttributes:"highlight"});const i=e.config.get("highlight.options");e.conversion.attributeToElement(function(e){const t={model:{key:"highlight",values:[]},view:{}};for(const i of e)t.model.values.push(i.model),t.view[i.model]={name:"mark",classes:i.class};return t}(i)),e.commands.add("highlight",new t(e))}}var o=i(273);var l=i(62),a=i.n(l),c=i(458),s={injectType:"singletonStyleTag",attributes:{"data-cke":!0},insert:"head",singleton:!0};a()(c.Z,s);c.Z.locals;class h extends e.Plugin{get localizedOptionTitles(){const e=this.editor.t;return{"Yellow marker":e("Yellow marker"),"Green marker":e("Green marker"),"Pink marker":e("Pink marker"),"Blue marker":e("Blue marker"),"Red pen":e("Red pen"),"Green pen":e("Green pen")}}static get pluginName(){return"HighlightUI"}init(){const e=this.editor.config.get("highlight.options");for(const t of e)this._addHighlighterButton(t);this._addRemoveHighlightButton(),this._addDropdown(e)}_addRemoveHighlightButton(){const t=this.editor.t,i=this.editor.commands.get("highlight");this._addButton("removeHighlight",t("Remove highlight"),e.icons.eraser,null,(e=>{e.bind("isEnabled").to(i,"isEnabled")}))}_addHighlighterButton(e){const t=this.editor.commands.get("highlight");this._addButton("highlight:"+e.model,e.title,g(e.type),e.model,(function(i){i.bind("isEnabled").to(t,"isEnabled"),i.bind("isOn").to(t,"value",(t=>t===e.model)),i.iconView.fillColor=e.color,i.isToggleable=!0}))}_addButton(e,t,i,r,n){const l=this.editor;l.ui.componentFactory.add(e,(e=>{const a=new o.ButtonView(e),c=this.localizedOptionTitles[t]?this.localizedOptionTitles[t]:t;return a.set({label:c,icon:i,tooltip:!0}),a.on("execute",(()=>{l.execute("highlight",{value:r}),l.editing.view.focus()})),n(a),a}))}_addDropdown(e){const t=this.editor,i=t.t,r=t.ui.componentFactory,n=e[0],l=e.reduce(((e,t)=>(e[t.model]=t,e)),{});r.add("highlight",(a=>{const c=t.commands.get("highlight"),s=(0,o.createDropdown)(a,o.SplitButtonView),h=s.buttonView;h.set({label:i("Highlight"),tooltip:!0,lastExecuted:n.model,commandValue:n.model,isToggleable:!0}),h.bind("icon").to(c,"value",(e=>g(d(e,"type")))),h.bind("color").to(c,"value",(e=>d(e,"color"))),h.bind("commandValue").to(c,"value",(e=>d(e,"model"))),h.bind("isOn").to(c,"value",(e=>!!e)),h.delegate("execute").to(s);function d(e,t){const i=e&&e!==h.lastExecuted?e:h.lastExecuted;return l[i][t]}return s.bind("isEnabled").to(c,"isEnabled"),(0,o.addToolbarToDropdown)(s,(()=>{const t=e.map((e=>{const t=r.create("highlight:"+e.model);return this.listenTo(t,"execute",(()=>{s.buttonView.set({lastExecuted:e.model})})),t}));return t.push(new o.ToolbarSeparatorView),t.push(r.create("removeHighlight")),t}),{enableActiveItemFocusOnDropdownOpen:!0,ariaLabel:i("Text highlight toolbar")}),function(e){const t=e.buttonView.actionView;t.iconView.bind("fillColor").to(e.buttonView,"color")}(s),h.on("execute",(()=>{t.execute("highlight",{value:h.commandValue})})),this.listenTo(s,"execute",(()=>{t.editing.view.focus()})),s}))}}function g(e){return"marker"===e?'<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path class="ck-icon__fill" d="M10.798 1.59 3.002 12.875l1.895 1.852 2.521 1.402 6.997-12.194z"/><path d="m2.556 16.727.234-.348c-.297-.151-.462-.293-.498-.426-.036-.137.002-.416.115-.837.094-.25.15-.449.169-.595a4.495 4.495 0 0 0 0-.725c-.209-.621-.303-1.041-.284-1.26.02-.218.178-.506.475-.862l6.77-9.414c.539-.91 1.605-.85 3.199.18 1.594 1.032 2.188 1.928 1.784 2.686l-5.877 10.36c-.158.412-.333.673-.526.782-.193.108-.604.179-1.232.21-.362.131-.608.237-.738.318-.13.081-.305.238-.526.47-.293.265-.504.397-.632.397-.096 0-.27-.075-.524-.226l-.31.41-1.6-1.12zm-.279.415 1.575 1.103-.392.515H1.19l1.087-1.618zm8.1-13.656-4.953 6.9L8.75 12.57l4.247-7.574c.175-.25-.188-.647-1.092-1.192-.903-.546-1.412-.652-1.528-.32zM8.244 18.5 9.59 17h9.406v1.5H8.245z"/></svg>':'<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path class="ck-icon__fill" d="M10.126 2.268 2.002 13.874l1.895 1.852 2.521 1.402L14.47 5.481l-1.543-2.568-2.801-.645z"/><path d="m4.5 18.088-2.645-1.852-.04-2.95-.006-.005.006-.008v-.025l.011.008L8.73 2.97c.165-.233.356-.417.567-.557l-1.212.308L4.604 7.9l-.83-.558 3.694-5.495 2.708-.69 1.65 1.145.046.018.85-1.216 2.16 1.512-.856 1.222c.828.967 1.144 2.141.432 3.158L7.55 17.286l.006.005-3.055.797H4.5zm-.634.166-1.976.516-.026-1.918 2.002 1.402zM9.968 3.817l-.006-.004-6.123 9.184 3.277 2.294 6.108-9.162.005.003c.317-.452-.16-1.332-1.064-1.966-.891-.624-1.865-.776-2.197-.349zM8.245 18.5 9.59 17h9.406v1.5H8.245z"/></svg>'}class d extends e.Plugin{static get requires(){return[n,h]}static get pluginName(){return"Highlight"}}})(),(window.CKEditor5=window.CKEditor5||{}).highlight=r})();
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@ckeditor/ckeditor5-highlight",
|
3
|
-
"version": "
|
3
|
+
"version": "36.0.0",
|
4
4
|
"description": "Highlight feature for CKEditor 5.",
|
5
5
|
"keywords": [
|
6
6
|
"ckeditor",
|
@@ -12,22 +12,23 @@
|
|
12
12
|
],
|
13
13
|
"main": "src/index.js",
|
14
14
|
"dependencies": {
|
15
|
-
"ckeditor5": "^
|
15
|
+
"ckeditor5": "^36.0.0"
|
16
16
|
},
|
17
17
|
"devDependencies": {
|
18
|
-
"@ckeditor/ckeditor5-block-quote": "^
|
19
|
-
"@ckeditor/ckeditor5-core": "^
|
20
|
-
"@ckeditor/ckeditor5-dev-utils": "^
|
21
|
-
"@ckeditor/ckeditor5-editor-classic": "^
|
22
|
-
"@ckeditor/ckeditor5-engine": "^
|
23
|
-
"@ckeditor/ckeditor5-enter": "^
|
24
|
-
"@ckeditor/ckeditor5-heading": "^
|
25
|
-
"@ckeditor/ckeditor5-image": "^
|
26
|
-
"@ckeditor/ckeditor5-list": "^
|
27
|
-
"@ckeditor/ckeditor5-paragraph": "^
|
28
|
-
"@ckeditor/ckeditor5-theme-lark": "^
|
29
|
-
"@ckeditor/ckeditor5-typing": "^
|
30
|
-
"@ckeditor/ckeditor5-utils": "^
|
18
|
+
"@ckeditor/ckeditor5-block-quote": "^36.0.0",
|
19
|
+
"@ckeditor/ckeditor5-core": "^36.0.0",
|
20
|
+
"@ckeditor/ckeditor5-dev-utils": "^32.0.0",
|
21
|
+
"@ckeditor/ckeditor5-editor-classic": "^36.0.0",
|
22
|
+
"@ckeditor/ckeditor5-engine": "^36.0.0",
|
23
|
+
"@ckeditor/ckeditor5-enter": "^36.0.0",
|
24
|
+
"@ckeditor/ckeditor5-heading": "^36.0.0",
|
25
|
+
"@ckeditor/ckeditor5-image": "^36.0.0",
|
26
|
+
"@ckeditor/ckeditor5-list": "^36.0.0",
|
27
|
+
"@ckeditor/ckeditor5-paragraph": "^36.0.0",
|
28
|
+
"@ckeditor/ckeditor5-theme-lark": "^36.0.0",
|
29
|
+
"@ckeditor/ckeditor5-typing": "^36.0.0",
|
30
|
+
"@ckeditor/ckeditor5-utils": "^36.0.0",
|
31
|
+
"typescript": "^4.8.4",
|
31
32
|
"webpack": "^5.58.1",
|
32
33
|
"webpack-cli": "^4.9.0"
|
33
34
|
},
|
@@ -47,12 +48,16 @@
|
|
47
48
|
"files": [
|
48
49
|
"lang",
|
49
50
|
"src",
|
51
|
+
"src/**/*.js",
|
52
|
+
"src/**/*.d.ts",
|
50
53
|
"theme",
|
51
54
|
"build",
|
52
55
|
"ckeditor5-metadata.json",
|
53
56
|
"CHANGELOG.md"
|
54
57
|
],
|
55
58
|
"scripts": {
|
56
|
-
"dll:build": "webpack"
|
59
|
+
"dll:build": "webpack",
|
60
|
+
"build": "tsc -p ./tsconfig.release.json",
|
61
|
+
"postversion": "npm run build"
|
57
62
|
}
|
58
63
|
}
|
package/src/highlight.js
CHANGED
@@ -1,17 +1,13 @@
|
|
1
1
|
/**
|
2
|
-
* @license Copyright (c) 2003-
|
2
|
+
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
|
3
3
|
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
4
4
|
*/
|
5
|
-
|
6
5
|
/**
|
7
6
|
* @module highlight/highlight
|
8
7
|
*/
|
9
|
-
|
10
8
|
import { Plugin } from 'ckeditor5/src/core';
|
11
|
-
|
12
9
|
import HighlightEditing from './highlightediting';
|
13
10
|
import HighlightUI from './highlightui';
|
14
|
-
|
15
11
|
/**
|
16
12
|
* The highlight plugin.
|
17
13
|
*
|
@@ -19,175 +15,18 @@ import HighlightUI from './highlightui';
|
|
19
15
|
*
|
20
16
|
* This is a "glue" plugin which loads the {@link module:highlight/highlightediting~HighlightEditing} and
|
21
17
|
* {@link module:highlight/highlightui~HighlightUI} plugins.
|
22
|
-
*
|
23
|
-
* @extends module:core/plugin~Plugin
|
24
18
|
*/
|
25
19
|
export default class Highlight extends Plugin {
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
}
|
20
|
+
/**
|
21
|
+
* @inheritDoc
|
22
|
+
*/
|
23
|
+
static get requires() {
|
24
|
+
return [HighlightEditing, HighlightUI];
|
25
|
+
}
|
26
|
+
/**
|
27
|
+
* @inheritDoc
|
28
|
+
*/
|
29
|
+
static get pluginName() {
|
30
|
+
return 'Highlight';
|
31
|
+
}
|
39
32
|
}
|
40
|
-
|
41
|
-
/**
|
42
|
-
* The highlight option descriptor. See {@link module:highlight/highlight~HighlightConfig} to learn more.
|
43
|
-
*
|
44
|
-
* {
|
45
|
-
* model: 'pinkMarker',
|
46
|
-
* class: 'marker-pink',
|
47
|
-
* title: 'Pink Marker',
|
48
|
-
* color: 'var(--ck-highlight-marker-pink)',
|
49
|
-
* type: 'marker'
|
50
|
-
* }
|
51
|
-
*
|
52
|
-
* @typedef {Object} module:highlight/highlight~HighlightOption
|
53
|
-
* @property {String} title The user-readable title of the option.
|
54
|
-
* @property {String} model The unique attribute value in the model.
|
55
|
-
* @property {String} color The CSS `var()` used for the highlighter. The color is used in the user interface to represent the highlighter.
|
56
|
-
* 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>`
|
57
|
-
* by adding CSS classes definition.
|
58
|
-
* @property {String} class The CSS class used on the `<mark>` element in the view. It should match the `color` setting.
|
59
|
-
* @property {'marker'|'pen'} type The type of highlighter:
|
60
|
-
*
|
61
|
-
* * `'marker'` – Uses the `color` as the `background-color` style,
|
62
|
-
* * `'pen'` – Uses the `color` as the font `color` style.
|
63
|
-
*/
|
64
|
-
|
65
|
-
/**
|
66
|
-
* The configuration of the {@link module:highlight/highlight~Highlight} feature.
|
67
|
-
*
|
68
|
-
* Read more in {@link module:highlight/highlight~HighlightConfig}.
|
69
|
-
*
|
70
|
-
* @member {module:highlight/highlight~HighlightConfig} module:core/editor/editorconfig~EditorConfig#highlight
|
71
|
-
*/
|
72
|
-
|
73
|
-
/**
|
74
|
-
* The configuration of the {@link module:highlight/highlight~Highlight highlight feature}.
|
75
|
-
*
|
76
|
-
* ClassicEditor
|
77
|
-
* .create( editorElement, {
|
78
|
-
* highlight: ... // Highlight feature configuration.
|
79
|
-
* } )
|
80
|
-
* .then( ... )
|
81
|
-
* .catch( ... );
|
82
|
-
*
|
83
|
-
* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
|
84
|
-
*
|
85
|
-
* @interface HighlightConfig
|
86
|
-
*/
|
87
|
-
|
88
|
-
/**
|
89
|
-
* The available highlight options. The default value is:
|
90
|
-
*
|
91
|
-
* options: [
|
92
|
-
* {
|
93
|
-
* model: 'yellowMarker',
|
94
|
-
* class: 'marker-yellow',
|
95
|
-
* title: 'Yellow marker',
|
96
|
-
* color: 'var(--ck-highlight-marker-yellow)',
|
97
|
-
* type: 'marker'
|
98
|
-
* },
|
99
|
-
* {
|
100
|
-
* model: 'greenMarker',
|
101
|
-
* class: 'marker-green',
|
102
|
-
* title: 'Green marker',
|
103
|
-
* color: 'var(--ck-highlight-marker-green)',
|
104
|
-
* type: 'marker'
|
105
|
-
* },
|
106
|
-
* {
|
107
|
-
* model: 'pinkMarker',
|
108
|
-
* class: 'marker-pink',
|
109
|
-
* title: 'Pink marker',
|
110
|
-
* color: 'var(--ck-highlight-marker-pink)',
|
111
|
-
* type: 'marker'
|
112
|
-
* },
|
113
|
-
* {
|
114
|
-
* model: 'blueMarker',
|
115
|
-
* class: 'marker-blue',
|
116
|
-
* title: 'Blue marker',
|
117
|
-
* color: 'var(--ck-highlight-marker-blue)',
|
118
|
-
* type: 'marker'
|
119
|
-
* },
|
120
|
-
* {
|
121
|
-
* model: 'redPen',
|
122
|
-
* class: 'pen-red',
|
123
|
-
* title: 'Red pen',
|
124
|
-
* color: 'var(--ck-highlight-pen-red)',
|
125
|
-
* type: 'pen'
|
126
|
-
* },
|
127
|
-
* {
|
128
|
-
* model: 'greenPen',
|
129
|
-
* class: 'pen-green',
|
130
|
-
* title: 'Green pen',
|
131
|
-
* color: 'var(--ck-highlight-pen-green)',
|
132
|
-
* type: 'pen'
|
133
|
-
* }
|
134
|
-
* ]
|
135
|
-
*
|
136
|
-
* There are two types of highlighters available:
|
137
|
-
*
|
138
|
-
* * `'marker'` – Rendered as a `<mark>` element, styled with the `background-color`.
|
139
|
-
* * `'pen'` – Rendered as a `<mark>` element, styled with the font `color`.
|
140
|
-
*
|
141
|
-
* **Note**: The highlight feature provides a stylesheet with the CSS classes and corresponding colors defined
|
142
|
-
* as CSS variables.
|
143
|
-
*
|
144
|
-
* :root {
|
145
|
-
* --ck-highlight-marker-yellow: #fdfd77;
|
146
|
-
* --ck-highlight-marker-green: #63f963;
|
147
|
-
* --ck-highlight-marker-pink: #fc7999;
|
148
|
-
* --ck-highlight-marker-blue: #72cdfd;
|
149
|
-
* --ck-highlight-pen-red: #e91313;
|
150
|
-
* --ck-highlight-pen-green: #118800;
|
151
|
-
* }
|
152
|
-
*
|
153
|
-
* .marker-yellow { ... }
|
154
|
-
* .marker-green { ... }
|
155
|
-
* .marker-pink { ... }
|
156
|
-
* .marker-blue { ... }
|
157
|
-
* .pen-red { ... }
|
158
|
-
* .pen-green { ... }
|
159
|
-
*
|
160
|
-
* It is possible to define the `color` property directly as `rgba(R, G, B, A)`,
|
161
|
-
* `#RRGGBB[AA]` or `hsla(H, S, L, A)`. In such situation, the color will **only** apply to the UI of
|
162
|
-
* the editor and the `<mark>` elements in the content must be styled by custom classes provided by
|
163
|
-
* a dedicated stylesheet.
|
164
|
-
*
|
165
|
-
* **Note**: It is recommended for the `color` property to correspond to the class in the content
|
166
|
-
* stylesheet because it represents the highlighter in the user interface of the editor.
|
167
|
-
*
|
168
|
-
* ClassicEditor
|
169
|
-
* .create( editorElement, {
|
170
|
-
* highlight: {
|
171
|
-
* options: [
|
172
|
-
* {
|
173
|
-
* model: 'pinkMarker',
|
174
|
-
* class: 'marker-pink',
|
175
|
-
* title: 'Pink Marker',
|
176
|
-
* color: 'var(--ck-highlight-marker-pink)',
|
177
|
-
* type: 'marker'
|
178
|
-
* },
|
179
|
-
* {
|
180
|
-
* model: 'redPen',
|
181
|
-
* class: 'pen-red',
|
182
|
-
* title: 'Red Pen',
|
183
|
-
* color: 'var(--ck-highlight-pen-red)',
|
184
|
-
* type: 'pen'
|
185
|
-
* },
|
186
|
-
* ]
|
187
|
-
* }
|
188
|
-
* } )
|
189
|
-
* .then( ... )
|
190
|
-
* .catch( ... );
|
191
|
-
*
|
192
|
-
* @member {Array.<module:highlight/highlight~HighlightOption>} module:highlight/highlight~HighlightConfig#options
|
193
|
-
*/
|
package/src/highlight.ts
ADDED
@@ -0,0 +1,225 @@
|
|
1
|
+
/**
|
2
|
+
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
4
|
+
*/
|
5
|
+
|
6
|
+
/**
|
7
|
+
* @module highlight/highlight
|
8
|
+
*/
|
9
|
+
|
10
|
+
import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
|
11
|
+
|
12
|
+
import HighlightEditing from './highlightediting';
|
13
|
+
import HighlightUI from './highlightui';
|
14
|
+
|
15
|
+
/**
|
16
|
+
* The highlight plugin.
|
17
|
+
*
|
18
|
+
* For a detailed overview, check the {@glink features/highlight Highlight feature} documentation.
|
19
|
+
*
|
20
|
+
* This is a "glue" plugin which loads the {@link module:highlight/highlightediting~HighlightEditing} and
|
21
|
+
* {@link module:highlight/highlightui~HighlightUI} plugins.
|
22
|
+
*/
|
23
|
+
export default class Highlight extends Plugin {
|
24
|
+
/**
|
25
|
+
* @inheritDoc
|
26
|
+
*/
|
27
|
+
public static get requires(): PluginDependencies {
|
28
|
+
return [ HighlightEditing, HighlightUI ];
|
29
|
+
}
|
30
|
+
|
31
|
+
/**
|
32
|
+
* @inheritDoc
|
33
|
+
*/
|
34
|
+
public static get pluginName(): 'Highlight' {
|
35
|
+
return 'Highlight';
|
36
|
+
}
|
37
|
+
}
|
38
|
+
|
39
|
+
/**
|
40
|
+
* The highlight option descriptor. See {@link module:highlight/highlight~HighlightConfig} to learn more.
|
41
|
+
*
|
42
|
+
* ```ts
|
43
|
+
* {
|
44
|
+
* model: 'pinkMarker',
|
45
|
+
* class: 'marker-pink',
|
46
|
+
* title: 'Pink Marker',
|
47
|
+
* color: 'var(--ck-highlight-marker-pink)',
|
48
|
+
* type: 'marker'
|
49
|
+
* }
|
50
|
+
* ```
|
51
|
+
*/
|
52
|
+
export interface HighlightOption {
|
53
|
+
|
54
|
+
/**
|
55
|
+
* The user-readable title of the option.
|
56
|
+
*/
|
57
|
+
title: string;
|
58
|
+
|
59
|
+
/**
|
60
|
+
* The unique attribute value in the model.
|
61
|
+
*/
|
62
|
+
model: string;
|
63
|
+
|
64
|
+
/**
|
65
|
+
* The CSS `var()` used for the highlighter. The color is used in the user interface to represent the highlighter.
|
66
|
+
* 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>`
|
67
|
+
* by adding CSS classes definition.
|
68
|
+
*/
|
69
|
+
color: string;
|
70
|
+
|
71
|
+
/**
|
72
|
+
* The CSS class used on the `<mark>` element in the view. It should match the `color` setting.
|
73
|
+
*/
|
74
|
+
class: string;
|
75
|
+
|
76
|
+
/**
|
77
|
+
* The type of highlighter:
|
78
|
+
*
|
79
|
+
* * `'marker'` – Uses the `color` as the `background-color` style,
|
80
|
+
* * `'pen'` – Uses the `color` as the font `color` style.
|
81
|
+
*/
|
82
|
+
type: 'marker' | 'pen';
|
83
|
+
}
|
84
|
+
|
85
|
+
/**
|
86
|
+
* The configuration of the {@link module:highlight/highlight~Highlight highlight feature}.
|
87
|
+
* ```ts
|
88
|
+
* ClassicEditor
|
89
|
+
* .create( editorElement, {
|
90
|
+
* highlight: ... // Highlight feature configuration.
|
91
|
+
* } )
|
92
|
+
* .then( ... )
|
93
|
+
* .catch( ... );
|
94
|
+
* ```
|
95
|
+
* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
|
96
|
+
*/
|
97
|
+
export interface HighlightConfig {
|
98
|
+
|
99
|
+
/**
|
100
|
+
* The available highlight options. The default value is:
|
101
|
+
* ```ts
|
102
|
+
* options: [
|
103
|
+
* {
|
104
|
+
* model: 'yellowMarker',
|
105
|
+
* class: 'marker-yellow',
|
106
|
+
* title: 'Yellow marker',
|
107
|
+
* color: 'var(--ck-highlight-marker-yellow)',
|
108
|
+
* type: 'marker'
|
109
|
+
* },
|
110
|
+
* {
|
111
|
+
* model: 'greenMarker',
|
112
|
+
* class: 'marker-green',
|
113
|
+
* title: 'Green marker',
|
114
|
+
* color: 'var(--ck-highlight-marker-green)',
|
115
|
+
* type: 'marker'
|
116
|
+
* },
|
117
|
+
* {
|
118
|
+
* model: 'pinkMarker',
|
119
|
+
* class: 'marker-pink',
|
120
|
+
* title: 'Pink marker',
|
121
|
+
* color: 'var(--ck-highlight-marker-pink)',
|
122
|
+
* type: 'marker'
|
123
|
+
* },
|
124
|
+
* {
|
125
|
+
* model: 'blueMarker',
|
126
|
+
* class: 'marker-blue',
|
127
|
+
* title: 'Blue marker',
|
128
|
+
* color: 'var(--ck-highlight-marker-blue)',
|
129
|
+
* type: 'marker'
|
130
|
+
* },
|
131
|
+
* {
|
132
|
+
* model: 'redPen',
|
133
|
+
* class: 'pen-red',
|
134
|
+
* title: 'Red pen',
|
135
|
+
* color: 'var(--ck-highlight-pen-red)',
|
136
|
+
* type: 'pen'
|
137
|
+
* },
|
138
|
+
* {
|
139
|
+
* model: 'greenPen',
|
140
|
+
* class: 'pen-green',
|
141
|
+
* title: 'Green pen',
|
142
|
+
* color: 'var(--ck-highlight-pen-green)',
|
143
|
+
* type: 'pen'
|
144
|
+
* }
|
145
|
+
* ]
|
146
|
+
* ```
|
147
|
+
*
|
148
|
+
* There are two types of highlighters available:
|
149
|
+
*
|
150
|
+
* * `'marker'` – Rendered as a `<mark>` element, styled with the `background-color`.
|
151
|
+
* * `'pen'` – Rendered as a `<mark>` element, styled with the font `color`.
|
152
|
+
*
|
153
|
+
* **Note**: The highlight feature provides a stylesheet with the CSS classes and corresponding colors defined
|
154
|
+
* as CSS variables.
|
155
|
+
*
|
156
|
+
* ```ts
|
157
|
+
* :root {
|
158
|
+
* --ck-highlight-marker-yellow: #fdfd77;
|
159
|
+
* --ck-highlight-marker-green: #63f963;
|
160
|
+
* --ck-highlight-marker-pink: #fc7999;
|
161
|
+
* --ck-highlight-marker-blue: #72cdfd;
|
162
|
+
* --ck-highlight-pen-red: #e91313;
|
163
|
+
* --ck-highlight-pen-green: #118800;
|
164
|
+
* }
|
165
|
+
*
|
166
|
+
* .marker-yellow { ... }
|
167
|
+
* .marker-green { ... }
|
168
|
+
* .marker-pink { ... }
|
169
|
+
* .marker-blue { ... }
|
170
|
+
* .pen-red { ... }
|
171
|
+
* .pen-green { ... }
|
172
|
+
* ```
|
173
|
+
*
|
174
|
+
* It is possible to define the `color` property directly as `rgba(R, G, B, A)`,
|
175
|
+
* `#RRGGBB[AA]` or `hsla(H, S, L, A)`. In such situation, the color will **only** apply to the UI of
|
176
|
+
* the editor and the `<mark>` elements in the content must be styled by custom classes provided by
|
177
|
+
* a dedicated stylesheet.
|
178
|
+
*
|
179
|
+
* **Note**: It is recommended for the `color` property to correspond to the class in the content
|
180
|
+
* stylesheet because it represents the highlighter in the user interface of the editor.
|
181
|
+
*
|
182
|
+
* ```ts
|
183
|
+
* ClassicEditor
|
184
|
+
* .create( editorElement, {
|
185
|
+
* highlight: {
|
186
|
+
* options: [
|
187
|
+
* {
|
188
|
+
* model: 'pinkMarker',
|
189
|
+
* class: 'marker-pink',
|
190
|
+
* title: 'Pink Marker',
|
191
|
+
* color: 'var(--ck-highlight-marker-pink)',
|
192
|
+
* type: 'marker'
|
193
|
+
* },
|
194
|
+
* {
|
195
|
+
* model: 'redPen',
|
196
|
+
* class: 'pen-red',
|
197
|
+
* title: 'Red Pen',
|
198
|
+
* color: 'var(--ck-highlight-pen-red)',
|
199
|
+
* type: 'pen'
|
200
|
+
* },
|
201
|
+
* ]
|
202
|
+
* }
|
203
|
+
* } )
|
204
|
+
* .then( ... )
|
205
|
+
* .catch( ... );
|
206
|
+
* ```
|
207
|
+
*/
|
208
|
+
options: Array<HighlightOption>;
|
209
|
+
}
|
210
|
+
|
211
|
+
declare module '@ckeditor/ckeditor5-core' {
|
212
|
+
interface PluginsMap {
|
213
|
+
[ Highlight.pluginName ]: Highlight;
|
214
|
+
}
|
215
|
+
|
216
|
+
interface EditorConfig {
|
217
|
+
|
218
|
+
/**
|
219
|
+
* The configuration of the {@link module:highlight/highlight~Highlight} feature.
|
220
|
+
*
|
221
|
+
* Read more in {@link module:highlight/highlight~HighlightConfig}.
|
222
|
+
*/
|
223
|
+
highlight?: HighlightConfig;
|
224
|
+
}
|
225
|
+
}
|