Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RichText: remove DOM logic from list toolbar #14840

Merged
merged 3 commits into from
Apr 10, 2019
Merged

RichText: remove DOM logic from list toolbar #14840

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab743c0
RichText: remove DOM logic from list toolbar
ellatrix Apr 5, 2019
8098cb5
Fix mobile side
ellatrix Apr 5, 2019
17926a5
Add e2e test for ordered split
ellatrix Apr 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 6 additions & 70 deletions packages/block-editor/src/components/rich-text/list-edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import {
__unstableIndentListItems as indentListItems,
__unstableOutdentListItems as outdentListItems,
__unstableChangeListType as changeListType,
__unstableIsListRootSelected as isListRootSelected,
__unstableIsActiveListType as isActiveListType,
} from '@wordpress/rich-text';

/**
Expand All @@ -18,72 +20,6 @@ import {
import { RichTextShortcut } from './shortcut';
import BlockFormatControls from '../block-format-controls';

const { TEXT_NODE, ELEMENT_NODE } = window.Node;

/**
* Gets the selected list node, which is the closest list node to the start of
* the selection.
*
* @return {?Element} The selected list node, or undefined if none is selected.
*/
function getSelectedListNode() {
const selection = window.getSelection();

if ( selection.rangeCount === 0 ) {
return;
}

let { startContainer } = selection.getRangeAt( 0 );

if ( startContainer.nodeType === TEXT_NODE ) {
startContainer = startContainer.parentNode;
}

if ( startContainer.nodeType !== ELEMENT_NODE ) {
return;
}

const rootNode = startContainer.closest( '*[contenteditable]' );

if ( ! rootNode || ! rootNode.contains( startContainer ) ) {
return;
}

return startContainer.closest( 'ol,ul' );
}

/**
* Whether or not the root list is selected.
*
* @return {boolean} True if the root list or nothing is selected, false if an
* inner list is selected.
*/
function isListRootSelected() {
const listNode = getSelectedListNode();

// Consider the root list selected if nothing is selected.
return ! listNode || listNode.contentEditable === 'true';
}

/**
* Wether or not the selected list has the given tag name.
*
* @param {string} tagName The tag name the list should have.
* @param {string} rootTagName The current root tag name, to compare with in
* case nothing is selected.
*
* @return {boolean} [description]
*/
function isActiveListType( tagName, rootTagName ) {
const listNode = getSelectedListNode();

if ( ! listNode ) {
return tagName === rootTagName;
}

return listNode.nodeName.toLowerCase() === tagName;
}

