bootstrap-ui-inner.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals $, window, console:false */
  6. // Basic classes to create an editor.
  7. import Editor from '@ckeditor/ckeditor5-core/src/editor/editor';
  8. import EditorUI from '@ckeditor/ckeditor5-core/src/editor/editorui';
  9. import EditorUIView from '@ckeditor/ckeditor5-ui/src/editorui/editoruiview';
  10. import InlineEditableUIView from '@ckeditor/ckeditor5-ui/src/editableui/inline/inlineeditableuiview';
  11. import HtmlDataProcessor from '@ckeditor/ckeditor5-engine/src/dataprocessor/htmldataprocessor';
  12. import ElementReplacer from '@ckeditor/ckeditor5-utils/src/elementreplacer';
  13. // Interfaces to extend basic Editor API.
  14. import DataApiMixin from '@ckeditor/ckeditor5-core/src/editor/utils/dataapimixin';
  15. import ElementApiMixin from '@ckeditor/ckeditor5-core/src/editor/utils/elementapimixin';
  16. // Helper function for adding interfaces to the Editor class.
  17. import mix from '@ckeditor/ckeditor5-utils/src/mix';
  18. // Helper function that gets data from HTML element that the Editor is attached to.
  19. import getDataFromElement from '@ckeditor/ckeditor5-utils/src/dom/getdatafromelement';
  20. // Helper function that binds editor with HTMLForm element.
  21. import attachToForm from '@ckeditor/ckeditor5-core/src/editor/utils/attachtoform';
  22. // Basic features that every editor should enable.
  23. import Clipboard from '@ckeditor/ckeditor5-clipboard/src/clipboard';
  24. import Enter from '@ckeditor/ckeditor5-enter/src/enter';
  25. import Typing from '@ckeditor/ckeditor5-typing/src/typing';
  26. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  27. import UndoEditing from '@ckeditor/ckeditor5-undo/src/undoediting';
  28. // Basic features to associated with the edited content.
  29. import BoldEditing from '@ckeditor/ckeditor5-basic-styles/src/bold/boldediting';
  30. import ItalicEditing from '@ckeditor/ckeditor5-basic-styles/src/italic/italicediting';
  31. import UnderlineEditing from '@ckeditor/ckeditor5-basic-styles/src/underline/underlineediting';
  32. import HeadingEditing from '@ckeditor/ckeditor5-heading/src/headingediting';
  33. // The easy image integration.
  34. import EasyImage from '@ckeditor/ckeditor5-easy-image/src/easyimage';
  35. import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config';
  36. // Extending the Editor class, which brings base editor API.
  37. export default class BootstrapEditor extends Editor {
  38. constructor( element, config ) {
  39. super( config );
  40. // Remember the element the editor is created with.
  41. this.sourceElement = element;
  42. // Use the HTML data processor in this editor.
  43. this.data.processor = new HtmlDataProcessor();
  44. // Create the ("main") root element of the model tree.
  45. this.model.document.createRoot();
  46. // The UI layer of the editor.
  47. this.ui = new BootstrapEditorUI( this );
  48. // When editor#element is a textarea inside a form element
  49. // then content of this textarea will be updated on form submit.
  50. attachToForm( this );
  51. }
  52. destroy() {
  53. // When destroyed, editor sets the output of editor#getData() into editor#element...
  54. this.updateSourceElement();
  55. // ...and destroys the UI.
  56. this.ui.destroy();
  57. return super.destroy();
  58. }
  59. static create( element, config ) {
  60. return new Promise( resolve => {
  61. const editor = new this( element, config );
  62. resolve(
  63. editor.initPlugins()
  64. // Initialize the UI first. See the BootstrapEditorUI class to learn more.
  65. .then( () => editor.ui.init( element ) )
  66. // Bind the editor editing layer to the editable in DOM.
  67. .then( () => editor.editing.view.attachDomRoot( editor.ui.getEditableElement() ) )
  68. // Fill the editable with the initial data.
  69. .then( () => editor.data.init( getDataFromElement( element ) ) )
  70. // Fire the `editor#ready` event that announce the editor is complete and ready to use.
  71. .then( () => editor.fire( 'ready' ) )
  72. .then( () => editor )
  73. );
  74. } );
  75. }
  76. }
  77. // Mixing interfaces, which extends basic editor API.
  78. mix( BootstrapEditor, DataApiMixin );
  79. mix( BootstrapEditor, ElementApiMixin );
  80. // The class organizing the UI of the editor, binding it with existing Bootstrap elements in DOM.
  81. class BootstrapEditorUI extends EditorUI {
  82. constructor( editor ) {
  83. super( editor );
  84. // A helper to easily replace the editor#element with editor.editable#element.
  85. this._elementReplacer = new ElementReplacer();
  86. // The global UI view of the editor. It aggregates various Bootstrap DOM elements.
  87. const view = this._view = new EditorUIView( editor.locale );
  88. // This is the main editor element in the DOM.
  89. view.element = $( '.ck-editor' );
  90. // This is the editable view in the DOM. It will replace the data container in the DOM.
  91. view.editable = new InlineEditableUIView( editor.locale );
  92. // References to the dropdown elements for further usage. See #_setupBootstrapHeadingDropdown.
  93. view.dropdownMenu = view.element.find( '.dropdown-menu' );
  94. view.dropdownToggle = view.element.find( '.dropdown-toggle' );
  95. // References to the toolbar buttons for further usage. See #_setupBootstrapToolbarButtons.
  96. view.toolbarButtons = {};
  97. [ 'bold', 'italic', 'underline', 'undo', 'redo' ].forEach( name => {
  98. // Retrieve the jQuery object corresponding with the button in the DOM.
  99. view.toolbarButtons[ name ] = view.element.find( `#${ name }` );
  100. } );
  101. }
  102. // All EditorUI subclasses should expose their view instance
  103. // so other UI classes can access it if necessary.
  104. get view() {
  105. return this._view;
  106. }
  107. init( replacementElement ) {
  108. const editor = this.editor;
  109. const view = this.view;
  110. // Render the editable component in the DOM first.
  111. view.editable.render();
  112. // Create an editing root in the editing layer. It will correspond with the
  113. // document root created in the constructor().
  114. const editingRoot = editor.editing.view.document.getRoot();
  115. // Bind the basic attributes of the editable in the DOM with the editing layer.
  116. view.editable.bind( 'isReadOnly' ).to( editingRoot );
  117. view.editable.bind( 'isFocused' ).to( editor.editing.view.document );
  118. view.editable.name = editingRoot.rootName;
  119. // Register editable element so it is available via getEditableElement() method.
  120. this._editableElements.set( view.editable.name, view.editable.element );
  121. // Setup the existing, external Bootstrap UI so it works with the rest of the editor.
  122. this._setupBootstrapToolbarButtons();
  123. this._setupBootstrapHeadingDropdown();
  124. // Replace the editor#element with editor.editable#element.
  125. this._elementReplacer.replace( replacementElement, view.editable.element );
  126. // Tell the world that the UI of the editor is ready to use.
  127. this.fire( 'ready' );
  128. }
  129. destroy() {
  130. // Restore the original editor#element.
  131. this._elementReplacer.restore();
  132. // Destroy the view.
  133. this._view.editable.destroy();
  134. this._view.destroy();
  135. super.destroy();
  136. }
  137. // This method activates Bold, Italic, Underline, Undo and Redo buttons in the toolbar.
  138. _setupBootstrapToolbarButtons() {
  139. const editor = this.editor;
  140. for ( const name in this.view.toolbarButtons ) {
  141. // Retrieve the editor command corresponding with the id of the button in DOM.
  142. const command = editor.commands.get( name );
  143. const button = this.view.toolbarButtons[ name ];
  144. // Clicking on the buttons should execute the editor command...
  145. button.click( () => editor.execute( name ) );
  146. // ...but it should not steal the focus so the editing is uninterrupted.
  147. button.mousedown( evt => evt.preventDefault() );
  148. const onValueChange = () => {
  149. button.toggleClass( 'active', command.value );
  150. };
  151. const onIsEnabledChange = () => {
  152. button.attr( 'disabled', () => !command.isEnabled );
  153. };
  154. // Commands can become disabled, e.g. when the editor is read-only.
  155. // Make sure the buttons reflect this state change.
  156. command.on( 'change:isEnabled', onIsEnabledChange );
  157. onIsEnabledChange();
  158. // Bold, Italic and Underline commands have a value that changes
  159. // when the selection starts in an element the command creates.
  160. // The button should indicate that e.g. editing text which is already bold.
  161. if ( !new Set( [ 'undo', 'redo' ] ).has( name ) ) {
  162. command.on( 'change:value', onValueChange );
  163. onValueChange();
  164. }
  165. }
  166. }
  167. // This method activates the headings dropdown in the toolbar.
  168. _setupBootstrapHeadingDropdown() {
  169. const editor = this.editor;
  170. const dropdownMenu = this.view.dropdownMenu;
  171. const dropdownToggle = this.view.dropdownToggle;
  172. // Retrieve the editor commands for heading and paragraph.
  173. const headingCommand = editor.commands.get( 'heading' );
  174. const paragraphCommand = editor.commands.get( 'paragraph' );
  175. // Create a dropdown menu entry for each heading configuration option.
  176. editor.config.get( 'heading.options' ).map( option => {
  177. // Check is options is paragraph or heading as their commands slightly differ.
  178. const isParagraph = option.model === 'paragraph';
  179. // Create the menu item DOM element.
  180. const menuItem = $(
  181. `<a href="#" class="dropdown-item heading-item_${ option.model }">` +
  182. `${ option.title }` +
  183. '</a>'
  184. );
  185. // Upon click, the dropdown menu item should execute the command and focus
  186. // the editing view to keep the editing process uninterrupted.
  187. menuItem.click( () => {
  188. const commandName = isParagraph ? 'paragraph' : 'heading';
  189. const commandValue = isParagraph ? undefined : { value: option.model };
  190. editor.execute( commandName, commandValue );
  191. editor.editing.view.focus();
  192. } );
  193. dropdownMenu.append( menuItem );
  194. const command = isParagraph ? paragraphCommand : headingCommand;
  195. // Make sure the dropdown and its items reflect the state of the
  196. // currently active command.
  197. const onValueChange = isParagraph ? onValueChangeParagraph : onValueChangeHeading;
  198. command.on( 'change:value', onValueChange );
  199. onValueChange();
  200. // Heading commands can become disabled, e.g. when the editor is read-only.
  201. // Make sure the UI reflects this state change.
  202. command.on( 'change:isEnabled', onIsEnabledChange );
  203. onIsEnabledChange();
  204. function onValueChangeHeading() {
  205. const isActive = !isParagraph && command.value === option.model;
  206. if ( isActive ) {
  207. dropdownToggle.children( ':first' ).text( option.title );
  208. }
  209. menuItem.toggleClass( 'active', isActive );
  210. }
  211. function onValueChangeParagraph() {
  212. if ( command.value ) {
  213. dropdownToggle.children( ':first' ).text( option.title );
  214. }
  215. menuItem.toggleClass( 'active', command.value );
  216. }
  217. function onIsEnabledChange() {
  218. dropdownToggle.attr( 'disabled', () => !command.isEnabled );
  219. }
  220. } );
  221. }
  222. }
  223. // Finally, create the BootstrapEditor instance with a selected set of features.
  224. BootstrapEditor
  225. .create( $( '#editor' ).get( 0 ), {
  226. plugins: [
  227. Clipboard, Enter, Typing, Paragraph, EasyImage,
  228. BoldEditing, ItalicEditing, UnderlineEditing, HeadingEditing, UndoEditing
  229. ],
  230. cloudServices: CS_CONFIG
  231. } )
  232. .then( editor => {
  233. window.editor = editor;
  234. $( '#toggle-readonly' ).on( 'click', () => {
  235. editor.isReadOnly = !editor.isReadOnly;
  236. } );
  237. } )
  238. .catch( err => {
  239. console.error( err.stack );
  240. } );