view.js 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* globals document, console, setTimeout */
  6. import View from '../../../src/view/view';
  7. import Observer from '../../../src/view/observer/observer';
  8. import MutationObserver from '../../../src/view/observer/mutationobserver';
  9. import KeyObserver from '../../../src/view/observer/keyobserver';
  10. import InputObserver from '../../../src/view/observer/inputobserver';
  11. import FakeSelectionObserver from '../../../src/view/observer/fakeselectionobserver';
  12. import SelectionObserver from '../../../src/view/observer/selectionobserver';
  13. import FocusObserver from '../../../src/view/observer/focusobserver';
  14. import CompositionObserver from '../../../src/view/observer/compositionobserver';
  15. import ViewRange from '../../../src/view/range';
  16. import ViewElement from '../../../src/view/element';
  17. import ViewContainerElement from '../../../src/view/containerelement';
  18. import ViewText from '../../../src/view/text';
  19. import ViewPosition from '../../../src/view/position';
  20. import ViewSelection from '../../../src/view/selection';
  21. import { StylesProcessor } from '../../../src/view/stylesmap';
  22. import count from '@ckeditor/ckeditor5-utils/src/count';
  23. import global from '@ckeditor/ckeditor5-utils/src/dom/global';
  24. import createViewRoot from '../_utils/createroot';
  25. import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  26. import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  27. import env from '@ckeditor/ckeditor5-utils/src/env';
  28. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  29. describe( 'view', () => {
  30. const DEFAULT_OBSERVERS_COUNT = 6;
  31. let domRoot, view, viewDocument, ObserverMock, instantiated, enabled, ObserverMockGlobalCount;
  32. beforeEach( () => {
  33. domRoot = createElement( document, 'div', {
  34. id: 'editor',
  35. contenteditable: 'true'
  36. } );
  37. document.body.appendChild( domRoot );
  38. view = new View( new StylesProcessor() );
  39. viewDocument = view.document;
  40. ObserverMock = class extends Observer {
  41. constructor( view ) {
  42. super( view );
  43. this.enable = sinon.spy();
  44. this.disable = sinon.spy();
  45. this.observe = sinon.spy();
  46. this.destroy = sinon.spy();
  47. }
  48. };
  49. instantiated = 0;
  50. enabled = 0;
  51. ObserverMockGlobalCount = class extends Observer {
  52. constructor( view ) {
  53. super( view );
  54. instantiated++;
  55. this.observe = sinon.spy();
  56. }
  57. enable() {
  58. enabled++;
  59. }
  60. };
  61. } );
  62. afterEach( () => {
  63. sinon.restore();
  64. domRoot.remove();
  65. view.destroy();
  66. } );
  67. it( 'should add default observers', () => {
  68. expect( count( view._observers ) ).to.equal( DEFAULT_OBSERVERS_COUNT );
  69. expect( view.getObserver( MutationObserver ) ).to.be.instanceof( MutationObserver );
  70. expect( view.getObserver( SelectionObserver ) ).to.be.instanceof( SelectionObserver );
  71. expect( view.getObserver( FocusObserver ) ).to.be.instanceof( FocusObserver );
  72. expect( view.getObserver( KeyObserver ) ).to.be.instanceof( KeyObserver );
  73. expect( view.getObserver( FakeSelectionObserver ) ).to.be.instanceof( FakeSelectionObserver );
  74. expect( view.getObserver( CompositionObserver ) ).to.be.instanceof( CompositionObserver );
  75. } );
  76. it( 'should add InputObserver on Android devices', () => {
  77. const oldEnvIsAndroid = env.isAndroid;
  78. env.isAndroid = true;
  79. const newView = new View( new StylesProcessor() );
  80. expect( newView.getObserver( InputObserver ) ).to.be.instanceof( InputObserver );
  81. env.isAndroid = oldEnvIsAndroid;
  82. newView.destroy();
  83. } );
  84. describe( 'attachDomRoot()', () => {
  85. it( 'should attach DOM element to main view element', () => {
  86. const domDiv = document.createElement( 'div' );
  87. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  88. expect( count( view.domRoots ) ).to.equal( 0 );
  89. view.attachDomRoot( domDiv );
  90. expect( count( view.domRoots ) ).to.equal( 1 );
  91. expect( view.getDomRoot() ).to.equal( domDiv );
  92. expect( view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domDiv );
  93. expect( view._renderer.markedChildren.has( viewRoot ) ).to.be.true;
  94. domDiv.remove();
  95. } );
  96. it( 'should attach DOM element to custom view element', () => {
  97. const domH1 = document.createElement( 'h1' );
  98. const viewH1 = createViewRoot( viewDocument, 'h1', 'header' );
  99. expect( count( view.domRoots ) ).to.equal( 0 );
  100. view.attachDomRoot( domH1, 'header' );
  101. expect( count( view.domRoots ) ).to.equal( 1 );
  102. expect( view.getDomRoot( 'header' ) ).to.equal( domH1 );
  103. expect( view.domConverter.mapViewToDom( viewH1 ) ).to.equal( domH1 );
  104. expect( view._renderer.markedChildren.has( viewH1 ) ).to.be.true;
  105. } );
  106. it( 'should handle the "contenteditable" attribute management on #isReadOnly change', () => {
  107. const domDiv = document.createElement( 'div' );
  108. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  109. view.attachDomRoot( domDiv );
  110. viewRoot.isReadOnly = false;
  111. expect( viewRoot.getAttribute( 'contenteditable' ) ).to.equal( 'true' );
  112. viewRoot.isReadOnly = true;
  113. expect( viewRoot.getAttribute( 'contenteditable' ) ).to.equal( 'false' );
  114. } );
  115. it( 'should handle the ".ck-read-only" class management on #isReadOnly change', () => {
  116. const domDiv = document.createElement( 'div' );
  117. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  118. view.attachDomRoot( domDiv );
  119. viewRoot.isReadOnly = false;
  120. expect( viewRoot.hasClass( 'ck-read-only' ) ).to.be.false;
  121. viewRoot.isReadOnly = true;
  122. expect( viewRoot.hasClass( 'ck-read-only' ) ).to.be.true;
  123. } );
  124. it( 'should call observe on each observer', () => {
  125. // The variable will be overwritten.
  126. view.destroy();
  127. view = new View( new StylesProcessor() );
  128. viewDocument = view.document;
  129. view._renderer.render = sinon.spy();
  130. const domDiv1 = document.createElement( 'div' );
  131. domDiv1.setAttribute( 'id', 'editor' );
  132. const domDiv2 = document.createElement( 'div' );
  133. domDiv2.setAttribute( 'id', 'editor' );
  134. const observerMock = view.addObserver( ObserverMock );
  135. const observerMockGlobalCount = view.addObserver( ObserverMockGlobalCount );
  136. createViewRoot( viewDocument, 'div', 'root1' );
  137. view.attachDomRoot( document.createElement( 'div' ), 'root1' );
  138. sinon.assert.calledOnce( observerMock.observe );
  139. sinon.assert.calledOnce( observerMockGlobalCount.observe );
  140. } );
  141. } );
  142. describe( 'detachDomRoot()', () => {
  143. it( 'should remove DOM root and unbind DOM element', () => {
  144. const domDiv = document.createElement( 'div' );
  145. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  146. view.attachDomRoot( domDiv );
  147. expect( count( view.domRoots ) ).to.equal( 1 );
  148. expect( view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domDiv );
  149. view.detachDomRoot( 'main' );
  150. expect( count( view.domRoots ) ).to.equal( 0 );
  151. expect( view.domConverter.mapViewToDom( viewRoot ) ).to.be.undefined;
  152. domDiv.remove();
  153. } );
  154. it( 'should restore the DOM root attributes to the state before attachDomRoot()', () => {
  155. const domDiv = document.createElement( 'div' );
  156. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  157. domDiv.setAttribute( 'foo', 'bar' );
  158. domDiv.setAttribute( 'data-baz', 'qux' );
  159. domDiv.classList.add( 'foo-class' );
  160. view.attachDomRoot( domDiv );
  161. view.change( writer => {
  162. writer.addClass( 'addedClass', viewRoot );
  163. writer.setAttribute( 'added-attribute', 'foo', viewRoot );
  164. writer.setAttribute( 'foo', 'changed the value', viewRoot );
  165. } );
  166. view.detachDomRoot( 'main' );
  167. const attributes = {};
  168. for ( const attribute of Array.from( domDiv.attributes ) ) {
  169. attributes[ attribute.name ] = attribute.value;
  170. }
  171. expect( attributes ).to.deep.equal( {
  172. foo: 'bar',
  173. 'data-baz': 'qux',
  174. class: 'foo-class'
  175. } );
  176. domDiv.remove();
  177. } );
  178. it( 'should remove the "contenteditable" attribute from the DOM root', () => {
  179. const domDiv = document.createElement( 'div' );
  180. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  181. view.attachDomRoot( domDiv );
  182. view.forceRender();
  183. viewRoot.isReadOnly = false;
  184. expect( domDiv.getAttribute( 'contenteditable' ) ).to.equal( 'true' );
  185. view.detachDomRoot( 'main' );
  186. expect( domDiv.hasAttribute( 'contenteditable' ) ).to.be.false;
  187. domDiv.remove();
  188. } );
  189. it( 'should remove the ".ck-read-only" class from the DOM root', () => {
  190. const domDiv = document.createElement( 'div' );
  191. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  192. view.attachDomRoot( domDiv );
  193. view.forceRender();
  194. viewRoot.isReadOnly = true;
  195. expect( domDiv.classList.contains( 'ck-read-only' ) ).to.be.true;
  196. view.detachDomRoot( 'main' );
  197. expect( domDiv.classList.contains( 'ck-read-only' ) ).to.be.false;
  198. domDiv.remove();
  199. } );
  200. } );
  201. describe( 'addObserver()', () => {
  202. beforeEach( () => {
  203. // The variable will be overwritten.
  204. view.destroy();
  205. view = new View( new StylesProcessor() );
  206. viewDocument = view.document;
  207. view._renderer.render = sinon.spy();
  208. } );
  209. afterEach( () => {
  210. view.destroy();
  211. } );
  212. it( 'should be instantiated and enabled on adding', () => {
  213. const observerMock = view.addObserver( ObserverMock );
  214. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 1 );
  215. expect( observerMock ).to.have.property( 'document', viewDocument );
  216. sinon.assert.calledOnce( observerMock.enable );
  217. } );
  218. it( 'should return observer instance each time addObserver is called', () => {
  219. const observerMock1 = view.addObserver( ObserverMock );
  220. const observerMock2 = view.addObserver( ObserverMock );
  221. expect( observerMock1 ).to.be.instanceof( ObserverMock );
  222. expect( observerMock2 ).to.be.instanceof( ObserverMock );
  223. expect( observerMock1 ).to.equals( observerMock2 );
  224. } );
  225. it( 'should instantiate one observer only once', () => {
  226. view.addObserver( ObserverMockGlobalCount );
  227. view.addObserver( ObserverMockGlobalCount );
  228. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 1 );
  229. expect( instantiated ).to.equal( 1 );
  230. expect( enabled ).to.equal( 1 );
  231. view.addObserver( ObserverMock );
  232. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 2 );
  233. } );
  234. it( 'should instantiate child class of already registered observer', () => {
  235. class ObserverMock extends Observer {
  236. enable() {}
  237. }
  238. class ChildObserverMock extends ObserverMock {
  239. enable() {}
  240. }
  241. view.addObserver( ObserverMock );
  242. view.addObserver( ChildObserverMock );
  243. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 2 );
  244. } );
  245. it( 'should be disabled and re-enabled on render', () => {
  246. const observerMock = view.addObserver( ObserverMock );
  247. view.forceRender();
  248. sinon.assert.calledOnce( observerMock.disable );
  249. sinon.assert.calledOnce( view._renderer.render );
  250. sinon.assert.calledTwice( observerMock.enable );
  251. } );
  252. it( 'should call observe on each root', () => {
  253. createViewRoot( viewDocument, 'div', 'roo1' );
  254. createViewRoot( viewDocument, 'div', 'roo2' );
  255. view.attachDomRoot( document.createElement( 'div' ), 'roo1' );
  256. view.attachDomRoot( document.createElement( 'div' ), 'roo2' );
  257. const observerMock = view.addObserver( ObserverMock );
  258. sinon.assert.calledTwice( observerMock.observe );
  259. } );
  260. } );
  261. describe( 'getObserver()', () => {
  262. it( 'should return observer it it is added', () => {
  263. const addedObserverMock = view.addObserver( ObserverMock );
  264. const getObserverMock = view.getObserver( ObserverMock );
  265. expect( getObserverMock ).to.be.instanceof( ObserverMock );
  266. expect( getObserverMock ).to.equal( addedObserverMock );
  267. } );
  268. it( 'should return undefined if observer is not added', () => {
  269. const getObserverMock = view.getObserver( ObserverMock );
  270. expect( getObserverMock ).to.be.undefined;
  271. } );
  272. } );
  273. describe( 'scrollToTheSelection()', () => {
  274. beforeEach( () => {
  275. // Silence the Rect warnings.
  276. sinon.stub( console, 'warn' );
  277. } );
  278. it( 'does nothing when there are no ranges in the selection', () => {
  279. const stub = sinon.stub( global.window, 'scrollTo' );
  280. view.scrollToTheSelection();
  281. sinon.assert.notCalled( stub );
  282. } );
  283. it( 'scrolls to the first range in selection with an offset', () => {
  284. const root = createViewRoot( viewDocument, 'div', 'main' );
  285. const stub = sinon.stub( global.window, 'scrollTo' );
  286. const range = ViewRange._createIn( root );
  287. view.attachDomRoot( domRoot );
  288. view.change( writer => {
  289. writer.setSelection( range );
  290. } );
  291. // Make sure the window will have to scroll to the domRoot.
  292. Object.assign( domRoot.style, {
  293. position: 'absolute',
  294. top: '-1000px',
  295. left: '-1000px'
  296. } );
  297. view.scrollToTheSelection();
  298. sinon.assert.calledWithMatch( stub, sinon.match.number, sinon.match.number );
  299. } );
  300. } );
  301. describe( 'disableObservers()', () => {
  302. it( 'should disable observers', () => {
  303. const addedObserverMock = view.addObserver( ObserverMock );
  304. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  305. expect( addedObserverMock.disable.called ).to.be.false;
  306. view.disableObservers();
  307. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  308. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  309. } );
  310. } );
  311. describe( 'enableObservers()', () => {
  312. it( 'should enable observers', () => {
  313. const addedObserverMock = view.addObserver( ObserverMock );
  314. view.disableObservers();
  315. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  316. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  317. view.enableObservers();
  318. expect( addedObserverMock.enable.calledTwice ).to.be.true;
  319. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  320. } );
  321. } );
  322. describe( 'focus()', () => {
  323. let domEditable, viewEditable;
  324. beforeEach( () => {
  325. domEditable = document.createElement( 'div' );
  326. domEditable.setAttribute( 'contenteditable', 'true' );
  327. document.body.appendChild( domEditable );
  328. viewEditable = createViewRoot( viewDocument, 'div', 'main' );
  329. view.attachDomRoot( domEditable );
  330. view.change( writer => {
  331. writer.setSelection( viewEditable, 0 );
  332. } );
  333. } );
  334. afterEach( () => {
  335. document.body.removeChild( domEditable );
  336. } );
  337. it( 'should focus editable with selection', () => {
  338. const converterFocusSpy = sinon.spy( view.domConverter, 'focus' );
  339. const renderSpy = sinon.spy( view, 'forceRender' );
  340. view.focus();
  341. expect( converterFocusSpy.called ).to.be.true;
  342. expect( renderSpy.calledOnce ).to.be.true;
  343. expect( document.activeElement ).to.equal( domEditable );
  344. const domSelection = document.getSelection();
  345. expect( domSelection.rangeCount ).to.equal( 1 );
  346. const domRange = domSelection.getRangeAt( 0 );
  347. expect( domRange.startContainer ).to.equal( domEditable );
  348. expect( domRange.startOffset ).to.equal( 0 );
  349. expect( domRange.collapsed ).to.be.true;
  350. } );
  351. it( 'should not focus if document is already focused', () => {
  352. const converterFocusSpy = sinon.spy( view.domConverter, 'focus' );
  353. const renderSpy = sinon.spy( view, 'forceRender' );
  354. viewDocument.isFocused = true;
  355. view.focus();
  356. expect( converterFocusSpy.called ).to.be.false;
  357. expect( renderSpy.called ).to.be.false;
  358. } );
  359. it( 'should not crash when there is no selection', () => {
  360. // Catches the `There is no selection in any editable to focus.` warning in the CK_DEBUG mode.
  361. sinon.stub( console, 'warn' );
  362. view.change( writer => {
  363. writer.setSelection( null );
  364. } );
  365. view.focus();
  366. } );
  367. } );
  368. describe( 'isFocused', () => {
  369. it( 'should change renderer.isFocused too', () => {
  370. expect( viewDocument.isFocused ).to.equal( false );
  371. expect( view._renderer.isFocused ).to.equal( false );
  372. viewDocument.isFocused = true;
  373. expect( viewDocument.isFocused ).to.equal( true );
  374. expect( view._renderer.isFocused ).to.equal( true );
  375. } );
  376. } );
  377. describe( 'isRenderingInProgress', () => {
  378. it( 'should be true while rendering is in progress', () => {
  379. expect( view.isRenderingInProgress ).to.equal( false );
  380. const spy = sinon.spy();
  381. view.on( 'change:isRenderingInProgress', spy );
  382. view.fire( 'render' );
  383. sinon.assert.calledTwice( spy );
  384. sinon.assert.calledWith( spy.firstCall, sinon.match.any, 'isRenderingInProgress', true );
  385. sinon.assert.calledWith( spy.secondCall, sinon.match.any, 'isRenderingInProgress', false );
  386. } );
  387. } );
  388. describe( 'hasDomSelection', () => {
  389. let domElement, domP, domText, viewP, viewText, domSelection;
  390. // Focus tests are too unstable on Firefox to run them.
  391. if ( env.isGecko ) {
  392. return;
  393. }
  394. beforeEach( () => {
  395. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  396. view.attachDomRoot( domRoot );
  397. viewP = new ViewContainerElement( viewDocument, 'p' );
  398. viewText = new ViewText( viewDocument, 'ab' );
  399. viewRoot._appendChild( viewP );
  400. viewP._appendChild( viewText );
  401. view.forceRender();
  402. domElement = createElement( document, 'div', { contenteditable: 'true' } );
  403. document.body.appendChild( domElement );
  404. domSelection = document.getSelection();
  405. domP = domRoot.childNodes[ 0 ];
  406. domText = domP.childNodes[ 0 ];
  407. } );
  408. afterEach( () => {
  409. domElement.remove();
  410. } );
  411. it( 'should be true if selection is inside a DOM root element', done => {
  412. domRoot.focus();
  413. // Both selection need to stay in sync to avoid inf selection loops
  414. // as there's no editing pipeline that would ensure that the view selection
  415. // gets changed based on the selectionChange event. See https://github.com/ckeditor/ckeditor5/issues/6655.
  416. viewDocument.selection._setTo( viewText, 1 );
  417. domSelection.collapse( domText, 1 );
  418. // Wait for async selectionchange event on DOM document.
  419. setTimeout( () => {
  420. expect( view.hasDomSelection ).to.be.true;
  421. done();
  422. }, 1000 );
  423. } );
  424. it( 'should be true if selection is inside a DOM root element - no focus', done => {
  425. domRoot.focus();
  426. // See the previous test.
  427. viewDocument.selection._setTo( viewText, 1 );
  428. domSelection.collapse( domText, 1 );
  429. setTimeout( () => {
  430. // We could also do domRoot.blur() here but it's always better to know where the focus went.
  431. // E.g. if it went to some <input>, the selection would disappear from the editor and the test would fail.
  432. domRoot.blur();
  433. // Wait for async selectionchange event on DOM document.
  434. setTimeout( () => {
  435. expect( view.hasDomSelection ).to.be.true;
  436. expect( view.document.isFocused ).to.be.false;
  437. done();
  438. }, 100 );
  439. }, 100 );
  440. } );
  441. it( 'should be false if selection is outside DOM root element', done => {
  442. domSelection.collapse( domElement, 0 );
  443. // Wait for async selectionchange event on DOM document.
  444. setTimeout( () => {
  445. expect( view.hasDomSelection ).to.be.false;
  446. done();
  447. }, 100 );
  448. } );
  449. } );
  450. describe( 'forceRender()', () => {
  451. it( 'disable observers, renders and enable observers', () => {
  452. const observerMock = view.addObserver( ObserverMock );
  453. const renderStub = sinon.stub( view._renderer, 'render' );
  454. view.forceRender();
  455. sinon.assert.callOrder( observerMock.disable, renderStub, observerMock.enable );
  456. } );
  457. it( 'should fire `render` and `layoutChanged` even if there were no changes', () => {
  458. const renderSpy = sinon.spy();
  459. const layoutChangedSpy = sinon.spy();
  460. view.on( 'render', renderSpy );
  461. view.document.on( 'layoutChanged', layoutChangedSpy );
  462. view.forceRender();
  463. sinon.assert.calledOnce( renderSpy );
  464. sinon.assert.calledOnce( layoutChangedSpy );
  465. } );
  466. it( 'should fire `render` and `layoutChanged` if there is some buffered change', () => {
  467. const renderSpy = sinon.spy();
  468. const layoutChangedSpy = sinon.spy();
  469. view.on( 'render', renderSpy );
  470. view.document.on( 'layoutChanged', layoutChangedSpy );
  471. view.document.selection._setTo( null );
  472. view.forceRender();
  473. sinon.assert.calledOnce( renderSpy );
  474. sinon.assert.calledOnce( layoutChangedSpy );
  475. } );
  476. } );
  477. describe( 'view and DOM integration', () => {
  478. it( 'should remove content of the DOM', () => {
  479. const domDiv = createElement( document, 'div', { id: 'editor' }, [
  480. createElement( document, 'p' ),
  481. createElement( document, 'p' )
  482. ] );
  483. const view = new View( new StylesProcessor() );
  484. const viewDocument = view.document;
  485. createViewRoot( viewDocument, 'div', 'main' );
  486. view.attachDomRoot( domDiv );
  487. view.forceRender();
  488. expect( domDiv.childNodes.length ).to.equal( 1 );
  489. expect( view.domConverter.isBlockFiller( domDiv.childNodes[ 0 ] ) ).to.be.true;
  490. view.destroy();
  491. domDiv.remove();
  492. } );
  493. it( 'should render changes in the Document', () => {
  494. const domDiv = document.createElement( 'div' );
  495. const view = new View( new StylesProcessor() );
  496. const viewDocument = view.document;
  497. createViewRoot( viewDocument, 'div', 'main' );
  498. view.attachDomRoot( domDiv );
  499. viewDocument.getRoot()._appendChild( new ViewElement( viewDocument, 'p' ) );
  500. view.forceRender();
  501. expect( domDiv.childNodes.length ).to.equal( 1 );
  502. expect( domDiv.childNodes[ 0 ].tagName ).to.equal( 'P' );
  503. view.destroy();
  504. } );
  505. it( 'should render attribute changes', () => {
  506. const domRoot = document.createElement( 'div' );
  507. const view = new View( new StylesProcessor() );
  508. const viewDocument = view.document;
  509. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  510. view.attachDomRoot( domRoot );
  511. const viewP = new ViewElement( viewDocument, 'p', { class: 'foo' } );
  512. viewRoot._appendChild( viewP );
  513. view.forceRender();
  514. expect( domRoot.childNodes.length ).to.equal( 1 );
  515. expect( domRoot.childNodes[ 0 ].getAttribute( 'class' ) ).to.equal( 'foo' );
  516. viewP._setAttribute( 'class', 'bar' );
  517. view.forceRender();
  518. expect( domRoot.childNodes.length ).to.equal( 1 );
  519. expect( domRoot.childNodes[ 0 ].getAttribute( 'class' ) ).to.equal( 'bar' );
  520. view.destroy();
  521. domRoot.remove();
  522. } );
  523. } );
  524. describe( 'change()', () => {
  525. it( 'should throw when someone tries to change view during rendering', () => {
  526. const domDiv = document.createElement( 'div' );
  527. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  528. let renderingCalled = false;
  529. view.attachDomRoot( domDiv );
  530. view.change( writer => {
  531. const p = writer.createContainerElement( 'p' );
  532. const ui = writer.createUIElement( 'span', null, function( domDocument ) {
  533. const element = this.toDomElement( domDocument );
  534. expectToThrowCKEditorError( () => {
  535. view.change( () => {} );
  536. }, /^cannot-change-view-tree/, view );
  537. renderingCalled = true;
  538. return element;
  539. } );
  540. writer.insert( ViewPosition._createAt( p, 0 ), ui );
  541. writer.insert( ViewPosition._createAt( viewRoot, 0 ), p );
  542. } );
  543. expect( renderingCalled ).to.be.true;
  544. domDiv.remove();
  545. } );
  546. it( 'should throw when someone tries to use change() method in post-fixer', () => {
  547. const domDiv = document.createElement( 'div' );
  548. createViewRoot( viewDocument, 'div', 'main' );
  549. view.attachDomRoot( domDiv );
  550. viewDocument.registerPostFixer( () => {
  551. expectToThrowCKEditorError( () => {
  552. view.change( () => {} );
  553. }, /^cannot-change-view-tree/, view );
  554. } );
  555. view.forceRender();
  556. domDiv.remove();
  557. } );
  558. it( 'should fire render event and it should trigger rendering before listeners on normal priority', () => {
  559. const renderSpy = sinon.spy( view._renderer, 'render' );
  560. const eventSpy = sinon.spy();
  561. view.on( 'render', eventSpy );
  562. view.change( writer => {
  563. writer.setSelection( null );
  564. } );
  565. sinon.assert.callOrder( renderSpy, eventSpy );
  566. } );
  567. it( 'should fire render event once for nested change blocks', () => {
  568. const renderSpy = sinon.spy( view._renderer, 'render' );
  569. const eventSpy = sinon.spy();
  570. const viewEditable = createViewRoot( viewDocument, 'div', 'main' );
  571. view.on( 'render', eventSpy );
  572. view.change( writer => {
  573. writer.setSelection( null );
  574. view.change( writer => {
  575. writer.setSelection( viewEditable, 0 );
  576. } );
  577. view.change( writer => {
  578. writer.setSelection( null );
  579. view.change( writer => {
  580. writer.setSelection( viewEditable, 0 );
  581. } );
  582. } );
  583. view.change( writer => {
  584. writer.setSelection( null );
  585. } );
  586. } );
  587. sinon.assert.calledOnce( renderSpy );
  588. sinon.assert.calledOnce( eventSpy );
  589. sinon.assert.callOrder( renderSpy, eventSpy );
  590. } );
  591. it( 'should fire render event once even if render is called during the change', () => {
  592. const renderSpy = sinon.spy( view._renderer, 'render' );
  593. const eventSpy = sinon.spy();
  594. view.on( 'render', eventSpy );
  595. view.change( () => {
  596. view.forceRender();
  597. view.change( writer => {
  598. writer.setSelection( null );
  599. view.forceRender();
  600. } );
  601. view.forceRender();
  602. } );
  603. sinon.assert.calledOnce( renderSpy );
  604. sinon.assert.calledOnce( eventSpy );
  605. sinon.assert.callOrder( renderSpy, eventSpy );
  606. } );
  607. it( 'should call post-fixers after change but before rendering', () => {
  608. const postFixer1 = sinon.spy( () => false );
  609. const postFixer2 = sinon.spy( () => false );
  610. const changeSpy = sinon.spy();
  611. const eventSpy = sinon.spy();
  612. viewDocument.registerPostFixer( postFixer1 );
  613. viewDocument.registerPostFixer( postFixer2 );
  614. view.on( 'render', eventSpy );
  615. view.change( writer => {
  616. changeSpy();
  617. writer.setSelection( null );
  618. } );
  619. sinon.assert.calledOnce( postFixer1 );
  620. sinon.assert.calledOnce( postFixer2 );
  621. sinon.assert.calledOnce( changeSpy );
  622. sinon.assert.calledOnce( eventSpy );
  623. sinon.assert.callOrder( changeSpy, postFixer1, postFixer2, eventSpy );
  624. } );
  625. it( 'should call post-fixers until all are done', () => {
  626. let called = false;
  627. const postFixer1 = sinon.spy();
  628. const postFixer2 = sinon.spy();
  629. const changeSpy = sinon.spy();
  630. const eventSpy = sinon.spy();
  631. viewDocument.registerPostFixer( () => {
  632. if ( !called ) {
  633. called = true;
  634. postFixer1();
  635. return true;
  636. }
  637. postFixer2();
  638. return false;
  639. } );
  640. view.on( 'render', eventSpy );
  641. view.change( writer => {
  642. changeSpy();
  643. writer.setSelection( null );
  644. } );
  645. sinon.assert.calledOnce( postFixer1 );
  646. sinon.assert.calledOnce( postFixer2 );
  647. sinon.assert.calledOnce( changeSpy );
  648. sinon.assert.calledOnce( eventSpy );
  649. sinon.assert.callOrder( changeSpy, postFixer1, postFixer2, eventSpy );
  650. } );
  651. it( 'should return result of the callback', () => {
  652. const result = view.change( () => {
  653. return 'FooBar';
  654. } );
  655. expect( result ).to.equal( 'FooBar' );
  656. } );
  657. it( 'should return result of the callback with nested change block', () => {
  658. let result2 = false;
  659. let result3 = false;
  660. const result1 = view.change( () => {
  661. return view.change( () => {
  662. result2 = view.change( () => {
  663. return true;
  664. } );
  665. result3 = view.change( () => {} );
  666. return 42;
  667. } );
  668. } );
  669. expect( result1 ).to.equal( 42 );
  670. expect( result2 ).to.equal( true );
  671. expect( result3 ).to.undefined;
  672. } );
  673. it( 'should rethrow native errors as they are in the dubug=true mode', () => {
  674. const error = new TypeError( 'foo' );
  675. expect( () => {
  676. view.change( () => {
  677. throw error;
  678. } );
  679. } ).to.throw( TypeError, /foo/ );
  680. } );
  681. it( 'should rethrow custom CKEditorError errors', () => {
  682. expectToThrowCKEditorError( () => {
  683. view.change( () => {
  684. // eslint-disable-next-line ckeditor5-rules/ckeditor-error-message
  685. throw new CKEditorError( 'foo', view );
  686. } );
  687. }, /foo/, view );
  688. } );
  689. } );
  690. describe( 'createPositionAt()', () => {
  691. it( 'should return instance of Position', () => {
  692. createViewRoot( viewDocument, 'div', 'main' );
  693. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  694. expect( view.createPositionAt( viewDocument.getRoot(), 0 ) ).to.be.instanceof( ViewPosition );
  695. } );
  696. } );
  697. describe( 'createPositionAfter()', () => {
  698. it( 'should return instance of Position', () => {
  699. createViewRoot( viewDocument, 'div', 'main' );
  700. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  701. expect( view.createPositionAfter( viewDocument.getRoot().getChild( 0 ) ) ).to.be.instanceof( ViewPosition );
  702. } );
  703. } );
  704. describe( 'createPositionBefore()', () => {
  705. it( 'should return instance of Position', () => {
  706. createViewRoot( viewDocument, 'div', 'main' );
  707. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  708. expect( view.createPositionBefore( viewDocument.getRoot().getChild( 0 ) ) ).to.be.instanceof( ViewPosition );
  709. } );
  710. } );
  711. describe( 'createRange()', () => {
  712. it( 'should return instance of Range', () => {
  713. createViewRoot( viewDocument, 'div', 'main' );
  714. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  715. expect( view.createRange( view.createPositionAt( viewDocument.getRoot(), 0 ) ) ).to.be.instanceof( ViewRange );
  716. } );
  717. } );
  718. describe( 'createRangeIn()', () => {
  719. it( 'should return instance of Range', () => {
  720. createViewRoot( viewDocument, 'div', 'main' );
  721. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  722. expect( view.createRangeIn( viewDocument.getRoot().getChild( 0 ) ) ).to.be.instanceof( ViewRange );
  723. } );
  724. } );
  725. describe( 'createRangeOn()', () => {
  726. it( 'should return instance of Range', () => {
  727. createViewRoot( viewDocument, 'div', 'main' );
  728. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  729. expect( view.createRangeOn( viewDocument.getRoot().getChild( 0 ) ) ).to.be.instanceof( ViewRange );
  730. } );
  731. } );
  732. describe( 'createSelection()', () => {
  733. it( 'should return instance of Selection', () => {
  734. createViewRoot( viewDocument, 'div', 'main' );
  735. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  736. expect( view.createSelection() ).to.be.instanceof( ViewSelection );
  737. } );
  738. } );
  739. describe( 'destroy()', () => {
  740. it( 'should destroy all observers', () => {
  741. const observerMock = view.addObserver( ObserverMock );
  742. view.destroy();
  743. sinon.assert.calledOnce( observerMock.destroy );
  744. } );
  745. } );
  746. } );