[lexical][lexical-selection] Bug Fix: Respect mode when patching text style

[adrianmxb]

Description

There is an issue in Lexical where token and segmented text nodes are not correctly handled during text styling operations. This results in improper formatting / node splitting, leading to unexpected behaviour.

After some debugging, I saw that it is handled correctly in the RangeSelection class, but not in the helper method used to patch the text style.

lexical/packages/lexical/src/LexicalSelection.ts

Lines 1136 to 1182 in 2c90ee0

	// The entire node is selected or it is token, so just format it
	if (
	$isTokenOrSegmented(firstNode) ||
	(startOffset === 0 && endOffset === firstNode.getTextContentSize())
	) {
	firstNode.setFormat(firstNextFormat);
	} else {
	// Node is partially selected, so split it into two nodes
	// add style the selected one.
	const splitNodes = firstNode.splitText(startOffset, endOffset);
	const replacement = startOffset === 0 ? splitNodes[0] : splitNodes[1];
	replacement.setFormat(firstNextFormat);
	// Update selection only if starts/ends on text node
	if (startPoint.type === 'text') {
	startPoint.set(replacement.__key, 0, 'text');
	}
	if (endPoint.type === 'text') {
	endPoint.set(replacement.__key, endOffset - startOffset, 'text');
	}
	}
	this.format = firstNextFormat;
	return;
	}
	// Multiple nodes selected
	// The entire first node isn't selected, so split it
	if (startOffset !== 0 && !$isTokenOrSegmented(firstNode)) {
	[, firstNode as TextNode] = firstNode.splitText(startOffset);
	startOffset = 0;
	}
	firstNode.setFormat(firstNextFormat);
	const lastNextFormat = lastNode.getFormatFlags(formatType, firstNextFormat);
	// If the offset is 0, it means no actual characters are selected,
	// so we skip formatting the last node altogether.
	if (endOffset > 0) {
	if (
	endOffset !== lastNode.getTextContentSize() &&
	!$isTokenOrSegmented(lastNode)
	) {
	[lastNode as TextNode] = lastNode.splitText(endOffset);
	}
	lastNode.setFormat(lastNextFormat);
	}

Closes #6427

1. Added $isTokenOrSegmented to the list of exported utilities.
2. Updated $patchStyleText function: Adjusted logic to prevent splitting of token/segmented nodes

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
lexical	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 22, 2024 2:41pm
lexical-playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 22, 2024 2:41pm

[facebook-github-bot]

Hi @adrianmxb!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

[github-actions]

size-limit report 📦

Path	Size
lexical - cjs	28.9 KB (0%)
lexical - esm	28.72 KB (0%)
@lexical/rich-text - cjs	37.21 KB (0%)
@lexical/rich-text - esm	28.18 KB (0%)
@lexical/plain-text - cjs	35.85 KB (0%)
@lexical/plain-text - esm	25.49 KB (0%)
@lexical/react - cjs	39.08 KB (0%)
@lexical/react - esm	29.59 KB (0%)

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

[ivailop7]

Could we get a test for this please

[adrianmxb]

@ivailop7 I added a unit test for it

[ivailop7]

@ivailop7 I added a unit test for it

Thanks, have ran all the e2e once they finish, will give it a final look before merging.