8
0

placeholder.js 6.7 KB

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