export const ListEdit = ( {
onTagNameChange,
tagName,
Expand Down Expand Up @@ -125,23 +61,23 @@ export const ListEdit = ( {
onTagNameChange && {
icon: 'editor-ul',
title: __( 'Convert to unordered list' ),
isActive: isActiveListType( 'ul', tagName ),
isActive: isActiveListType( value, 'ul', tagName ),
onClick() {
onChange( changeListType( value, { type: 'ul' } ) );

if ( isListRootSelected() ) {
if ( isListRootSelected( value ) ) {
onTagNameChange( 'ul' );
}
},
},
onTagNameChange && {
icon: 'editor-ol',
title: __( 'Convert to ordered list' ),
isActive: isActiveListType( 'ol', tagName ),
isActive: isActiveListType( value, 'ol', tagName ),
onClick() {
onChange( changeListType( value, { type: 'ol' } ) );

if ( isListRootSelected() ) {
if ( isListRootSelected( value ) ) {
onTagNameChange( 'ol' );
}
},
Expand Down
12 changes: 6 additions & 6 deletions packages/block-editor/src/components/rich-text/list-edit.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import { Toolbar } from '@wordpress/components';
import { __ } from '@wordpress/i18n';
import {
changeListType,
__unstableIsListRootSelected,
__unstableIsActiveListType,
__unstableIsListRootSelected as isListRootSelected,
__unstableIsActiveListType as isActiveListType,
} from '@wordpress/rich-text';

/**
Expand All @@ -28,23 +28,23 @@ export const ListEdit = ( {
onTagNameChange && {
icon: 'editor-ul',
title: __( 'Convert to unordered list' ),
isActive: __unstableIsActiveListType( 'ul', tagName, value ),
isActive: isActiveListType( value, 'ul', tagName ),
onClick() {
onChange( changeListType( value, { type: 'ul' } ) );

if ( __unstableIsListRootSelected( value ) ) {
if ( isListRootSelected( value ) ) {
onTagNameChange( 'ul' );
}
},
},
onTagNameChange && {
icon: 'editor-ol',
title: __( 'Convert to ordered list' ),
isActive: __unstableIsActiveListType( 'ol', tagName, value ),
isActive: isActiveListType( value, 'ol', tagName ),
onClick() {
onChange( changeListType( value, { type: 'ol' } ) );

if ( __unstableIsListRootSelected( value ) ) {
if ( isListRootSelected( value ) ) {
onTagNameChange( 'ol' );
}
},
Expand Down
14 changes: 14 additions & 0 deletions packages/e2e-tests/specs/blocks/__snapshots__/list.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,20 @@ exports[`List should split indented list item 1`] = `
<!-- /wp:list -->"
`;

exports[`List should split into two ordered lists with paragraph 1`] = `
"<!-- wp:list {\\"ordered\\":true} -->
<ol><li>one</li></ol>
<!-- /wp:list -->

<!-- wp:paragraph -->
<p></p>
<!-- /wp:paragraph -->

<!-- wp:list {\\"ordered\\":true} -->
<ol><li>two</li></ol>
<!-- /wp:list -->"
`;

exports[`List should split into two with paragraph and merge lists 1`] = `
"<!-- wp:list -->
<ul><li>one</li><li></li><li>two</li></ul>
Expand Down
12 changes: 12 additions & 0 deletions packages/e2e-tests/specs/blocks/list.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,18 @@ describe( 'List', () => {
expect( await getEditedPostContent() ).toMatchSnapshot();
} );

it( 'should split into two ordered lists with paragraph', async () => {
await clickBlockAppender();
await page.keyboard.type( '1. one' );
await page.keyboard.press( 'Enter' );
await page.keyboard.type( 'two' );
await page.keyboard.press( 'ArrowUp' );
await page.keyboard.press( 'Enter' );
await page.keyboard.press( 'Enter' );

expect( await getEditedPostContent() ).toMatchSnapshot();
} );

it( 'should split indented list item', async () => {
await insertBlock( 'List' );
await page.keyboard.type( 'one' );
Expand Down
19 changes: 0 additions & 19 deletions packages/rich-text/src/get-line-list-formats.js
View file
Open in desktop

This file was deleted.

27 changes: 15 additions & 12 deletions packages/rich-text/src/is-active-list-type.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,28 @@
* Internal dependencies
*/

import { getLineListFormats } from './get-line-list-formats';
import { getLineIndex } from './get-line-index';

/**
* Wether or not the selected list has the given tag name.
*
* @param {string} tagName The tag name the list should have.
* @param {string} rootTagName The current root tag name, to compare with in
* case nothing is selected.
* @param {Object} value The internal rich-text value.
* @param {Object} value The value to check.
* @param {string} type The tag name the list should have.
* @param {string} rootType The current root tag name, to compare with in case
* nothing is selected.
*
* @return {boolean} [description]
* @return {boolean} True if the current list type matches `type`, false if not.
*/
export function isActiveListType( tagName, rootTagName, value ) {
const startLineFormats = getLineListFormats( value );
const [ deepestListFormat ] = startLineFormats.slice( -1 );
export function isActiveListType( value, type, rootType ) {
const { replacements, start } = value;
const lineIndex = getLineIndex( value, start );
const replacement = replacements[ lineIndex ];

if ( ! deepestListFormat || ! deepestListFormat.type ) {
return tagName === rootTagName;
if ( ! replacement || replacement.length === 0 ) {
return type === rootType;
}

return deepestListFormat.type.toLowerCase() === tagName;
const lastFormat = replacement[ replacement.length - 1 ];

return lastFormat.type === type;
}
11 changes: 7 additions & 4 deletions packages/rich-text/src/is-list-root-selected.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@
* Internal dependencies
*/

import { getLineListFormats } from './get-line-list-formats';
import { getLineIndex } from './get-line-index';

/**
* Whether or not the root list is selected.
*
* @param {Object} value The internal rich-text value.
* @param {Object} value The value to check.
*
* @return {boolean} True if the root list or nothing is selected, false if an
* inner list is selected.
*/
export function isListRootSelected( value ) {
const startLineFormats = getLineListFormats( value );
return startLineFormats.length < 1;
const { replacements, start } = value;
const lineIndex = getLineIndex( value, start );
const replacement = replacements[ lineIndex ];

return ! replacement || replacement.length < 1;
}