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.

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

[lexical-list] Bug Fix: Prevent error when calling formatList when selection is at root #6994

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
72 changes: 72 additions & 0 deletions packages/lexical-list/src/__tests__/unit/formatList.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
*/

import {
$createTableCellNode,
$createTableNode,
$createTableRowNode,
TableCellNode,
TableNode,
TableRowNode,
} from '@lexical/table';
import {$getRoot} from 'lexical';
import {initializeUnitTest} from 'lexical/src/__tests__/utils';

import {insertList} from '../../formatList';
import {$isListNode} from '../../LexicalListNode';

describe('insertList', () => {
initializeUnitTest((testEnv) => {
test('inserting with empty root selection', async () => {
const {editor} = testEnv;

await editor.update(() => {
$getRoot().select();
});

insertList(editor, 'number');

editor.read(() => {
const root = $getRoot();

expect(root.getChildrenSize()).toBe(1);

const firstChild = root.getFirstChildOrThrow();

expect($isListNode(firstChild)).toBe(true);
});
});

test('inserting with empty shadow root selection', async () => {
const {editor} = testEnv;

await editor.update(() => {
const table = $createTableNode();
const row = $createTableRowNode();
const cell = $createTableCellNode();
$getRoot().append(table.append(row.append(cell)));
cell.select();
});

insertList(editor, 'number');

editor.read(() => {
const cell = $getRoot()
.getFirstChildOrThrow<TableNode>()
.getFirstChildOrThrow<TableRowNode>()
.getFirstChildOrThrow<TableCellNode>();

expect(cell.getChildrenSize()).toBe(1);

const firstChild = cell.getFirstChildOrThrow();

expect($isListNode(firstChild)).toBe(true);
});
});
});
});
13 changes: 12 additions & 1 deletion packages/lexical-list/src/formatList.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export function insertList(editor: LexicalEditor, listType: ListType): void {
const selection = $getSelection();

if (selection !== null) {
const nodes = selection.getNodes();
let nodes = selection.getNodes();
if ($isRangeSelection(selection)) {
const anchorAndFocus = selection.getStartEndPoints();
invariant(
Expand All @@ -77,6 +77,17 @@ export function insertList(editor: LexicalEditor, listType: ListType): void {
const anchorNode = anchor.getNode();
const anchorNodeParent = anchorNode.getParent();

if ($isRootOrShadowRoot(anchorNode)) {
const firstChild = anchorNode.getFirstChild();
if (firstChild) {
nodes = firstChild.selectStart().getNodes();
} else {
const paragraph = $createParagraphNode();
anchorNode.append(paragraph);
nodes = paragraph.select().getNodes();
}
}
Comment on lines +80 to +89
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does seem strange that we're not also changing anchorNode and anchorNodeParent here, but maybe $isSelectingEmptyListItem is always false if this is the case? If that's so, I think it would make more sense to change that to be an else if to make it clear that these conditions are mutually exclusive.


if ($isSelectingEmptyListItem(anchorNode, nodes)) {
const list = $createListNode(listType);

Expand Down
Loading