placeholder.js 6.7 KB

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