8
0

placeholder.js 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  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 selection inside set only data attribute', () => {
  39. setData( viewDocument, '<div>[]</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.false;
  44. } );
  45. it( 'if element has selection inside but document is blurred should contain placeholder CSS class', () => {
  46. setData( viewDocument, '<div>[]</div><div>another div</div>' );
  47. const element = viewRoot.getChild( 0 );
  48. viewDocument.isFocused = false;
  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.true;
  52. } );
  53. it( 'use check function if one is provided', () => {
  54. setData( viewDocument, '<div></div><div>{another div}</div>' );
  55. const element = viewRoot.getChild( 0 );
  56. const spy = sinon.spy( () => false );
  57. attachPlaceholder( element, 'foo bar baz', spy );
  58. sinon.assert.calledOnce( spy );
  59. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
  60. expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
  61. } );
  62. it( 'should remove CSS class if selection is moved inside', () => {
  63. setData( viewDocument, '<div></div><div>{another div}</div>' );
  64. const element = viewRoot.getChild( 0 );
  65. attachPlaceholder( element, 'foo bar baz' );
  66. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
  67. expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
  68. viewDocument.selection.setRanges( [ ViewRange.createIn( element ) ] );
  69. viewDocument.render();
  70. expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
  71. } );
  72. it( 'should change placeholder settings when called twice', () => {
  73. setData( viewDocument, '<div></div><div>{another div}</div>' );
  74. const element = viewRoot.getChild( 0 );
  75. attachPlaceholder( element, 'foo bar baz' );
  76. attachPlaceholder( element, 'new text' );
  77. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'new text' );
  78. expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
  79. } );
  80. it( 'should not throw when element is no longer in document', () => {
  81. setData( viewDocument, '<div></div><div>{another div}</div>' );
  82. const element = viewRoot.getChild( 0 );
  83. attachPlaceholder( element, 'foo bar baz' );
  84. setData( viewDocument, '<p>paragraph</p>' );
  85. viewDocument.render();
  86. } );
  87. it( 'should allow to add placeholder to elements from different documents', () => {
  88. setData( viewDocument, '<div></div><div>{another div}</div>' );
  89. const element = viewRoot.getChild( 0 );
  90. const secondDocument = new ViewDocument();
  91. secondDocument.isFocused = true;
  92. const secondRoot = secondDocument.createRoot( 'main' );
  93. setData( secondDocument, '<div></div><div>{another div}</div>' );
  94. const secondElement = secondRoot.getChild( 0 );
  95. attachPlaceholder( element, 'first placeholder' );
  96. attachPlaceholder( secondElement, 'second placeholder' );
  97. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'first placeholder' );
  98. expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
  99. expect( secondElement.getAttribute( 'data-placeholder' ) ).to.equal( 'second placeholder' );
  100. expect( secondElement.hasClass( 'ck-placeholder' ) ).to.be.true;
  101. // Move selection to the elements with placeholders.
  102. viewDocument.selection.setRanges( [ ViewRange.createIn( element ) ] );
  103. secondDocument.selection.setRanges( [ ViewRange.createIn( secondElement ) ] );
  104. // Render changes.
  105. viewDocument.render();
  106. secondDocument.render();
  107. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'first placeholder' );
  108. expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
  109. expect( secondElement.getAttribute( 'data-placeholder' ) ).to.equal( 'second placeholder' );
  110. expect( secondElement.hasClass( 'ck-placeholder' ) ).to.be.false;
  111. } );
  112. } );
  113. describe( 'detachPlaceholder', () => {
  114. it( 'should remove placeholder from element', () => {
  115. setData( viewDocument, '<div></div><div>{another div}</div>' );
  116. const element = viewRoot.getChild( 0 );
  117. attachPlaceholder( element, 'foo bar baz' );
  118. expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
  119. expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
  120. detachPlaceholder( element );
  121. expect( element.hasAttribute( 'data-placeholder' ) ).to.be.false;
  122. expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
  123. } );
  124. } );
  125. } );