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

Rich text: preserve comments #62128

Merged
merged 7 commits into from
Nov 25, 2024
Merged

Rich text: preserve comments #62128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
258cfbe
Rich text: preserve comment nodes
ellatrix May 30, 2024
6397bdc
Improve interaction
ellatrix May 30, 2024
232e617
Restore brackets
ellatrix May 30, 2024
98f3290
Add unit tests
ellatrix May 30, 2024
4ac1c51
Remove brackets
ellatrix Nov 18, 2024
423d892
Adjust unit tests
ellatrix Nov 18, 2024
e92bbf5
Restore -small
ellatrix Nov 25, 2024
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
19 changes: 15 additions & 4 deletions packages/block-editor/src/components/rich-text/content.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@
&:focus {
// Removes outline added by the browser.
outline: none;

[data-rich-text-format-boundary] {
border-radius: $radius-small;
}
}
}

Expand All @@ -40,3 +36,18 @@ figcaption.block-editor-rich-text__editable [data-rich-text-placeholder]::before
background: rgb(255, 255, 0);
}
}

[data-rich-text-comment],
Copy link
Contributor

Choose a reason for hiding this comment

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

What is this attribute about?

Copy link
Member Author

Choose a reason for hiding this comment

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

It stores the data inside comments

Copy link
Member Author

Choose a reason for hiding this comment

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

And also marks a placeholder as a comment

[data-rich-text-format-boundary] {
border-radius: $radius-small;
}

[data-rich-text-comment] {
background-color: currentColor;

span {
filter: invert(100%);
color: currentColor;
padding: 0 2px;
}
}
28 changes: 28 additions & 0 deletions packages/rich-text/src/create.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,34 @@ function createFromElement( { element, range, isEditableTree } ) {
continue;
}

if (
node.nodeType === node.COMMENT_NODE ||
( node.nodeType === node.ELEMENT_NODE &&
node.tagName === 'SPAN' &&
node.hasAttribute( 'data-rich-text-comment' ) )
) {
const value = {
formats: [ , ],
replacements: [
{
type: '#comment',
attributes: {
'data-rich-text-comment':
node.nodeType === node.COMMENT_NODE
? node.nodeValue
: node.getAttribute(
'data-rich-text-comment'
),
},
},
],
text: OBJECT_REPLACEMENT_CHARACTER,
};
accumulateSelection( accumulator, node, range, value );
mergePair( accumulator, value );
continue;
}

if ( node.nodeType !== node.ELEMENT_NODE ) {
continue;
}
Expand Down
30 changes: 30 additions & 0 deletions packages/rich-text/src/test/__snapshots__/to-dom.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,21 @@ exports[`recordToDom should not error with overlapping formats (2) 1`] = `
</body>
`;

exports[`recordToDom should preserve comments 1`] = `
<body>

<span
contenteditable="false"
data-rich-text-comment="comment"
>
<span>
comment
</span>
</span>

</body>
`;

exports[`recordToDom should preserve emoji 1`] = `
<body>
🍒
Expand All @@ -289,6 +304,21 @@ exports[`recordToDom should preserve emoji in formatting 1`] = `
</body>
`;

exports[`recordToDom should preserve funky comments 1`] = `
<body>

<span
contenteditable="false"
data-rich-text-comment="/funky"
>
<span>
/funky
</span>
</span>

</body>
`;

exports[`recordToDom should preserve non breaking space 1`] = `
<body>
test  test
Expand Down
52 changes: 52 additions & 0 deletions packages/rich-text/src/test/helpers/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,6 +551,58 @@ export const spec = [
text: '\ufffc',
},
},
{
description: 'should preserve comments',
html: '<!--comment-->',
createRange: ( element ) => ( {
startOffset: 0,
startContainer: element,
endOffset: 1,
endContainer: element,
} ),
startPath: [ 0, 0 ],
endPath: [ 2, 0 ],
record: {
start: 0,
end: 1,
formats: [ , ],
replacements: [
{
attributes: {
'data-rich-text-comment': 'comment',
},
type: '#comment',
},
],
text: '\ufffc',
},
},
{
description: 'should preserve funky comments',
html: '<//funky>',
createRange: ( element ) => ( {
startOffset: 0,
startContainer: element,
endOffset: 1,
endContainer: element,
} ),
startPath: [ 0, 0 ],
endPath: [ 2, 0 ],
record: {
start: 0,
end: 1,
formats: [ , ],
replacements: [
{
attributes: {
'data-rich-text-comment': '/funky',
},
type: '#comment',
},
],
text: '\ufffc',
},
},
];

export const specWithRegistration = [
Expand Down
12 changes: 9 additions & 3 deletions packages/rich-text/src/to-dom.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,16 @@ function append( element, child ) {
const { type, attributes } = child;

if ( type ) {
child = element.ownerDocument.createElement( type );
if ( type === '#comment' ) {
child = element.ownerDocument.createComment(
attributes[ 'data-rich-text-comment' ]
);
} else {
child = element.ownerDocument.createElement( type );

for ( const key in attributes ) {
child.setAttribute( key, attributes[ key ] );
for ( const key in attributes ) {
child.setAttribute( key, attributes[ key ] );
}
}
}

Expand Down
9 changes: 9 additions & 0 deletions packages/rich-text/src/to-html-string.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,15 @@ function remove( object ) {
}

function createElementHTML( { type, attributes, object, children } ) {
if ( type === '#comment' ) {
// We can't restore the original comment delimiters, because once parsed
// into DOM nodes, we don't have the information. But in the future we
// could allow comment handlers to specify custom delimiters, for
// example `</{comment-content}>` for Bits, where `comment-content`
// would be `/{bit-name}` or `__{translatable-string}` (TBD).
return `<!--${ attributes[ 'data-rich-text-comment' ] }-->`;
}

let attributeString = '';

for ( const key in attributes ) {
Expand Down
15 changes: 14 additions & 1 deletion packages/rich-text/src/to-tree.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,20 @@ export function toTree( {
const { type, attributes, innerHTML } = replacement;
const formatType = getFormatType( type );

if ( ! isEditableTree && type === 'script' ) {
if ( isEditableTree && type === '#comment' ) {
pointer = append( getParent( pointer ), {
type: 'span',
attributes: {
contenteditable: 'false',
'data-rich-text-comment':
attributes[ 'data-rich-text-comment' ],
},
} );
append(
append( pointer, { type: 'span' } ),
attributes[ 'data-rich-text-comment' ].trim()
);
} else if ( ! isEditableTree && type === 'script' ) {
pointer = append(
getParent( pointer ),
fromFormat( {
Expand Down
Loading