| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- import {
- enablePlaceholder,
- disablePlaceholder,
- showPlaceholder,
- hidePlaceholder,
- needsPlaceholder
- } from '../../src/view/placeholder';
- import createViewRoot from './_utils/createroot';
- import View from '../../src/view/view';
- import ViewRange from '../../src/view/range';
- import { setData } from '../../src/dev-utils/view';
- import { StylesProcessor } from '../../src/view/stylesmap';
- describe( 'placeholder', () => {
- let view, viewDocument, viewRoot;
- beforeEach( () => {
- view = new View( new StylesProcessor() );
- viewDocument = view.document;
- viewRoot = createViewRoot( viewDocument );
- viewDocument.isFocused = true;
- } );
- describe( 'enablePlaceholder', () => {
- it( 'should attach proper CSS class and data attribute', () => {
- setData( view, '<div></div><div>{another div}</div>' );
- const element = viewRoot.getChild( 0 );
- enablePlaceholder( {
- view,
- element,
- text: 'foo bar baz'
- } );
- expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
- } );
- it( 'should attach proper CSS class and data attribute (isDirectHost=false)', () => {
- setData( view, '<p></p>' );
- viewDocument.isFocused = false;
- enablePlaceholder( {
- view,
- element: viewRoot,
- text: 'foo bar baz',
- isDirectHost: false
- } );
- expect( viewRoot.getChild( 0 ).getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
- expect( viewRoot.getChild( 0 ).hasClass( 'ck-placeholder' ) ).to.be.true;
- } );
- it( 'if element has children set only data attribute', () => {
- setData( view, '<div>first div</div><div>{another div}</div>' );
- const element = viewRoot.getChild( 0 );
- enablePlaceholder( {
- view,
- element,
- text: 'foo bar baz'
- } );
- expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
- } );
- it( 'if element has only ui elements, set CSS class and data attribute', () => {
- setData( view, '<div><ui:span></ui:span><ui:span></ui:span></div><div>{another div}</div>' );
- const element = viewRoot.getChild( 0 );
- enablePlaceholder( {
- view,
- element,
- text: 'foo bar baz'
- } );
- expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
- } );
- it( 'if element has selection inside set only data attribute', () => {
- setData( view, '<div>[]</div><div>another div</div>' );
- const element = viewRoot.getChild( 0 );
- enablePlaceholder( {
- view,
- element,
- text: 'foo bar baz'
- } );
- expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
- } );
- it( 'if element has selection inside but document is blurred should contain placeholder CSS class', () => {
- setData( view, '<div>[]</div><div>another div</div>' );
- const element = viewRoot.getChild( 0 );
- viewDocument.isFocused = false;
- enablePlaceholder( {
- view,
- element,
- text: 'foo bar baz'
- } );
- view.forceRender();
- expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
- } );
- it( 'should remove CSS class if selection is moved inside', () => {
- setData( view, '<div></div><div>{another div}</div>' );
- const element = viewRoot.getChild( 0 );
- enablePlaceholder( {
- view,
- element,
- text: 'foo bar baz'
- } );
- expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
- view.change( writer => {
- writer.setSelection( ViewRange._createIn( element ) );
- } );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
- } );
- it( 'should change placeholder settings when called twice', () => {
- setData( view, '<div></div><div>{another div}</div>' );
- const element = viewRoot.getChild( 0 );
- enablePlaceholder( {
- view,
- element,
- text: 'foo bar baz'
- } );
- enablePlaceholder( {
- view,
- element,
- text: 'new text'
- } );
- expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'new text' );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
- } );
- it( 'should not throw when element is no longer in document', () => {
- setData( view, '<div></div><div>{another div}</div>' );
- const element = viewRoot.getChild( 0 );
- enablePlaceholder( {
- view,
- element,
- text: 'foo bar baz'
- } );
- setData( view, '<p>paragraph</p>' );
- view.forceRender();
- } );
- it( 'should allow to add placeholder to elements from different documents', () => {
- setData( view, '<div></div><div>{another div}</div>' );
- const element = viewRoot.getChild( 0 );
- const secondView = new View( new StylesProcessor() );
- const secondDocument = secondView.document;
- secondDocument.isFocused = true;
- const secondRoot = createViewRoot( secondDocument );
- setData( secondView, '<div></div><div>{another div}</div>' );
- const secondElement = secondRoot.getChild( 0 );
- enablePlaceholder( {
- view,
- element,
- text: 'first placeholder'
- } );
- enablePlaceholder( {
- view: secondView,
- element: secondElement,
- text: 'second placeholder'
- } );
- expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'first placeholder' );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
- expect( secondElement.getAttribute( 'data-placeholder' ) ).to.equal( 'second placeholder' );
- expect( secondElement.hasClass( 'ck-placeholder' ) ).to.be.true;
- // Move selection to the elements with placeholders.
- view.change( writer => {
- writer.setSelection( ViewRange._createIn( element ) );
- } );
- secondView.change( writer => {
- writer.setSelection( ViewRange._createIn( secondElement ) );
- } );
- expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'first placeholder' );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
- expect( secondElement.getAttribute( 'data-placeholder' ) ).to.equal( 'second placeholder' );
- expect( secondElement.hasClass( 'ck-placeholder' ) ).to.be.false;
- } );
- it( 'should update placeholder before rendering', () => {
- setData( view, '<div></div><div>{another div}</div>' );
- const element = viewRoot.getChild( 0 );
- enablePlaceholder( {
- view,
- element,
- text: 'foo bar baz'
- } );
- view.change( writer => {
- writer.setSelection( ViewRange._createIn( element ) );
- // Here we are before rendering - placeholder is visible in first element;
- expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
- } );
- // After rendering - placeholder should be invisible since selection is moved there.
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
- } );
- it( 'should not set attributes/class when multiple children (isDirectHost=false)', () => {
- setData( view, '<p></p><p></p>' );
- viewDocument.isFocused = false;
- enablePlaceholder( {
- view,
- element: viewRoot,
- text: 'foo bar baz',
- isDirectHost: false
- } );
- expect( viewRoot.getChild( 0 ).hasAttribute( 'data-placeholder' ) ).to.be.false;
- expect( viewRoot.getChild( 0 ).hasClass( 'ck-placeholder' ) ).to.be.false;
- } );
- it( 'should not set attributes/class when first child is not element (isDirectHost=false)', () => {
- setData( view, '<ui:span></ui:span>' );
- viewDocument.isFocused = false;
- enablePlaceholder( {
- view,
- element: viewRoot,
- text: 'foo bar baz',
- isDirectHost: false
- } );
- expect( viewRoot.getChild( 0 ).hasAttribute( 'data-placeholder' ) ).to.be.false;
- expect( viewRoot.getChild( 0 ).hasClass( 'ck-placeholder' ) ).to.be.false;
- } );
- } );
- describe( 'disablePlaceholder', () => {
- it( 'should remove placeholder from element', () => {
- setData( view, '<div></div><div>{another div}</div>' );
- const element = viewRoot.getChild( 0 );
- enablePlaceholder( {
- view,
- element,
- text: 'foo bar baz'
- } );
- expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
- disablePlaceholder( view, element );
- expect( element.hasAttribute( 'data-placeholder' ) ).to.be.false;
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
- } );
- it( 'should not blow up when called on element without placeholder', () => {
- setData( view, '<div></div><div>{another div}</div>' );
- const element = viewRoot.getChild( 0 );
- disablePlaceholder( view, element );
- expect( element.hasAttribute( 'data-placeholder' ) ).to.be.false;
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
- } );
- it( 'should remove placeholder from element (isDirectHost=false)', () => {
- setData( view, '<p></p>' );
- viewDocument.isFocused = false;
- enablePlaceholder( {
- view,
- element: viewRoot,
- text: 'foo bar baz',
- isDirectHost: false
- } );
- expect( viewRoot.getChild( 0 ).getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' );
- expect( viewRoot.getChild( 0 ).hasClass( 'ck-placeholder' ) ).to.be.true;
- disablePlaceholder( view, viewRoot );
- expect( viewRoot.getChild( 0 ).hasAttribute( 'data-placeholder' ) ).to.be.false;
- expect( viewRoot.getChild( 0 ).hasClass( 'ck-placeholder' ) ).to.be.false;
- } );
- } );
- describe( 'showPlaceholder', () => {
- it( 'should add the ck-placholder class if an element does not have it', () => {
- setData( view, '<div></div>' );
- const element = viewRoot.getChild( 0 );
- const result = view.change( writer => showPlaceholder( writer, element ) );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
- expect( result ).to.be.true;
- } );
- it( 'should do nothing if an element already has the ck-placeholder class', () => {
- setData( view, '<div class="ck-placeholder"></div>' );
- const element = viewRoot.getChild( 0 );
- let spy;
- const result = view.change( writer => {
- spy = sinon.spy( writer, 'addClass' );
- return showPlaceholder( writer, element );
- } );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.true;
- expect( result ).to.be.false;
- sinon.assert.notCalled( spy );
- } );
- } );
- describe( 'hidePlaceholder', () => {
- it( 'should remove the ck-placholder class if an element has it', () => {
- setData( view, '<div class="ck-placeholder"></div>' );
- const element = viewRoot.getChild( 0 );
- const result = view.change( writer => hidePlaceholder( writer, element ) );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
- expect( result ).to.be.true;
- } );
- it( 'should do nothing if an element has no ck-placeholder class', () => {
- setData( view, '<div></div>' );
- const element = viewRoot.getChild( 0 );
- let spy;
- const result = view.change( writer => {
- spy = sinon.spy( writer, 'removeClass' );
- return hidePlaceholder( writer, element );
- } );
- expect( element.hasClass( 'ck-placeholder' ) ).to.be.false;
- expect( result ).to.be.false;
- sinon.assert.notCalled( spy );
- } );
- } );
- describe( 'needsPlaceholder', () => {
- it( 'should return false if element was removed from the document', () => {
- setData( view, '<p></p>' );
- viewDocument.isFocused = false;
- const element = viewRoot.getChild( 0 );
- expect( needsPlaceholder( element ) ).to.be.true;
- view.change( writer => {
- writer.remove( element );
- } );
- expect( needsPlaceholder( element ) ).to.be.false;
- } );
- it( 'should return true if element is empty and document is blurred', () => {
- setData( view, '<p></p>' );
- viewDocument.isFocused = false;
- const element = viewRoot.getChild( 0 );
- expect( needsPlaceholder( element ) ).to.be.true;
- } );
- it( 'should return true if element hosts UI elements only and document is blurred', () => {
- setData( view, '<p><ui:span></ui:span></p>' );
- viewDocument.isFocused = false;
- const element = viewRoot.getChild( 0 );
- expect( needsPlaceholder( element ) ).to.be.true;
- } );
- it( 'should return true when document is focused but selection anchored somewhere else', () => {
- setData( view, '<p></p><p>{moo}</p>' );
- viewDocument.isFocused = true;
- const element = viewRoot.getChild( 0 );
- expect( needsPlaceholder( element ) ).to.be.true;
- } );
- } );
- } );
|