placeholder.js 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import { attachPlaceholder, detachPlaceholder } from '../../src/view/placeholder';
  6. import createViewRoot from './_utils/createroot';
  7. import ViewContainerElement from '../../src/view/containerelement';
  8. import ViewDocument from '../../src/view/document';
  9. import ViewRange from '../../src/view/range';
  10. import { setData } from '../../src/dev-utils/view';
  11. describe( 'placeholder', () => {
  12. let viewDocument, viewRoot;
  13. beforeEach( () => {
  14. viewDocument = new ViewDocument();
  15. viewRoot = createViewRoot( viewDocument );
  16. viewDocument.isFocused = true;
  17. } );
  18. describe( 'createPlaceholder', () => {
  19. it( 'should throw if element is not inside document', () => {
  20. const element = new ViewContainerElement( 'div' );
  21. expect( () => {
  22. attachPlaceholder( element, 'foo bar baz' );
  23. } ).to.throw( 'view-placeholder-element-is-detached' );
  24. } );
  25. it( 'should attach proper CSS class and data attribute', () => {
  26. setData( viewDocument, '<div></div><div>{another div}</div>' );
  27. const element = viewRoot.getChild( 0 );
  28. attachPlaceholder( element, 'foo bar baz' );
  29. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
  30. expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
  31. } );
  32. it( 'if element has children set only data attribute', () => {
  33. setData( viewDocument, '<div>first div</div><div>{another div}</div>' );
  34. const element = viewRoot.getChild( 0 );
  35. attachPlaceholder( element, 'foo bar baz' );
  36. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
  37. expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
  38. } );
  39. it( 'if element has only ui elements, set CSS class and data attribute', () => {
  40. setData( viewDocument, '<div><ui:span></ui:span><ui:span></ui:span></div><div>{another div}</div>' );
  41. const element = viewRoot.getChild( 0 );
  42. attachPlaceholder( element, 'foo bar baz' );
  43. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
  44. expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
  45. } );
  46. it( 'if element has selection inside set only data attribute', () => {
  47. setData( viewDocument, '<div>[]</div><div>another div</div>' );
  48. const element = viewRoot.getChild( 0 );
  49. attachPlaceholder( element, 'foo bar baz' );
  50. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
  51. expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
  52. } );
  53. it( 'if element has selection inside but document is blurred should contain placeholder CSS class', () => {
  54. setData( viewDocument, '<div>[]</div><div>another div</div>' );
  55. const element = viewRoot.getChild( 0 );
  56. viewDocument.isFocused = false;
  57. attachPlaceholder( element, 'foo bar baz' );
  58. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
  59. expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
  60. } );
  61. it( 'use check function if one is provided', () => {
  62. setData( viewDocument, '<div></div><div>{another div}</div>' );
  63. const element = viewRoot.getChild( 0 );
  64. const spy = sinon.spy( () => false );
  65. attachPlaceholder( element, 'foo bar baz', spy );
  66. sinon.assert.calledOnce( spy );
  67. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
  68. expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
  69. } );
  70. it( 'should remove CSS class if selection is moved inside', () => {
  71. setData( viewDocument, '<div></div><div>{another div}</div>' );
  72. const element = viewRoot.getChild( 0 );
  73. attachPlaceholder( element, 'foo bar baz' );
  74. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
  75. expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
  76. viewDocument.selection.setRanges( [ ViewRange.createIn( element ) ] );
  77. viewDocument.render();
  78. expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
  79. } );
  80. it( 'should change placeholder settings when called twice', () => {
  81. setData( viewDocument, '<div></div><div>{another div}</div>' );
  82. const element = viewRoot.getChild( 0 );
  83. attachPlaceholder( element, 'foo bar baz' );
  84. attachPlaceholder( element, 'new text' );
  85. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'new text' );
  86. expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
  87. } );
  88. it( 'should not throw when element is no longer in document', () => {
  89. setData( viewDocument, '<div></div><div>{another div}</div>' );
  90. const element = viewRoot.getChild( 0 );
  91. attachPlaceholder( element, 'foo bar baz' );
  92. setData( viewDocument, '<p>paragraph</p>' );
  93. viewDocument.render();
  94. } );
  95. it( 'should allow to add placeholder to elements from different documents', () => {
  96. setData( viewDocument, '<div></div><div>{another div}</div>' );
  97. const element = viewRoot.getChild( 0 );
  98. const secondDocument = new ViewDocument();
  99. secondDocument.isFocused = true;
  100. const secondRoot = createViewRoot( secondDocument );
  101. setData( secondDocument, '<div></div><div>{another div}</div>' );
  102. const secondElement = secondRoot.getChild( 0 );
  103. attachPlaceholder( element, 'first placeholder' );
  104. attachPlaceholder( secondElement, 'second placeholder' );
  105. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'first placeholder' );
  106. expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
  107. expect( secondElement.getAttribute( 'data-placeholder' ) ).to.equal( 'second placeholder' );
  108. expect( secondElement.hasClass( 'ck-placeholder' ) ).to.be.true;
  109. // Move selection to the elements with placeholders.
  110. viewDocument.selection.setRanges( [ ViewRange.createIn( element ) ] );
  111. secondDocument.selection.setRanges( [ ViewRange.createIn( secondElement ) ] );
  112. // Render changes.
  113. viewDocument.render();
  114. secondDocument.render();
  115. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'first placeholder' );
  116. expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
  117. expect( secondElement.getAttribute( 'data-placeholder' ) ).to.equal( 'second placeholder' );
  118. expect( secondElement.hasClass( 'ck-placeholder' ) ).to.be.false;
  119. } );
  120. } );
  121. describe( 'detachPlaceholder', () => {
  122. it( 'should remove placeholder from element', () => {
  123. setData( viewDocument, '<div></div><div>{another div}</div>' );
  124. const element = viewRoot.getChild( 0 );
  125. attachPlaceholder( element, 'foo bar baz' );
  126. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
  127. expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
  128. detachPlaceholder( element );
  129. expect( element.hasAttribute( 'data-placeholder' ) ).to.be.false;
  130. expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
  131. } );
  132. } );
  133. } );