@ckeditor/ckeditor5-editor-decoupled 38.1.0 → 38.1.1
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/build/editor-decoupled.js.map +1 -0
- package/package.json +2 -2
- package/src/decouplededitor.d.ts +215 -215
- package/src/decouplededitor.js +265 -265
- package/src/decouplededitorui.d.ts +42 -42
- package/src/decouplededitorui.js +98 -98
- package/src/decouplededitoruiview.d.ts +49 -49
- package/src/decouplededitoruiview.js +63 -63
- package/src/index.d.ts +8 -8
- package/src/index.js +8 -8
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"editor-decoupled.js","mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEgG;AACnB;;AAEvC;;AAEc;AACQ;;AAE5D;AACA,QAAQ,wFAAwF;AAChG;AACA;AACA;AACA;AACA;AACA;AACA,4BAA4B,6CAA6C;AACzE;AACA;AACA;AACA,IAAI,iGAAiG;AACrG;AACA;AACA;AACA;AACA;AACA;AACA,IAAI,4FAA4F;AAChG;AACA,IAAI;AACJ;AACA;AACA,iBAAiB,6EAA6E;AAC9F;AACA;AACA;AACA,IAAI,gGAAgG;AACpG;AACA;AACA;AACA;AACA;AACA;AACe,8BAA8B,sDAAM;AACnD;AACA;AACA;AACA;AACA,KAAK,iGAAiG;AACtG;AACA;AACA,YAAY,oBAAoB;AAChC;AACA,KAAK,wFAAwF;AAC7F,YAAY,8CAA8C;AAC1D;AACA,+CAA+C;AAC/C;AACA,QAAQ,qDAAS;AACjB;AACA;AACA,aAAa,8DAAa;AAC1B;;AAEA;;AAEA;AACA;AACA;;AAEA,OAAO,qDAAS;AAChB;AACA,GAAG,uEAAmB;AACtB;;AAEA;;AAEA;AACA,mBAAmB,8DAAqB;AACxC;AACA;AACA,IAAI;;AAEJ,gBAAgB,0DAAiB;AACjC;;AAEA;AACA;AACA;AACA;AACA,KAAK;AACL;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,QAAQ;AACR;AACA,cAAc;AACd;AACA;AACA;AACA;AACA;;AAEA;;AAEA;AACA;AACA;AACA;AACA;AACA,KAAK;AACL;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,QAAQ;AACR;AACA;AACA,QAAQ;AACR;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,QAAQ;AACR;AACA;AACA,QAAQ;AACR;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,QAAQ;AACR;AACA;AACA;AACA;AACA;AACA,QAAQ;AACR;AACA;AACA,QAAQ;AACR;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,aAAa,uFAAuF;AACpG;AACA;AACA;AACA;AACA;AACA,KAAK;AACL;AACA;AACA;AACA;AACA,KAAK,sFAAsF;AAC3F,KAAK,yEAAyE;AAC9E,mBAAmB,wFAAwF;AAC3G;AACA,YAAY,oBAAoB;AAChC;AACA;AACA;AACA;AACA,KAAK;AACL;AACA;AACA;AACA;AACA,KAAK,sHAAsH;AAC3H;AACA,YAAY,8CAA8C;AAC1D,cAAc,SAAS;AACvB;AACA,iDAAiD;AACjD;AACA,QAAQ,qDAAS;AACjB;AACA;AACA,cAAc,8DAAa;AAC3B;;AAEA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,IAAI;AACJ;AACA;;AAEA,wDAAG,mBAAmB,+DAAe;AACrC,wDAAG,mBAAmB,4DAAY;;AAElC;AACA,QAAQ,qDAAS,0BAA0B,uEAAkB;AAC7D;;;;;;;;;;;;;;;;;;ACvQA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAE8C;AACW;;AAEzD;AACA;AACA;AACA;AACA;AACe,gCAAgC,wDAAQ;AACvD;AACA;AACA;AACA,YAAY,kCAAkC;AAC9C,YAAY,8CAA8C;AAC1D;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA,cAAc,8CAA8C;AAC5D;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;;AAEA;AACA,GAAG,uEAAiB;AACpB;AACA;AACA;AACA;AACA;AACA,KAAK;AACL;AACA;AACA;;;;;;;;;;;;;;;;;ACnIA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEmF;;AAEnF;AACA;AACA,IAAI,oFAAoF;AACxF,IAAI,kFAAkF;AACtF;AACA;AACA,QAAQ;AACR;AACA;AACA;AACA;AACe,oCAAoC,0DAAY;AAC/D;AACA;AACA;AACA,YAAY,4BAA4B,YAAY,+CAA+C;AACnG,YAAY,8BAA8B;AAC1C,YAAY,QAAQ,WAAW;AAC/B,YAAY,aAAa;AACzB,KAAK,yDAAyD;AAC9D,YAAY,SAAS;AACrB,iBAAiB,0FAA0F;AAC3G,SAAS,wEAAwE;AACjF;AACA,gDAAgD;AAChD;;AAEA;;AAEA;AACA;AACA;AACA;AACA,cAAc;AACd;AACA,qBAAqB,yDAAW;AAChC;AACA,IAAI;;AAEJ;AACA;AACA;AACA;AACA,cAAc;AACd;AACA,sBAAsB,kEAAoB;AAC1C;AACA;AACA;AACA,IAAI;;AAEJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,IAAI;AACJ;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;;;;;;;;;;ACrFA;;;;;;;;;;ACAA;;;;;;;;;;ACAA;;;;;;;;;;ACAA;;;;;;;;;;;ACAA;;;;;;;;;;;;;;;;ACA8B;;AAE9B;AACA,aAAa,uDAAW;;AAExB,iEAAe,MAAM,EAAC;;;;;;;;;;;;;;;;;;;ACLY;AACM;AACU;;AAElD;AACA;AACA;;AAEA;AACA,qBAAqB,kDAAM,GAAG,8DAAkB;;AAEhD;AACA;AACA;AACA;AACA,WAAW,GAAG;AACd,aAAa,QAAQ;AACrB;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,yDAAS;AACf,MAAM,8DAAc;AACpB;;AAEA,iEAAe,UAAU,EAAC;;;;;;;;;;;;;;;;AC3B1B;AACA;;AAEA,iEAAe,UAAU,EAAC;;;;;;;;;;;;;;;;;ACHU;;AAEpC;AACA,mBAAmB,uDAAO;;AAE1B,iEAAe,YAAY,EAAC;;;;;;;;;;;;;;;;;ACLM;;AAElC;AACA;;AAEA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA,qBAAqB,kDAAM,GAAG,8DAAkB;;AAEhD;AACA;AACA;AACA;AACA,WAAW,GAAG;AACd,aAAa,QAAQ;AACrB;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA,IAAI;;AAEJ;AACA;AACA;AACA;AACA,MAAM;AACN;AACA;AACA;AACA;AACA;;AAEA,iEAAe,SAAS,EAAC;;;;;;;;;;;;;;;;AC7CzB;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA,WAAW,GAAG;AACd,aAAa,QAAQ;AACrB;AACA;AACA;AACA;;AAEA,iEAAe,cAAc,EAAC;;;;;;;;;;;;;;;;ACrB9B;AACA;AACA;AACA;AACA,WAAW,UAAU;AACrB,WAAW,UAAU;AACrB,aAAa,UAAU;AACvB;AACA;AACA;AACA;AACA;AACA;;AAEA,iEAAe,OAAO,EAAC;;;;;;;;;;;;;;;;;ACdmB;;AAE1C;AACA;;AAEA;AACA,WAAW,sDAAU;;AAErB,iEAAe,IAAI,EAAC;;;;;;;;;;;;;;;;;;ACRyB;AACE;;AAE/C;AACA;AACA;AACA;AACA;AACA;AACA;AACA,WAAW,GAAG;AACd,aAAa,SAAS;AACtB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS,4DAAY,oCAAoC,6DAAa;AACtE;;AAEA,iEAAe,SAAS,EAAC;;;;;;;;;;;;;;;;ACxBzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,WAAW,GAAG;AACd,aAAa,SAAS;AACtB;AACA;AACA,oBAAoB;AACpB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,iEAAe,YAAY,EAAC;;;;;;;;;;;;;;;;;;;AC5Bc;AACI;AACD;;AAE7C;AACA;;AAEA;AACA;AACA;;AAEA;AACA;;AAEA;AACA;;AAEA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,WAAW,GAAG;AACd,aAAa,SAAS;AACtB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,qBAAqB,gBAAgB;AACrC;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,4DAAY,WAAW,0DAAU;AACxC;AACA;AACA,cAAc,4DAAY;AAC1B;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,iEAAe,aAAa,EAAC;;;;;;;UC7D7B;UACA;;UAEA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;;UAEA;UACA;;UAEA;UACA;UACA;;;;;WCtBA;WACA;WACA;WACA;WACA,yCAAyC,wCAAwC;WACjF;WACA;WACA;;;;;WCPA;;;;;WCAA;WACA;WACA;WACA,uDAAuD,iBAAiB;WACxE;WACA,gDAAgD,aAAa;WAC7D;;;;;;;;;;;;;;;;ACNA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAE+D","sources":["webpack://CKEditor5.editorDecoupled/./src/decouplededitor.js","webpack://CKEditor5.editorDecoupled/./src/decouplededitorui.js","webpack://CKEditor5.editorDecoupled/./src/decouplededitoruiview.js","webpack://CKEditor5.editorDecoupled/delegated \"./src/core.js\" from dll-reference CKEditor5.dll","webpack://CKEditor5.editorDecoupled/delegated \"./src/engine.js\" from dll-reference CKEditor5.dll","webpack://CKEditor5.editorDecoupled/delegated \"./src/ui.js\" from dll-reference CKEditor5.dll","webpack://CKEditor5.editorDecoupled/delegated \"./src/utils.js\" from dll-reference CKEditor5.dll","webpack://CKEditor5.editorDecoupled/external var \"CKEditor5.dll\"","webpack://CKEditor5.editorDecoupled/../../node_modules/lodash-es/_Symbol.js","webpack://CKEditor5.editorDecoupled/../../node_modules/lodash-es/_baseGetTag.js","webpack://CKEditor5.editorDecoupled/../../node_modules/lodash-es/_freeGlobal.js","webpack://CKEditor5.editorDecoupled/../../node_modules/lodash-es/_getPrototype.js","webpack://CKEditor5.editorDecoupled/../../node_modules/lodash-es/_getRawTag.js","webpack://CKEditor5.editorDecoupled/../../node_modules/lodash-es/_objectToString.js","webpack://CKEditor5.editorDecoupled/../../node_modules/lodash-es/_overArg.js","webpack://CKEditor5.editorDecoupled/../../node_modules/lodash-es/_root.js","webpack://CKEditor5.editorDecoupled/../../node_modules/lodash-es/isElement.js","webpack://CKEditor5.editorDecoupled/../../node_modules/lodash-es/isObjectLike.js","webpack://CKEditor5.editorDecoupled/../../node_modules/lodash-es/isPlainObject.js","webpack://CKEditor5.editorDecoupled/webpack/bootstrap","webpack://CKEditor5.editorDecoupled/webpack/runtime/define property getters","webpack://CKEditor5.editorDecoupled/webpack/runtime/hasOwnProperty shorthand","webpack://CKEditor5.editorDecoupled/webpack/runtime/make namespace object","webpack://CKEditor5.editorDecoupled/./src/index.js"],"sourcesContent":["/**\n * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.\n * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license\n */\n\n/**\n * @module editor-decoupled/decouplededitor\n */\n\nimport { Editor, ElementApiMixin, DataApiMixin, secureSourceElement } from 'ckeditor5/src/core';\nimport { CKEditorError, getDataFromElement, mix } from 'ckeditor5/src/utils';\n\nimport { isElement } from 'lodash-es';\n\nimport DecoupledEditorUI from './decouplededitorui';\nimport DecoupledEditorUIView from './decouplededitoruiview';\n\n/**\n * The {@glink installation/getting-started/predefined-builds#document-editor decoupled editor} implementation.\n * It provides an inline editable and a toolbar. However, unlike other editors,\n * it does not render these components anywhere in the DOM unless configured.\n *\n * This type of an editor is dedicated to integrations which require a customized UI with an open\n * structure, allowing developers to specify the exact location of the interface.\n *\n * See the document editor {@glink examples/builds/document-editor demo} to learn about possible use cases\n * for the decoupled editor.\n *\n * In order to create a decoupled editor instance, use the static\n * {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`} method.\n *\n * # Decoupled editor and document editor build\n *\n * The decoupled editor can be used directly from source (if you installed the\n * [`@ckeditor/ckeditor5-editor-decoupled`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-decoupled) package)\n * but it is also available in the\n * {@glink installation/getting-started/predefined-builds#document-editor document editor build}.\n *\n * {@glink installation/getting-started/predefined-builds Builds}\n * are ready-to-use editors with plugins bundled in. When using the editor from\n * source you need to take care of loading all plugins by yourself\n * (through the {@link module:core/editor/editorconfig~EditorConfig#plugins `config.plugins`} option).\n * Using the editor from source gives much better flexibility and allows for easier customization.\n *\n * Read more about initializing the editor from source or as a build in\n * {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`}.\n *\n * @mixes module:core/editor/utils/dataapimixin~DataApiMixin\n * @mixes module:core/editor/utils/elementapimixin~ElementApiMixin\n * @implements module:core/editor/editorwithui~EditorWithUI\n * @extends module:core/editor/editor~Editor\n */\nexport default class DecoupledEditor extends Editor {\n\t/**\n\t * Creates an instance of the decoupled editor.\n\t *\n\t * **Note:** Do not use the constructor to create editor instances. Use the static\n\t * {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`} method instead.\n\t *\n\t * @protected\n\t * @param {HTMLElement|String} sourceElementOrData The DOM element that will be the source for the created editor\n\t * (on which the editor will be initialized) or initial data for the editor. For more information see\n\t * {@link module:editor-balloon/ballooneditor~BalloonEditor.create `BalloonEditor.create()`}.\n\t * @param {module:core/editor/editorconfig~EditorConfig} [config] The editor configuration.\n\t */\n\tconstructor( sourceElementOrData, config = {} ) {\n\t\t// If both `config.initialData` is set and initial data is passed as the constructor parameter, then throw.\n\t\tif ( !isElement( sourceElementOrData ) && config.initialData !== undefined ) {\n\t\t\t// Documented in core/editor/editorconfig.jsdoc.\n\t\t\t// eslint-disable-next-line ckeditor5-rules/ckeditor-error-message\n\t\t\tthrow new CKEditorError( 'editor-create-initial-data', null );\n\t\t}\n\n\t\tsuper( config );\n\n\t\tif ( this.config.get( 'initialData' ) === undefined ) {\n\t\t\tthis.config.set( 'initialData', getInitialData( sourceElementOrData ) );\n\t\t}\n\n\t\tif ( isElement( sourceElementOrData ) ) {\n\t\t\tthis.sourceElement = sourceElementOrData;\n\t\t\tsecureSourceElement( this );\n\t\t}\n\n\t\tthis.model.document.createRoot();\n\n\t\tconst shouldToolbarGroupWhenFull = !this.config.get( 'toolbar.shouldNotGroupWhenFull' );\n\t\tconst view = new DecoupledEditorUIView( this.locale, this.editing.view, {\n\t\t\teditableElement: this.sourceElement,\n\t\t\tshouldToolbarGroupWhenFull\n\t\t} );\n\n\t\tthis.ui = new DecoupledEditorUI( this, view );\n\t}\n\n\t/**\n\t * Destroys the editor instance, releasing all resources used by it.\n\t *\n\t * Updates the original editor element with the data if the\n\t * {@link module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy `updateSourceElementOnDestroy`}\n\t * configuration option is set to `true`.\n\t *\n\t * **Note**: The decoupled editor does not remove the toolbar and editable when destroyed. You can\n\t * do that yourself in the destruction chain:\n\t *\n\t *\t\teditor.destroy()\n\t *\t\t\t.then( () => {\n\t *\t\t\t\t// Remove the toolbar from DOM.\n\t *\t\t\t\teditor.ui.view.toolbar.element.remove();\n\t *\n\t *\t\t\t\t// Remove the editable from DOM.\n\t *\t\t\t\teditor.ui.view.editable.element.remove();\n\t *\n\t *\t\t\t\tconsole.log( 'Editor was destroyed' );\n\t *\t\t\t} );\n\t *\n\t * @returns {Promise}\n\t */\n\tdestroy() {\n\t\t// Cache the data, then destroy.\n\t\t// It's safe to assume that the model->view conversion will not work after super.destroy().\n\t\tconst data = this.getData();\n\n\t\tthis.ui.destroy();\n\n\t\treturn super.destroy()\n\t\t\t.then( () => {\n\t\t\t\tif ( this.sourceElement ) {\n\t\t\t\t\tthis.updateSourceElement( data );\n\t\t\t\t}\n\t\t\t} );\n\t}\n\n\t/**\n\t * Creates a new decoupled editor instance.\n\t *\n\t * Remember that `DecoupledEditor` does not append the toolbar element to your web page so you have to do it manually after the editor\n\t * has been initialized.\n\t *\n\t * There are two ways how the editor can be initialized.\n\t *\n\t * # Using an existing DOM element (and loading data from it)\n\t *\n\t * You can initialize the editor using an existing DOM element:\n\t *\n\t *\t\tDecoupledEditor\n\t *\t\t\t.create( document.querySelector( '#editor' ) )\n\t *\t\t\t.then( editor => {\n\t *\t\t\t\tconsole.log( 'Editor was initialized', editor );\n\t *\n\t *\t\t\t\t// Append the toolbar to the <body> element.\n\t *\t\t\t\tdocument.body.appendChild( editor.ui.view.toolbar.element );\n\t *\t\t\t} )\n\t *\t\t\t.catch( err => {\n\t *\t\t\t\tconsole.error( err.stack );\n\t *\t\t\t} );\n\t *\n\t * The element's content will be used as the editor data and the element will become the editable element.\n\t *\n\t * # Creating a detached editor\n\t *\n\t * Alternatively, you can initialize the editor by passing the initial data directly as a string.\n\t * In this case, you will have to manually append both the toolbar element and the editable element to your web page.\n\t *\n\t *\t\tDecoupledEditor\n\t *\t\t\t.create( '<p>Hello world!</p>' )\n\t *\t\t\t.then( editor => {\n\t *\t\t\t\tconsole.log( 'Editor was initialized', editor );\n\t *\n\t *\t\t\t\t// Append the toolbar to the <body> element.\n\t *\t\t\t\tdocument.body.appendChild( editor.ui.view.toolbar.element );\n\t *\n\t *\t\t\t\t// Initial data was provided so the editor UI element needs to be added manually to the DOM.\n\t *\t\t\t\tdocument.body.appendChild( editor.ui.getEditableElement() );\n\t *\t\t\t} )\n\t *\t\t\t.catch( err => {\n\t *\t\t\t\tconsole.error( err.stack );\n\t *\t\t\t} );\n\t *\n\t * This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your\n\t * web page content is generated on the client side and the DOM structure is not ready at the moment when you initialize the editor.\n\t *\n\t * # Using an existing DOM element (and data provided in `config.initialData`)\n\t *\n\t * You can also mix these two ways by providing a DOM element to be used and passing the initial data through the configuration:\n\t *\n\t *\t\tDecoupledEditor\n\t *\t\t\t.create( document.querySelector( '#editor' ), {\n\t *\t\t\t\tinitialData: '<h2>Initial data</h2><p>Foo bar.</p>'\n\t *\t\t\t} )\n\t *\t\t\t.then( editor => {\n\t *\t\t\t\tconsole.log( 'Editor was initialized', editor );\n\t *\n\t *\t\t\t\t// Append the toolbar to the <body> element.\n\t *\t\t\t\tdocument.body.appendChild( editor.ui.view.toolbar.element );\n\t *\t\t\t} )\n\t *\t\t\t.catch( err => {\n\t *\t\t\t\tconsole.error( err.stack );\n\t *\t\t\t} );\n\t *\n\t * This method can be used to initialize the editor on an existing element with the specified content in case if your integration\n\t * makes it difficult to set the content of the source element.\n\t *\n\t * Note that an error will be thrown if you pass the initial data both as the first parameter and also in the configuration.\n\t *\n\t * # Configuring the editor\n\t *\n\t * See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about\n\t * customizing plugins, toolbar and more.\n\t *\n\t * # Using the editor from source\n\t *\n\t * The code samples listed in the previous sections of this documentation assume that you are using an\n\t * {@glink installation/getting-started/predefined-builds editor build}\n\t * (for example – `@ckeditor/ckeditor5-build-decoupled`).\n\t *\n\t * If you want to use the decoupled editor from source (`@ckeditor/ckeditor5-editor-decoupled/src/decouplededitor`),\n\t * you need to define the list of\n\t * {@link module:core/editor/editorconfig~EditorConfig#plugins plugins to be initialized} and\n\t * {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar items}. Read more about using the editor from\n\t * source in the {@glink installation/advanced/alternative-setups/integrating-from-source dedicated guide}.\n\t *\n\t * @param {HTMLElement|String} sourceElementOrData The DOM element that will be the source for the created editor\n\t * or the editor's initial data.\n\t *\n\t * If a DOM element is passed, its content will be automatically loaded to the editor upon initialization.\n\t * The editor data will be set back to the original element once the editor is destroyed only if the\n\t * {@link module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy updateSourceElementOnDestroy}\n\t * option is set to `true`.\n\t *\n\t * If the initial data is passed, a detached editor will be created. In this case you need to insert it into the DOM manually.\n\t * It is available via\n\t * {@link module:editor-decoupled/decouplededitorui~DecoupledEditorUI#getEditableElement `editor.ui.getEditableElement()`}.\n\t *\n\t * @param {module:core/editor/editorconfig~EditorConfig} [config] The editor configuration.\n\t * @returns {Promise} A promise resolved once the editor is ready. The promise resolves with the created editor instance.\n\t */\n\tstatic create( sourceElementOrData, config = {} ) {\n\t\treturn new Promise( resolve => {\n\t\t\tif ( isElement( sourceElementOrData ) && sourceElementOrData.tagName === 'TEXTAREA' ) {\n\t\t\t\t// Documented in core/editor/editor.js\n\t\t\t\t// eslint-disable-next-line ckeditor5-rules/ckeditor-error-message\n\t\t\t\tthrow new CKEditorError( 'editor-wrong-element', null );\n\t\t\t}\n\n\t\t\tconst editor = new this( sourceElementOrData, config );\n\n\t\t\tresolve(\n\t\t\t\teditor.initPlugins()\n\t\t\t\t\t.then( () => editor.ui.init() )\n\t\t\t\t\t.then( () => editor.data.init( editor.config.get( 'initialData' ) ) )\n\t\t\t\t\t.then( () => editor.fire( 'ready' ) )\n\t\t\t\t\t.then( () => editor )\n\t\t\t);\n\t\t} );\n\t}\n}\n\nmix( DecoupledEditor, ElementApiMixin );\nmix( DecoupledEditor, DataApiMixin );\n\nfunction getInitialData( sourceElementOrData ) {\n\treturn isElement( sourceElementOrData ) ? getDataFromElement( sourceElementOrData ) : sourceElementOrData;\n}\n","/**\n * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.\n * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license\n */\n\n/**\n * @module editor-decoupled/decouplededitorui\n */\n\nimport { EditorUI } from 'ckeditor5/src/core';\nimport { enablePlaceholder } from 'ckeditor5/src/engine';\n\n/**\n * The decoupled editor UI class.\n *\n * @extends module:core/editor/editorui~EditorUI\n */\nexport default class DecoupledEditorUI extends EditorUI {\n\t/**\n\t * Creates an instance of the decoupled editor UI class.\n\t *\n\t * @param {module:core/editor/editor~Editor} editor The editor instance.\n\t * @param {module:ui/editorui/editoruiview~EditorUIView} view The view of the UI.\n\t */\n\tconstructor( editor, view ) {\n\t\tsuper( editor );\n\n\t\t/**\n\t\t * The main (top–most) view of the editor UI.\n\t\t *\n\t\t * @readonly\n\t\t * @member {module:ui/editorui/editoruiview~EditorUIView} #view\n\t\t */\n\t\tthis.view = view;\n\t}\n\n\t/**\n\t * Initializes the UI.\n\t */\n\tinit() {\n\t\tconst editor = this.editor;\n\t\tconst view = this.view;\n\t\tconst editingView = editor.editing.view;\n\t\tconst editable = view.editable;\n\t\tconst editingRoot = editingView.document.getRoot();\n\n\t\t// The editable UI and editing root should share the same name. Then name is used\n\t\t// to recognize the particular editable, for instance in ARIA attributes.\n\t\tview.editable.name = editingRoot.rootName;\n\n\t\tview.render();\n\n\t\t// The editable UI element in DOM is available for sure only after the editor UI view has been rendered.\n\t\t// But it can be available earlier if a DOM element has been passed to DecoupledEditor.create().\n\t\tconst editableElement = editable.element;\n\n\t\t// Register the editable UI view in the editor. A single editor instance can aggregate multiple\n\t\t// editable areas (roots) but the decoupled editor has only one.\n\t\tthis.setEditableElement( editable.name, editableElement );\n\n\t\t// Let the editable UI element respond to the changes in the global editor focus\n\t\t// tracker. It has been added to the same tracker a few lines above but, in reality, there are\n\t\t// many focusable areas in the editor, like balloons, toolbars or dropdowns and as long\n\t\t// as they have focus, the editable should act like it is focused too (although technically\n\t\t// it isn't), e.g. by setting the proper CSS class, visually announcing focus to the user.\n\t\t// Doing otherwise will result in editable focus styles disappearing, once e.g. the\n\t\t// toolbar gets focused.\n\t\tview.editable.bind( 'isFocused' ).to( this.focusTracker );\n\n\t\t// Bind the editable UI element to the editing view, making it an end– and entry–point\n\t\t// of the editor's engine. This is where the engine meets the UI.\n\t\teditingView.attachDomRoot( editableElement );\n\n\t\tthis._initPlaceholder();\n\t\tthis._initToolbar();\n\t\tthis.fire( 'ready' );\n\t}\n\n\t/**\n\t * @inheritDoc\n\t */\n\tdestroy() {\n\t\tsuper.destroy();\n\n\t\tconst view = this.view;\n\t\tconst editingView = this.editor.editing.view;\n\n\t\teditingView.detachDomRoot( view.editable.name );\n\t\tview.destroy();\n\t}\n\n\t/**\n\t * Initializes the inline editor toolbar and its panel.\n\t *\n\t * @private\n\t */\n\t_initToolbar() {\n\t\tconst editor = this.editor;\n\t\tconst view = this.view;\n\t\tconst toolbar = view.toolbar;\n\n\t\ttoolbar.fillFromConfig( editor.config.get( 'toolbar' ), this.componentFactory );\n\n\t\t// Register the toolbar so it becomes available for Alt+F10 and Esc navigation.\n\t\tthis.addToolbar( view.toolbar );\n\t}\n\n\t/**\n\t * Enable the placeholder text on the editing root, if any was configured.\n\t *\n\t * @private\n\t */\n\t_initPlaceholder() {\n\t\tconst editor = this.editor;\n\t\tconst editingView = editor.editing.view;\n\t\tconst editingRoot = editingView.document.getRoot();\n\t\tconst sourceElement = editor.sourceElement;\n\n\t\tconst placeholderText = editor.config.get( 'placeholder' ) ||\n\t\t\tsourceElement && sourceElement.tagName.toLowerCase() === 'textarea' && sourceElement.getAttribute( 'placeholder' );\n\n\t\tif ( placeholderText ) {\n\t\t\tenablePlaceholder( {\n\t\t\t\tview: editingView,\n\t\t\t\telement: editingRoot,\n\t\t\t\ttext: placeholderText,\n\t\t\t\tisDirectHost: false,\n\t\t\t\tkeepOnFocus: true\n\t\t\t} );\n\t\t}\n\t}\n}\n","/**\n * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.\n * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license\n */\n\n/**\n * @module editor-decoupled/decouplededitoruiview\n */\n\nimport { EditorUIView, InlineEditableUIView, ToolbarView } from 'ckeditor5/src/ui';\n\n/**\n * The decoupled editor UI view. It is a virtual view providing an inline\n * {@link module:editor-decoupled/decouplededitoruiview~DecoupledEditorUIView#editable} and a\n * {@link module:editor-decoupled/decouplededitoruiview~DecoupledEditorUIView#toolbar}, but without any\n * specific arrangement of the components in the DOM.\n *\n * See {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`}\n * to learn more about this view.\n *\n * @extends module:ui/editorui/editoruiview~EditorUIView\n */\nexport default class DecoupledEditorUIView extends EditorUIView {\n\t/**\n\t * Creates an instance of the decoupled editor UI view.\n\t *\n\t * @param {module:utils/locale~Locale} locale The {@link module:core/editor/editor~Editor#locale} instance.\n\t * @param {module:engine/view/view~View} editingView The editing view instance this view is related to.\n\t * @param {Object} [options={}] Configuration options for the view instance.\n\t * @param {HTMLElement} [options.editableElement] The editable element. If not specified, it will be automatically created by\n\t * {@link module:ui/editableui/editableuiview~EditableUIView}. Otherwise, the given element will be used.\n\t * @param {Boolean} [options.shouldToolbarGroupWhenFull] When set `true` enables automatic items grouping\n\t * in the main {@link module:editor-decoupled/decouplededitoruiview~DecoupledEditorUIView#toolbar toolbar}.\n\t * See {@link module:ui/toolbar/toolbarview~ToolbarOptions#shouldGroupWhenFull} to learn more.\n\t */\n\tconstructor( locale, editingView, options = {} ) {\n\t\tsuper( locale );\n\n\t\tconst t = locale.t;\n\n\t\t/**\n\t\t * The main toolbar of the decoupled editor UI.\n\t\t *\n\t\t * @readonly\n\t\t * @member {module:ui/toolbar/toolbarview~ToolbarView}\n\t\t */\n\t\tthis.toolbar = new ToolbarView( locale, {\n\t\t\tshouldGroupWhenFull: options.shouldToolbarGroupWhenFull\n\t\t} );\n\n\t\t/**\n\t\t * The editable of the decoupled editor UI.\n\t\t *\n\t\t * @readonly\n\t\t * @member {module:ui/editableui/inline/inlineeditableuiview~InlineEditableUIView}\n\t\t */\n\t\tthis.editable = new InlineEditableUIView( locale, editingView, options.editableElement, {\n\t\t\tlabel: editableView => {\n\t\t\t\treturn t( 'Rich Text Editor. Editing area: %0', editableView.name );\n\t\t\t}\n\t\t} );\n\n\t\t// This toolbar may be placed anywhere in the page so things like font size need to be reset in it.\n\t\t// Because of the above, make sure the toolbar supports rounded corners.\n\t\t// Also, make sure the toolbar has the proper dir attribute because its ancestor may not have one\n\t\t// and some toolbar item styles depend on this attribute.\n\t\tthis.toolbar.extendTemplate( {\n\t\t\tattributes: {\n\t\t\t\tclass: [\n\t\t\t\t\t'ck-reset_all',\n\t\t\t\t\t'ck-rounded-corners'\n\t\t\t\t],\n\t\t\t\tdir: locale.uiLanguageDirection\n\t\t\t}\n\t\t} );\n\t}\n\n\t/**\n\t * @inheritDoc\n\t */\n\trender() {\n\t\tsuper.render();\n\n\t\tthis.registerChild( [ this.toolbar, this.editable ] );\n\t}\n}\n","module.exports = (__webpack_require__(/*! dll-reference CKEditor5.dll */ \"dll-reference CKEditor5.dll\"))(\"./src/core.js\");","module.exports = (__webpack_require__(/*! dll-reference CKEditor5.dll */ \"dll-reference CKEditor5.dll\"))(\"./src/engine.js\");","module.exports = (__webpack_require__(/*! dll-reference CKEditor5.dll */ \"dll-reference CKEditor5.dll\"))(\"./src/ui.js\");","module.exports = (__webpack_require__(/*! dll-reference CKEditor5.dll */ \"dll-reference CKEditor5.dll\"))(\"./src/utils.js\");","module.exports = CKEditor5.dll;","import root from './_root.js';\n\n/** Built-in value references. */\nvar Symbol = root.Symbol;\n\nexport default Symbol;\n","import Symbol from './_Symbol.js';\nimport getRawTag from './_getRawTag.js';\nimport objectToString from './_objectToString.js';\n\n/** `Object#toString` result references. */\nvar nullTag = '[object Null]',\n undefinedTag = '[object Undefined]';\n\n/** Built-in value references. */\nvar symToStringTag = Symbol ? Symbol.toStringTag : undefined;\n\n/**\n * The base implementation of `getTag` without fallbacks for buggy environments.\n *\n * @private\n * @param {*} value The value to query.\n * @returns {string} Returns the `toStringTag`.\n */\nfunction baseGetTag(value) {\n if (value == null) {\n return value === undefined ? undefinedTag : nullTag;\n }\n return (symToStringTag && symToStringTag in Object(value))\n ? getRawTag(value)\n : objectToString(value);\n}\n\nexport default baseGetTag;\n","/** Detect free variable `global` from Node.js. */\nvar freeGlobal = typeof global == 'object' && global && global.Object === Object && global;\n\nexport default freeGlobal;\n","import overArg from './_overArg.js';\n\n/** Built-in value references. */\nvar getPrototype = overArg(Object.getPrototypeOf, Object);\n\nexport default getPrototype;\n","import Symbol from './_Symbol.js';\n\n/** Used for built-in method references. */\nvar objectProto = Object.prototype;\n\n/** Used to check objects for own properties. */\nvar hasOwnProperty = objectProto.hasOwnProperty;\n\n/**\n * Used to resolve the\n * [`toStringTag`](http://ecma-international.org/ecma-262/7.0/#sec-object.prototype.tostring)\n * of values.\n */\nvar nativeObjectToString = objectProto.toString;\n\n/** Built-in value references. */\nvar symToStringTag = Symbol ? Symbol.toStringTag : undefined;\n\n/**\n * A specialized version of `baseGetTag` which ignores `Symbol.toStringTag` values.\n *\n * @private\n * @param {*} value The value to query.\n * @returns {string} Returns the raw `toStringTag`.\n */\nfunction getRawTag(value) {\n var isOwn = hasOwnProperty.call(value, symToStringTag),\n tag = value[symToStringTag];\n\n try {\n value[symToStringTag] = undefined;\n var unmasked = true;\n } catch (e) {}\n\n var result = nativeObjectToString.call(value);\n if (unmasked) {\n if (isOwn) {\n value[symToStringTag] = tag;\n } else {\n delete value[symToStringTag];\n }\n }\n return result;\n}\n\nexport default getRawTag;\n","/** Used for built-in method references. */\nvar objectProto = Object.prototype;\n\n/**\n * Used to resolve the\n * [`toStringTag`](http://ecma-international.org/ecma-262/7.0/#sec-object.prototype.tostring)\n * of values.\n */\nvar nativeObjectToString = objectProto.toString;\n\n/**\n * Converts `value` to a string using `Object.prototype.toString`.\n *\n * @private\n * @param {*} value The value to convert.\n * @returns {string} Returns the converted string.\n */\nfunction objectToString(value) {\n return nativeObjectToString.call(value);\n}\n\nexport default objectToString;\n","/**\n * Creates a unary function that invokes `func` with its argument transformed.\n *\n * @private\n * @param {Function} func The function to wrap.\n * @param {Function} transform The argument transform.\n * @returns {Function} Returns the new function.\n */\nfunction overArg(func, transform) {\n return function(arg) {\n return func(transform(arg));\n };\n}\n\nexport default overArg;\n","import freeGlobal from './_freeGlobal.js';\n\n/** Detect free variable `self`. */\nvar freeSelf = typeof self == 'object' && self && self.Object === Object && self;\n\n/** Used as a reference to the global object. */\nvar root = freeGlobal || freeSelf || Function('return this')();\n\nexport default root;\n","import isObjectLike from './isObjectLike.js';\nimport isPlainObject from './isPlainObject.js';\n\n/**\n * Checks if `value` is likely a DOM element.\n *\n * @static\n * @memberOf _\n * @since 0.1.0\n * @category Lang\n * @param {*} value The value to check.\n * @returns {boolean} Returns `true` if `value` is a DOM element, else `false`.\n * @example\n *\n * _.isElement(document.body);\n * // => true\n *\n * _.isElement('<body>');\n * // => false\n */\nfunction isElement(value) {\n return isObjectLike(value) && value.nodeType === 1 && !isPlainObject(value);\n}\n\nexport default isElement;\n","/**\n * Checks if `value` is object-like. A value is object-like if it's not `null`\n * and has a `typeof` result of \"object\".\n *\n * @static\n * @memberOf _\n * @since 4.0.0\n * @category Lang\n * @param {*} value The value to check.\n * @returns {boolean} Returns `true` if `value` is object-like, else `false`.\n * @example\n *\n * _.isObjectLike({});\n * // => true\n *\n * _.isObjectLike([1, 2, 3]);\n * // => true\n *\n * _.isObjectLike(_.noop);\n * // => false\n *\n * _.isObjectLike(null);\n * // => false\n */\nfunction isObjectLike(value) {\n return value != null && typeof value == 'object';\n}\n\nexport default isObjectLike;\n","import baseGetTag from './_baseGetTag.js';\nimport getPrototype from './_getPrototype.js';\nimport isObjectLike from './isObjectLike.js';\n\n/** `Object#toString` result references. */\nvar objectTag = '[object Object]';\n\n/** Used for built-in method references. */\nvar funcProto = Function.prototype,\n objectProto = Object.prototype;\n\n/** Used to resolve the decompiled source of functions. */\nvar funcToString = funcProto.toString;\n\n/** Used to check objects for own properties. */\nvar hasOwnProperty = objectProto.hasOwnProperty;\n\n/** Used to infer the `Object` constructor. */\nvar objectCtorString = funcToString.call(Object);\n\n/**\n * Checks if `value` is a plain object, that is, an object created by the\n * `Object` constructor or one with a `[[Prototype]]` of `null`.\n *\n * @static\n * @memberOf _\n * @since 0.8.0\n * @category Lang\n * @param {*} value The value to check.\n * @returns {boolean} Returns `true` if `value` is a plain object, else `false`.\n * @example\n *\n * function Foo() {\n * this.a = 1;\n * }\n *\n * _.isPlainObject(new Foo);\n * // => false\n *\n * _.isPlainObject([1, 2, 3]);\n * // => false\n *\n * _.isPlainObject({ 'x': 0, 'y': 0 });\n * // => true\n *\n * _.isPlainObject(Object.create(null));\n * // => true\n */\nfunction isPlainObject(value) {\n if (!isObjectLike(value) || baseGetTag(value) != objectTag) {\n return false;\n }\n var proto = getPrototype(value);\n if (proto === null) {\n return true;\n }\n var Ctor = hasOwnProperty.call(proto, 'constructor') && proto.constructor;\n return typeof Ctor == 'function' && Ctor instanceof Ctor &&\n funcToString.call(Ctor) == objectCtorString;\n}\n\nexport default isPlainObject;\n","// The module cache\nvar __webpack_module_cache__ = {};\n\n// The require function\nfunction __webpack_require__(moduleId) {\n\t// Check if module is in cache\n\tvar cachedModule = __webpack_module_cache__[moduleId];\n\tif (cachedModule !== undefined) {\n\t\treturn cachedModule.exports;\n\t}\n\t// Create a new module (and put it into the cache)\n\tvar module = __webpack_module_cache__[moduleId] = {\n\t\t// no module.id needed\n\t\t// no module.loaded needed\n\t\texports: {}\n\t};\n\n\t// Execute the module function\n\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n\n\t// Return the exports of the module\n\treturn module.exports;\n}\n\n","// define getter functions for harmony exports\n__webpack_require__.d = (exports, definition) => {\n\tfor(var key in definition) {\n\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n\t\t}\n\t}\n};","__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))","// define __esModule on exports\n__webpack_require__.r = (exports) => {\n\tif(typeof Symbol !== 'undefined' && Symbol.toStringTag) {\n\t\tObject.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });\n\t}\n\tObject.defineProperty(exports, '__esModule', { value: true });\n};","/**\n * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.\n * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license\n */\n\n/**\n * @module editor-decoupled\n */\n\nexport { default as DecoupledEditor } from './decouplededitor';\n"],"names":[],"sourceRoot":""}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ckeditor/ckeditor5-editor-decoupled",
|
|
3
|
-
"version": "38.1.
|
|
3
|
+
"version": "38.1.1",
|
|
4
4
|
"description": "Decoupled editor implementation for CKEditor 5.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ckeditor",
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
],
|
|
12
12
|
"main": "src/index.js",
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"ckeditor5": "38.1.
|
|
14
|
+
"ckeditor5": "38.1.1",
|
|
15
15
|
"lodash-es": "^4.17.15"
|
|
16
16
|
},
|
|
17
17
|
"engines": {
|
package/src/decouplededitor.d.ts
CHANGED
|
@@ -1,215 +1,215 @@
|
|
|
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
|
-
* @module editor-decoupled/decouplededitor
|
|
7
|
-
*/
|
|
8
|
-
import { Editor, Context, type EditorConfig } from 'ckeditor5/src/core';
|
|
9
|
-
import { ContextWatchdog, EditorWatchdog } from 'ckeditor5/src/watchdog';
|
|
10
|
-
import DecoupledEditorUI from './decouplededitorui';
|
|
11
|
-
declare const DecoupledEditor_base: import("ckeditor5/src/utils").Mixed<import("ckeditor5/src/utils").Mixed<typeof Editor, import("ckeditor5/src/core").ElementApi>, import("ckeditor5/src/core").DataApi>;
|
|
12
|
-
/**
|
|
13
|
-
* The {@glink installation/getting-started/predefined-builds#document-editor decoupled editor} implementation.
|
|
14
|
-
* It provides an inline editable and a toolbar. However, unlike other editors,
|
|
15
|
-
* it does not render these components anywhere in the DOM unless configured.
|
|
16
|
-
*
|
|
17
|
-
* This type of an editor is dedicated to integrations which require a customized UI with an open
|
|
18
|
-
* structure, allowing developers to specify the exact location of the interface.
|
|
19
|
-
*
|
|
20
|
-
* See the document editor {@glink examples/builds/document-editor demo} to learn about possible use cases
|
|
21
|
-
* for the decoupled editor.
|
|
22
|
-
*
|
|
23
|
-
* In order to create a decoupled editor instance, use the static
|
|
24
|
-
* {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`} method.
|
|
25
|
-
*
|
|
26
|
-
* Note that you will need to attach the editor toolbar to your web page manually, in a desired place, after the editor is initialized.
|
|
27
|
-
*
|
|
28
|
-
* # Decoupled editor and document editor build
|
|
29
|
-
*
|
|
30
|
-
* The decoupled editor can be used directly from source (if you installed the
|
|
31
|
-
* [`@ckeditor/ckeditor5-editor-decoupled`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-decoupled) package)
|
|
32
|
-
* but it is also available in the
|
|
33
|
-
* {@glink installation/getting-started/predefined-builds#document-editor document editor build}.
|
|
34
|
-
*
|
|
35
|
-
* {@glink installation/getting-started/predefined-builds Builds}
|
|
36
|
-
* are ready-to-use editors with plugins bundled in. When using the editor from
|
|
37
|
-
* source you need to take care of loading all plugins by yourself
|
|
38
|
-
* (through the {@link module:core/editor/editorconfig~EditorConfig#plugins `config.plugins`} option).
|
|
39
|
-
* Using the editor from source gives much better flexibility and allows for easier customization.
|
|
40
|
-
*
|
|
41
|
-
* Read more about initializing the editor from source or as a build in
|
|
42
|
-
* {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`}.
|
|
43
|
-
*/
|
|
44
|
-
export default class DecoupledEditor extends DecoupledEditor_base {
|
|
45
|
-
/**
|
|
46
|
-
* @inheritDoc
|
|
47
|
-
*/
|
|
48
|
-
readonly ui: DecoupledEditorUI;
|
|
49
|
-
/**
|
|
50
|
-
* Creates an instance of the decoupled editor.
|
|
51
|
-
*
|
|
52
|
-
* **Note:** Do not use the constructor to create editor instances. Use the static
|
|
53
|
-
* {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`} method instead.
|
|
54
|
-
*
|
|
55
|
-
* @param sourceElementOrData The DOM element that will be the source for the created editor
|
|
56
|
-
* (on which the editor will be initialized) or initial data for the editor. For more information see
|
|
57
|
-
* {@link module:editor-balloon/ballooneditor~BalloonEditor.create `BalloonEditor.create()`}.
|
|
58
|
-
* @param config The editor configuration.
|
|
59
|
-
*/
|
|
60
|
-
protected constructor(sourceElementOrData: HTMLElement | string, config?: EditorConfig);
|
|
61
|
-
/**
|
|
62
|
-
* Destroys the editor instance, releasing all resources used by it.
|
|
63
|
-
*
|
|
64
|
-
* Updates the original editor element with the data if the
|
|
65
|
-
* {@link module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy `updateSourceElementOnDestroy`}
|
|
66
|
-
* configuration option is set to `true`.
|
|
67
|
-
*
|
|
68
|
-
* **Note**: The decoupled editor does not remove the toolbar and editable when destroyed. You can
|
|
69
|
-
* do that yourself in the destruction chain:
|
|
70
|
-
*
|
|
71
|
-
* ```ts
|
|
72
|
-
* editor.destroy()
|
|
73
|
-
* .then( () => {
|
|
74
|
-
* // Remove the toolbar from DOM.
|
|
75
|
-
* editor.ui.view.toolbar.element.remove();
|
|
76
|
-
*
|
|
77
|
-
* // Remove the editable from DOM.
|
|
78
|
-
* editor.ui.view.editable.element.remove();
|
|
79
|
-
*
|
|
80
|
-
* console.log( 'Editor was destroyed' );
|
|
81
|
-
* } );
|
|
82
|
-
* ```
|
|
83
|
-
*/
|
|
84
|
-
destroy(): Promise<unknown>;
|
|
85
|
-
/**
|
|
86
|
-
* Creates a new decoupled editor instance.
|
|
87
|
-
*
|
|
88
|
-
* **Note:** remember that `DecoupledEditor` does not append the toolbar element to your web page, so you have to do it manually
|
|
89
|
-
* after the editor has been initialized.
|
|
90
|
-
*
|
|
91
|
-
* There are two ways how the editor can be initialized.
|
|
92
|
-
*
|
|
93
|
-
* # Using an existing DOM element (and loading data from it)
|
|
94
|
-
*
|
|
95
|
-
* You can initialize the editor using an existing DOM element:
|
|
96
|
-
*
|
|
97
|
-
* ```ts
|
|
98
|
-
* DecoupledEditor
|
|
99
|
-
* .create( document.querySelector( '#editor' ) )
|
|
100
|
-
* .then( editor => {
|
|
101
|
-
* console.log( 'Editor was initialized', editor );
|
|
102
|
-
*
|
|
103
|
-
* // Append the toolbar to the <body> element.
|
|
104
|
-
* document.body.appendChild( editor.ui.view.toolbar.element );
|
|
105
|
-
* } )
|
|
106
|
-
* .catch( err => {
|
|
107
|
-
* console.error( err.stack );
|
|
108
|
-
* } );
|
|
109
|
-
* ```
|
|
110
|
-
*
|
|
111
|
-
* The element's content will be used as the editor data and the element will become the editable element.
|
|
112
|
-
*
|
|
113
|
-
* # Creating a detached editor
|
|
114
|
-
*
|
|
115
|
-
* Alternatively, you can initialize the editor by passing the initial data directly as a string.
|
|
116
|
-
* In this case, you will have to manually append both the toolbar element and the editable element to your web page.
|
|
117
|
-
*
|
|
118
|
-
* ```ts
|
|
119
|
-
* DecoupledEditor
|
|
120
|
-
* .create( '<p>Hello world!</p>' )
|
|
121
|
-
* .then( editor => {
|
|
122
|
-
* console.log( 'Editor was initialized', editor );
|
|
123
|
-
*
|
|
124
|
-
* // Append the toolbar to the <body> element.
|
|
125
|
-
* document.body.appendChild( editor.ui.view.toolbar.element );
|
|
126
|
-
*
|
|
127
|
-
* // Initial data was provided so the editor UI element needs to be added manually to the DOM.
|
|
128
|
-
* document.body.appendChild( editor.ui.getEditableElement() );
|
|
129
|
-
* } )
|
|
130
|
-
* .catch( err => {
|
|
131
|
-
* console.error( err.stack );
|
|
132
|
-
* } );
|
|
133
|
-
* ```
|
|
134
|
-
*
|
|
135
|
-
* This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your
|
|
136
|
-
* web page content is generated on the client side and the DOM structure is not ready at the moment when you initialize the editor.
|
|
137
|
-
*
|
|
138
|
-
* # Using an existing DOM element (and data provided in `config.initialData`)
|
|
139
|
-
*
|
|
140
|
-
* You can also mix these two ways by providing a DOM element to be used and passing the initial data through the configuration:
|
|
141
|
-
*
|
|
142
|
-
* ```ts
|
|
143
|
-
* DecoupledEditor
|
|
144
|
-
* .create( document.querySelector( '#editor' ), {
|
|
145
|
-
* initialData: '<h2>Initial data</h2><p>Foo bar.</p>'
|
|
146
|
-
* } )
|
|
147
|
-
* .then( editor => {
|
|
148
|
-
* console.log( 'Editor was initialized', editor );
|
|
149
|
-
*
|
|
150
|
-
* // Append the toolbar to the <body> element.
|
|
151
|
-
* document.body.appendChild( editor.ui.view.toolbar.element );
|
|
152
|
-
* } )
|
|
153
|
-
* .catch( err => {
|
|
154
|
-
* console.error( err.stack );
|
|
155
|
-
* } );
|
|
156
|
-
* ```
|
|
157
|
-
*
|
|
158
|
-
* This method can be used to initialize the editor on an existing element with the specified content in case if your integration
|
|
159
|
-
* makes it difficult to set the content of the source element.
|
|
160
|
-
*
|
|
161
|
-
* Note that an error will be thrown if you pass the initial data both as the first parameter and also in the configuration.
|
|
162
|
-
*
|
|
163
|
-
* # Configuring the editor
|
|
164
|
-
*
|
|
165
|
-
* See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
|
|
166
|
-
* customizing plugins, toolbar and more.
|
|
167
|
-
*
|
|
168
|
-
* # Using the editor from source
|
|
169
|
-
*
|
|
170
|
-
* The code samples listed in the previous sections of this documentation assume that you are using an
|
|
171
|
-
* {@glink installation/getting-started/predefined-builds editor build}
|
|
172
|
-
* (for example – `@ckeditor/ckeditor5-build-decoupled`).
|
|
173
|
-
*
|
|
174
|
-
* If you want to use the decoupled editor from source (`@ckeditor/ckeditor5-editor-decoupled/src/decouplededitor`),
|
|
175
|
-
* you need to define the list of
|
|
176
|
-
* {@link module:core/editor/editorconfig~EditorConfig#plugins plugins to be initialized} and
|
|
177
|
-
* {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar items}. Read more about using the editor from
|
|
178
|
-
* source in the {@glink installation/advanced/alternative-setups/integrating-from-source-webpack dedicated guide}.
|
|
179
|
-
*
|
|
180
|
-
* @param sourceElementOrData The DOM element that will be the source for the created editor
|
|
181
|
-
* or the editor's initial data.
|
|
182
|
-
*
|
|
183
|
-
* If a DOM element is passed, its content will be automatically loaded to the editor upon initialization.
|
|
184
|
-
* The editor data will be set back to the original element once the editor is destroyed only if the
|
|
185
|
-
* {@link module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy updateSourceElementOnDestroy}
|
|
186
|
-
* option is set to `true`.
|
|
187
|
-
*
|
|
188
|
-
* If the initial data is passed, a detached editor will be created. In this case you need to insert it into the DOM manually.
|
|
189
|
-
* It is available via
|
|
190
|
-
* {@link module:editor-decoupled/decouplededitorui~DecoupledEditorUI#getEditableElement `editor.ui.getEditableElement()`}.
|
|
191
|
-
*
|
|
192
|
-
* @param config The editor configuration.
|
|
193
|
-
* @returns A promise resolved once the editor is ready. The promise resolves with the created editor instance.
|
|
194
|
-
*/
|
|
195
|
-
static create(sourceElementOrData: HTMLElement | string, config?: EditorConfig): Promise<DecoupledEditor>;
|
|
196
|
-
/**
|
|
197
|
-
* The {@link module:core/context~Context} class.
|
|
198
|
-
*
|
|
199
|
-
* Exposed as static editor field for easier access in editor builds.
|
|
200
|
-
*/
|
|
201
|
-
static Context: typeof Context;
|
|
202
|
-
/**
|
|
203
|
-
* The {@link module:watchdog/editorwatchdog~EditorWatchdog} class.
|
|
204
|
-
*
|
|
205
|
-
* Exposed as static editor field for easier access in editor builds.
|
|
206
|
-
*/
|
|
207
|
-
static EditorWatchdog: typeof EditorWatchdog;
|
|
208
|
-
/**
|
|
209
|
-
* The {@link module:watchdog/contextwatchdog~ContextWatchdog} class.
|
|
210
|
-
*
|
|
211
|
-
* Exposed as static editor field for easier access in editor builds.
|
|
212
|
-
*/
|
|
213
|
-
static ContextWatchdog: typeof ContextWatchdog;
|
|
214
|
-
}
|
|
215
|
-
export {};
|
|
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
|
+
* @module editor-decoupled/decouplededitor
|
|
7
|
+
*/
|
|
8
|
+
import { Editor, Context, type EditorConfig } from 'ckeditor5/src/core';
|
|
9
|
+
import { ContextWatchdog, EditorWatchdog } from 'ckeditor5/src/watchdog';
|
|
10
|
+
import DecoupledEditorUI from './decouplededitorui';
|
|
11
|
+
declare const DecoupledEditor_base: import("ckeditor5/src/utils").Mixed<import("ckeditor5/src/utils").Mixed<typeof Editor, import("ckeditor5/src/core").ElementApi>, import("ckeditor5/src/core").DataApi>;
|
|
12
|
+
/**
|
|
13
|
+
* The {@glink installation/getting-started/predefined-builds#document-editor decoupled editor} implementation.
|
|
14
|
+
* It provides an inline editable and a toolbar. However, unlike other editors,
|
|
15
|
+
* it does not render these components anywhere in the DOM unless configured.
|
|
16
|
+
*
|
|
17
|
+
* This type of an editor is dedicated to integrations which require a customized UI with an open
|
|
18
|
+
* structure, allowing developers to specify the exact location of the interface.
|
|
19
|
+
*
|
|
20
|
+
* See the document editor {@glink examples/builds/document-editor demo} to learn about possible use cases
|
|
21
|
+
* for the decoupled editor.
|
|
22
|
+
*
|
|
23
|
+
* In order to create a decoupled editor instance, use the static
|
|
24
|
+
* {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`} method.
|
|
25
|
+
*
|
|
26
|
+
* Note that you will need to attach the editor toolbar to your web page manually, in a desired place, after the editor is initialized.
|
|
27
|
+
*
|
|
28
|
+
* # Decoupled editor and document editor build
|
|
29
|
+
*
|
|
30
|
+
* The decoupled editor can be used directly from source (if you installed the
|
|
31
|
+
* [`@ckeditor/ckeditor5-editor-decoupled`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-decoupled) package)
|
|
32
|
+
* but it is also available in the
|
|
33
|
+
* {@glink installation/getting-started/predefined-builds#document-editor document editor build}.
|
|
34
|
+
*
|
|
35
|
+
* {@glink installation/getting-started/predefined-builds Builds}
|
|
36
|
+
* are ready-to-use editors with plugins bundled in. When using the editor from
|
|
37
|
+
* source you need to take care of loading all plugins by yourself
|
|
38
|
+
* (through the {@link module:core/editor/editorconfig~EditorConfig#plugins `config.plugins`} option).
|
|
39
|
+
* Using the editor from source gives much better flexibility and allows for easier customization.
|
|
40
|
+
*
|
|
41
|
+
* Read more about initializing the editor from source or as a build in
|
|
42
|
+
* {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`}.
|
|
43
|
+
*/
|
|
44
|
+
export default class DecoupledEditor extends DecoupledEditor_base {
|
|
45
|
+
/**
|
|
46
|
+
* @inheritDoc
|
|
47
|
+
*/
|
|
48
|
+
readonly ui: DecoupledEditorUI;
|
|
49
|
+
/**
|
|
50
|
+
* Creates an instance of the decoupled editor.
|
|
51
|
+
*
|
|
52
|
+
* **Note:** Do not use the constructor to create editor instances. Use the static
|
|
53
|
+
* {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`} method instead.
|
|
54
|
+
*
|
|
55
|
+
* @param sourceElementOrData The DOM element that will be the source for the created editor
|
|
56
|
+
* (on which the editor will be initialized) or initial data for the editor. For more information see
|
|
57
|
+
* {@link module:editor-balloon/ballooneditor~BalloonEditor.create `BalloonEditor.create()`}.
|
|
58
|
+
* @param config The editor configuration.
|
|
59
|
+
*/
|
|
60
|
+
protected constructor(sourceElementOrData: HTMLElement | string, config?: EditorConfig);
|
|
61
|
+
/**
|
|
62
|
+
* Destroys the editor instance, releasing all resources used by it.
|
|
63
|
+
*
|
|
64
|
+
* Updates the original editor element with the data if the
|
|
65
|
+
* {@link module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy `updateSourceElementOnDestroy`}
|
|
66
|
+
* configuration option is set to `true`.
|
|
67
|
+
*
|
|
68
|
+
* **Note**: The decoupled editor does not remove the toolbar and editable when destroyed. You can
|
|
69
|
+
* do that yourself in the destruction chain:
|
|
70
|
+
*
|
|
71
|
+
* ```ts
|
|
72
|
+
* editor.destroy()
|
|
73
|
+
* .then( () => {
|
|
74
|
+
* // Remove the toolbar from DOM.
|
|
75
|
+
* editor.ui.view.toolbar.element.remove();
|
|
76
|
+
*
|
|
77
|
+
* // Remove the editable from DOM.
|
|
78
|
+
* editor.ui.view.editable.element.remove();
|
|
79
|
+
*
|
|
80
|
+
* console.log( 'Editor was destroyed' );
|
|
81
|
+
* } );
|
|
82
|
+
* ```
|
|
83
|
+
*/
|
|
84
|
+
destroy(): Promise<unknown>;
|
|
85
|
+
/**
|
|
86
|
+
* Creates a new decoupled editor instance.
|
|
87
|
+
*
|
|
88
|
+
* **Note:** remember that `DecoupledEditor` does not append the toolbar element to your web page, so you have to do it manually
|
|
89
|
+
* after the editor has been initialized.
|
|
90
|
+
*
|
|
91
|
+
* There are two ways how the editor can be initialized.
|
|
92
|
+
*
|
|
93
|
+
* # Using an existing DOM element (and loading data from it)
|
|
94
|
+
*
|
|
95
|
+
* You can initialize the editor using an existing DOM element:
|
|
96
|
+
*
|
|
97
|
+
* ```ts
|
|
98
|
+
* DecoupledEditor
|
|
99
|
+
* .create( document.querySelector( '#editor' ) )
|
|
100
|
+
* .then( editor => {
|
|
101
|
+
* console.log( 'Editor was initialized', editor );
|
|
102
|
+
*
|
|
103
|
+
* // Append the toolbar to the <body> element.
|
|
104
|
+
* document.body.appendChild( editor.ui.view.toolbar.element );
|
|
105
|
+
* } )
|
|
106
|
+
* .catch( err => {
|
|
107
|
+
* console.error( err.stack );
|
|
108
|
+
* } );
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
111
|
+
* The element's content will be used as the editor data and the element will become the editable element.
|
|
112
|
+
*
|
|
113
|
+
* # Creating a detached editor
|
|
114
|
+
*
|
|
115
|
+
* Alternatively, you can initialize the editor by passing the initial data directly as a string.
|
|
116
|
+
* In this case, you will have to manually append both the toolbar element and the editable element to your web page.
|
|
117
|
+
*
|
|
118
|
+
* ```ts
|
|
119
|
+
* DecoupledEditor
|
|
120
|
+
* .create( '<p>Hello world!</p>' )
|
|
121
|
+
* .then( editor => {
|
|
122
|
+
* console.log( 'Editor was initialized', editor );
|
|
123
|
+
*
|
|
124
|
+
* // Append the toolbar to the <body> element.
|
|
125
|
+
* document.body.appendChild( editor.ui.view.toolbar.element );
|
|
126
|
+
*
|
|
127
|
+
* // Initial data was provided so the editor UI element needs to be added manually to the DOM.
|
|
128
|
+
* document.body.appendChild( editor.ui.getEditableElement() );
|
|
129
|
+
* } )
|
|
130
|
+
* .catch( err => {
|
|
131
|
+
* console.error( err.stack );
|
|
132
|
+
* } );
|
|
133
|
+
* ```
|
|
134
|
+
*
|
|
135
|
+
* This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your
|
|
136
|
+
* web page content is generated on the client side and the DOM structure is not ready at the moment when you initialize the editor.
|
|
137
|
+
*
|
|
138
|
+
* # Using an existing DOM element (and data provided in `config.initialData`)
|
|
139
|
+
*
|
|
140
|
+
* You can also mix these two ways by providing a DOM element to be used and passing the initial data through the configuration:
|
|
141
|
+
*
|
|
142
|
+
* ```ts
|
|
143
|
+
* DecoupledEditor
|
|
144
|
+
* .create( document.querySelector( '#editor' ), {
|
|
145
|
+
* initialData: '<h2>Initial data</h2><p>Foo bar.</p>'
|
|
146
|
+
* } )
|
|
147
|
+
* .then( editor => {
|
|
148
|
+
* console.log( 'Editor was initialized', editor );
|
|
149
|
+
*
|
|
150
|
+
* // Append the toolbar to the <body> element.
|
|
151
|
+
* document.body.appendChild( editor.ui.view.toolbar.element );
|
|
152
|
+
* } )
|
|
153
|
+
* .catch( err => {
|
|
154
|
+
* console.error( err.stack );
|
|
155
|
+
* } );
|
|
156
|
+
* ```
|
|
157
|
+
*
|
|
158
|
+
* This method can be used to initialize the editor on an existing element with the specified content in case if your integration
|
|
159
|
+
* makes it difficult to set the content of the source element.
|
|
160
|
+
*
|
|
161
|
+
* Note that an error will be thrown if you pass the initial data both as the first parameter and also in the configuration.
|
|
162
|
+
*
|
|
163
|
+
* # Configuring the editor
|
|
164
|
+
*
|
|
165
|
+
* See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
|
|
166
|
+
* customizing plugins, toolbar and more.
|
|
167
|
+
*
|
|
168
|
+
* # Using the editor from source
|
|
169
|
+
*
|
|
170
|
+
* The code samples listed in the previous sections of this documentation assume that you are using an
|
|
171
|
+
* {@glink installation/getting-started/predefined-builds editor build}
|
|
172
|
+
* (for example – `@ckeditor/ckeditor5-build-decoupled`).
|
|
173
|
+
*
|
|
174
|
+
* If you want to use the decoupled editor from source (`@ckeditor/ckeditor5-editor-decoupled/src/decouplededitor`),
|
|
175
|
+
* you need to define the list of
|
|
176
|
+
* {@link module:core/editor/editorconfig~EditorConfig#plugins plugins to be initialized} and
|
|
177
|
+
* {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar items}. Read more about using the editor from
|
|
178
|
+
* source in the {@glink installation/advanced/alternative-setups/integrating-from-source-webpack dedicated guide}.
|
|
179
|
+
*
|
|
180
|
+
* @param sourceElementOrData The DOM element that will be the source for the created editor
|
|
181
|
+
* or the editor's initial data.
|
|
182
|
+
*
|
|
183
|
+
* If a DOM element is passed, its content will be automatically loaded to the editor upon initialization.
|
|
184
|
+
* The editor data will be set back to the original element once the editor is destroyed only if the
|
|
185
|
+
* {@link module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy updateSourceElementOnDestroy}
|
|
186
|
+
* option is set to `true`.
|
|
187
|
+
*
|
|
188
|
+
* If the initial data is passed, a detached editor will be created. In this case you need to insert it into the DOM manually.
|
|
189
|
+
* It is available via
|
|
190
|
+
* {@link module:editor-decoupled/decouplededitorui~DecoupledEditorUI#getEditableElement `editor.ui.getEditableElement()`}.
|
|
191
|
+
*
|
|
192
|
+
* @param config The editor configuration.
|
|
193
|
+
* @returns A promise resolved once the editor is ready. The promise resolves with the created editor instance.
|
|
194
|
+
*/
|
|
195
|
+
static create(sourceElementOrData: HTMLElement | string, config?: EditorConfig): Promise<DecoupledEditor>;
|
|
196
|
+
/**
|
|
197
|
+
* The {@link module:core/context~Context} class.
|
|
198
|
+
*
|
|
199
|
+
* Exposed as static editor field for easier access in editor builds.
|
|
200
|
+
*/
|
|
201
|
+
static Context: typeof Context;
|
|
202
|
+
/**
|
|
203
|
+
* The {@link module:watchdog/editorwatchdog~EditorWatchdog} class.
|
|
204
|
+
*
|
|
205
|
+
* Exposed as static editor field for easier access in editor builds.
|
|
206
|
+
*/
|
|
207
|
+
static EditorWatchdog: typeof EditorWatchdog;
|
|
208
|
+
/**
|
|
209
|
+
* The {@link module:watchdog/contextwatchdog~ContextWatchdog} class.
|
|
210
|
+
*
|
|
211
|
+
* Exposed as static editor field for easier access in editor builds.
|
|
212
|
+
*/
|
|
213
|
+
static ContextWatchdog: typeof ContextWatchdog;
|
|
214
|
+
}
|
|
215
|
+
export {};
|