| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451 |
- /**
- * @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 ViewContainerElement from '@ckeditor/ckeditor5-engine/src/view/containerelement';
- import ViewDowncastWriter from '@ckeditor/ckeditor5-engine/src/view/downcastwriter';
- import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
- import ListEditing from '../src/listediting';
- import ListStyleEditing from '../src/liststyleediting';
- import { createViewListItemElement, getSiblingListItem, getSiblingNodes } from '../src/utils';
- describe( 'utils', () => {
- let writer;
- beforeEach( () => {
- writer = new ViewDowncastWriter( {} );
- } );
- describe( 'createViewListItemElement()', () => {
- it( 'should create ViewContainerElement', () => {
- const item = createViewListItemElement( writer );
- expect( item ).to.be.instanceof( ViewContainerElement );
- } );
- it( 'should have li name', () => {
- const item = createViewListItemElement( writer );
- expect( item.name ).to.equal( 'li' );
- } );
- describe( 'getFillerOffset', () => {
- it( 'should return 0 if item is empty', () => {
- const item = createViewListItemElement( writer );
- expect( item.getFillerOffset() ).to.equal( 0 );
- } );
- it( 'should return 0 if item has only lists as children', () => {
- const innerListItem1 = createViewListItemElement( writer );
- writer.insert(
- writer.createPositionAt( innerListItem1, 0 ),
- writer.createText( 'foo' )
- );
- const innerListItem2 = createViewListItemElement( writer );
- writer.insert(
- writer.createPositionAt( innerListItem2, 0 ),
- writer.createText( 'bar' )
- );
- const innerList = writer.createContainerElement( 'ul' );
- writer.insert( writer.createPositionAt( innerList, 0 ), innerListItem1 );
- writer.insert( writer.createPositionAt( innerList, 0 ), innerListItem2 );
- const outerListItem = createViewListItemElement( writer );
- writer.insert( writer.createPositionAt( outerListItem, 0 ), innerList );
- expect( outerListItem.getFillerOffset() ).to.equal( 0 );
- } );
- it( 'should return null if item has non-list contents', () => {
- const item = createViewListItemElement( writer );
- writer.insert(
- writer.createPositionAt( item, 0 ),
- writer.createText( 'foo' )
- );
- expect( item.getFillerOffset() ).to.be.null;
- } );
- // Block filler is required after the `<br>` element if the element is the last child in the container.
- // See: https://github.com/ckeditor/ckeditor5/issues/1312#issuecomment-436669045.
- describe( 'for <br> elements in container', () => {
- it( 'returns offset of the last child which is the <br> element (1)', () => {
- const item = createViewListItemElement( writer );
- writer.insert( writer.createPositionAt( item, 0 ), writer.createEmptyElement( 'br' ) );
- expect( item.getFillerOffset() ).to.equal( 1 );
- } );
- it( 'returns offset of the last child which is the <br> element (2)', () => {
- const item = createViewListItemElement( writer );
- writer.insert( writer.createPositionAt( item, 0 ), writer.createEmptyElement( 'br' ) );
- writer.insert( writer.createPositionAt( item, 1 ), writer.createEmptyElement( 'br' ) );
- expect( item.getFillerOffset() ).to.equal( 2 );
- } );
- it( 'always returns the last <br> element in the container', () => {
- const item = createViewListItemElement( writer );
- writer.insert( writer.createPositionAt( item, 0 ), writer.createText( 'foo' ) );
- writer.insert( writer.createPositionAt( item, 1 ), writer.createEmptyElement( 'br' ) );
- writer.insert( writer.createPositionAt( item, 2 ), writer.createEmptyElement( 'br' ) );
- expect( item.getFillerOffset() ).to.equal( 3 );
- } );
- it( 'works fine with non-empty container with multi <br> elements', () => {
- const item = createViewListItemElement( writer );
- writer.insert( writer.createPositionAt( item, 0 ), writer.createText( 'foo' ) );
- writer.insert( writer.createPositionAt( item, 1 ), writer.createEmptyElement( 'br' ) );
- writer.insert( writer.createPositionAt( item, 2 ), writer.createText( 'bar' ) );
- writer.insert( writer.createPositionAt( item, 3 ), writer.createEmptyElement( 'br' ) );
- expect( item.getFillerOffset() ).to.equal( 4 );
- } );
- it( 'ignores the ui elements', () => {
- const item = createViewListItemElement( writer );
- writer.insert( writer.createPositionAt( item, 0 ), writer.createUIElement( 'span' ) );
- writer.insert( writer.createPositionAt( item, 1 ), writer.createEmptyElement( 'br' ) );
- expect( item.getFillerOffset() ).to.equal( 2 );
- } );
- it( 'empty element must be the <br> element', () => {
- const item = createViewListItemElement( writer );
- writer.insert(
- writer.createPositionAt( item, 0 ),
- writer.createEmptyElement( 'img' )
- );
- expect( item.getFillerOffset() ).to.be.null;
- } );
- } );
- } );
- } );
- describe( 'getSiblingListItem()', () => {
- let editor, model, document;
- beforeEach( () => {
- return VirtualTestEditor.create( { plugins: [ ListEditing ] } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- document = model.document;
- } );
- } );
- afterEach( () => {
- return editor.destroy();
- } );
- it( 'should return the passed element if it matches the criteria (sameIndent, listIndent=0)', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' + // Starting item, wanted item.
- '<listItem listType="bulleted" listIndent="0">2.</listItem>'
- );
- const listItem = document.getRoot().getChild( 1 );
- const foundElement = getSiblingListItem( listItem, {
- sameIndent: true,
- listIndent: 0
- } );
- expect( foundElement ).to.equal( document.getRoot().getChild( 1 ) );
- } );
- it( 'should return the passed element if it matches the criteria (sameIndent, listIndent=0, direction="forward")', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' + // Starting item, wanted item.
- '<listItem listType="bulleted" listIndent="0">2.</listItem>'
- );
- const listItem = document.getRoot().getChild( 1 );
- const foundElement = getSiblingListItem( listItem, {
- sameIndent: true,
- listIndent: 0,
- direction: 'forward'
- } );
- expect( foundElement ).to.equal( document.getRoot().getChild( 1 ) );
- } );
- it( 'should return the first listItem that matches criteria (sameIndent, listIndent=1)', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
- '<listItem listType="bulleted" listIndent="1">1.1</listItem>' +
- '<listItem listType="bulleted" listIndent="1">1.2</listItem>' + // Wanted item.
- '<listItem listType="bulleted" listIndent="0">2.</listItem>' + // Starting item.
- '<listItem listType="bulleted" listIndent="1">2.1.</listItem>' +
- '<listItem listType="bulleted" listIndent="1">2.2.</listItem>'
- );
- const listItem = document.getRoot().getChild( 5 );
- const foundElement = getSiblingListItem( listItem.previousSibling, {
- sameIndent: true,
- listIndent: 1
- } );
- expect( foundElement ).to.equal( document.getRoot().getChild( 3 ) );
- } );
- it( 'should return the first listItem that matches criteria (sameIndent, listIndent=1, direction="forward")', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' + // Starting item.
- '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
- '<listItem listType="bulleted" listIndent="1">2.1.</listItem>' + // Wanted item.
- '<listItem listType="bulleted" listIndent="1">2.2.</listItem>'
- );
- const listItem = document.getRoot().getChild( 1 );
- const foundElement = getSiblingListItem( listItem.nextSibling, {
- sameIndent: true,
- listIndent: 1,
- direction: 'forward'
- } );
- expect( foundElement ).to.equal( document.getRoot().getChild( 3 ) );
- } );
- it( 'should return the first listItem that matches criteria (smallerIndent, listIndent=1)', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">2.</listItem>' + // Wanted item.
- '<listItem listType="bulleted" listIndent="1">2.1.</listItem>' + // Starting item.
- '<listItem listType="bulleted" listIndent="1">2.2.</listItem>'
- );
- const listItem = document.getRoot().getChild( 4 );
- const foundElement = getSiblingListItem( listItem, {
- smallerIndent: true,
- listIndent: 1
- } );
- expect( foundElement ).to.equal( document.getRoot().getChild( 2 ) );
- } );
- it( 'should return the first listItem that matches criteria (smallerIndent, listIndent=1, direction="forward")', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
- '<listItem listType="bulleted" listIndent="1">0.1.</listItem>' + // Starting item.
- '<listItem listType="bulleted" listIndent="1">0.2.</listItem>' +
- '<listItem listType="bulleted" listIndent="1">0.3.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' // Wanted item.
- );
- const listItem = document.getRoot().getChild( 1 );
- const foundElement = getSiblingListItem( listItem, {
- smallerIndent: true,
- listIndent: 1,
- direction: 'forward'
- } );
- expect( foundElement ).to.equal( document.getRoot().getChild( 4 ) );
- } );
- } );
- describe( 'getSiblingNodes()', () => {
- let editor, model, document;
- beforeEach( () => {
- return VirtualTestEditor.create( { plugins: [ ListStyleEditing ] } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- document = model.document;
- } );
- } );
- afterEach( () => {
- return editor.destroy();
- } );
- it( 'should return all listItems above the current selection position (direction="backward")', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">[]2.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">4.</listItem>'
- );
- expect( getSiblingNodes( document.selection.getFirstPosition(), 'backward' ) ).to.deep.equal( [
- document.getRoot().getChild( 0 ),
- document.getRoot().getChild( 1 ),
- document.getRoot().getChild( 2 )
- ] );
- } );
- it( 'should return all listItems below the current selection position (direction="forward")', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">[]2.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">4.</listItem>'
- );
- expect( getSiblingNodes( document.selection.getFirstPosition(), 'forward' ) ).to.deep.equal( [
- document.getRoot().getChild( 3 ),
- document.getRoot().getChild( 4 )
- ] );
- } );
- it( 'should break searching when spotted a non-listItem element (direction="backward")', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
- '<paragraph>Foo</paragraph>' +
- '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">4.[].</listItem>'
- );
- expect( getSiblingNodes( document.selection.getFirstPosition(), 'backward' ) ).to.deep.equal( [
- document.getRoot().getChild( 3 ),
- document.getRoot().getChild( 4 ),
- document.getRoot().getChild( 5 )
- ] );
- } );
- it( 'should break searching when spotted a non-listItem element (direction="forward")', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">[]0.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
- '<paragraph>Foo</paragraph>' +
- '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">4.</listItem>'
- );
- expect( getSiblingNodes( document.selection.getFirstPosition(), 'forward' ) ).to.deep.equal( [
- document.getRoot().getChild( 1 ),
- document.getRoot().getChild( 2 )
- ] );
- } );
- it( 'should break searching when spotted a different value for the `listType` attribute (direction="backward")', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
- '<listItem listType="numbered" listIndent="0">Numbered item.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">[]4.</listItem>'
- );
- expect( getSiblingNodes( document.selection.getFirstPosition(), 'backward' ) ).to.deep.equal( [
- document.getRoot().getChild( 4 ),
- document.getRoot().getChild( 5 )
- ] );
- } );
- it( 'should break searching when spotted a different value for the `listType` attribute (direction="forward")', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">[]0.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
- '<listItem listType="numbered" listIndent="0">Numbered item.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">4.</listItem>'
- );
- expect( getSiblingNodes( document.selection.getFirstPosition(), 'forward' ) ).to.deep.equal( [
- document.getRoot().getChild( 1 ),
- document.getRoot().getChild( 2 )
- ] );
- } );
- it( 'should break searching when spotted a different value for the `listStyle` attribute (direction="backward")', () => {
- setData( model,
- '<listItem listType="bulleted" listStyle="disc" listIndent="0">0.</listItem>' +
- '<listItem listType="bulleted" listStyle="disc" listIndent="0">1.</listItem>' +
- '<listItem listType="bulleted" listStyle="disc" listIndent="0">2.</listItem>' +
- '<listItem listType="bulleted" listStyle="square" listIndent="0">Broken item.</listItem>' +
- '<listItem listType="bulleted" listStyle="disc" listIndent="0">3.</listItem>' +
- '<listItem listType="bulleted" listStyle="disc" listIndent="0">[]4.</listItem>'
- );
- expect( getSiblingNodes( document.selection.getFirstPosition(), 'backward' ) ).to.deep.equal( [
- document.getRoot().getChild( 4 ),
- document.getRoot().getChild( 5 )
- ] );
- } );
- it( 'should break searching when spotted a different value for the `listStyle` attribute (direction="forward")', () => {
- setData( model,
- '<listItem listType="bulleted" listStyle="disc" listIndent="0">[]0.</listItem>' +
- '<listItem listType="bulleted" listStyle="disc" listIndent="0">1.</listItem>' +
- '<listItem listType="bulleted" listStyle="disc" listIndent="0">2.</listItem>' +
- '<listItem listType="bulleted" listStyle="square" listIndent="0">Broken item.</listItem>' +
- '<listItem listType="bulleted" listStyle="disc" listIndent="0">3.</listItem>' +
- '<listItem listType="bulleted" listStyle="disc" listIndent="0">4.</listItem>'
- );
- expect( getSiblingNodes( document.selection.getFirstPosition(), 'forward' ) ).to.deep.equal( [
- document.getRoot().getChild( 1 ),
- document.getRoot().getChild( 2 )
- ] );
- } );
- it( 'should ignore nested items (looking for listIndent=0)', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">[]0.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
- '<listItem listType="bulleted" listIndent="1">2.1.</listItem>' +
- '<listItem listType="bulleted" listIndent="1">2.2.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">3.</listItem>' +
- '<listItem listType="bulleted" listIndent="1">3.1.</listItem>' +
- '<listItem listType="bulleted" listIndent="2">3.1.1.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">4.</listItem>'
- );
- expect( getSiblingNodes( document.selection.getFirstPosition(), 'forward' ) ).to.deep.equal( [
- document.getRoot().getChild( 1 ),
- document.getRoot().getChild( 2 ),
- document.getRoot().getChild( 5 ),
- document.getRoot().getChild( 8 )
- ] );
- } );
- it( 'should break when spotted an outer list (looking for listIndent=1)', () => {
- setData( model,
- '<listItem listType="bulleted" listIndent="0">0.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">1.</listItem>' +
- '<listItem listType="bulleted" listIndent="1">[]1.1.</listItem>' +
- '<listItem listType="bulleted" listIndent="1">1.2.</listItem>' +
- '<listItem listType="bulleted" listIndent="1">1.3.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">2.</listItem>' +
- '<listItem listType="bulleted" listIndent="0">3.</listItem>'
- );
- expect( getSiblingNodes( document.selection.getFirstPosition(), 'forward' ) ).to.deep.equal( [
- document.getRoot().getChild( 3 ),
- document.getRoot().getChild( 4 )
- ] );
- } );
- } );
- } );
|