Skip to content

List items should not be rewrapped for unrelated attribute change. #18806

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

Merged
niegowski merged 2 commits into from
Jul 4, 2025
Merged

List items should not be rewrapped for unrelated attribute change. #18806

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3efa7e
List items should not be rewrapped for unrelated attribute change.
niegowski Jul 3, 2025
3f7f1d6
Added tests.
niegowski Jul 4, 2025
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
24 changes: 17 additions & 7 deletions packages/ckeditor5-list/src/list/converters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,10 @@ export function reconvertItemsOnDataChange(
function collectListItemsToRefresh( listHead: ListElement, changedItems: Set<ModelNode> ) {
const itemsToRefresh = [];
const visited = new Set();
const stack: Array<ListItemAttributesMap> = [];
const stack: Array<{
modelAttributes: ListItemAttributesMap;
modelElement: ListElement;
}> = [];

for ( const { node, previous } of new SiblingListBlocksIterator( listHead ) ) {
if ( visited.has( node ) ) {
Expand All @@ -213,10 +216,13 @@ export function reconvertItemsOnDataChange(
}

// Update the stack for the current indent level.
stack[ itemIndent ] = Object.fromEntries(
Array.from( node.getAttributes() )
.filter( ( [ key ] ) => attributeNames.includes( key ) )
);
stack[ itemIndent ] = {
modelAttributes: Object.fromEntries(
Array.from( node.getAttributes() )
.filter( ( [ key ] ) => attributeNames.includes( key ) )
),
modelElement: node
};

// Find all blocks of the current node.
const blocks = getListItemBlocks( node, { direction: 'forward' } );
Expand Down Expand Up @@ -271,7 +277,10 @@ export function reconvertItemsOnDataChange(

function doesItemWrappingRequiresRefresh(
item: ModelElement,
stack: Array<ListItemAttributesMap>,
stack: Array<{
modelAttributes: ListItemAttributesMap;
modelElement: ListElement;
}>,
changedItems: Set<ModelNode>
) {
// Items directly affected by some "change" don't need a refresh, they will be converted by their own changes.
Expand All @@ -298,7 +307,8 @@ export function reconvertItemsOnDataChange(
const eventName = `checkAttributes:${ isListItemElement ? 'item' : 'list' }` as const;
const needsRefresh = listEditing.fire<ListEditingCheckAttributesEvent>( eventName, {
viewElement: element as ViewElement,
modelAttributes: stack[ indent ]
modelAttributes: stack[ indent ].modelAttributes,
modelReferenceElement: stack[ indent ].modelElement
} );

if ( needsRefresh ) {
Expand Down
1 change: 1 addition & 0 deletions packages/ckeditor5-list/src/list/listediting.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1002,6 +1002,7 @@ export type ListEditingCheckAttributesEvent = {
args: [ {
viewElement: ViewElement & { id?: string };
modelAttributes: ListItemAttributesMap;
modelReferenceElement: ListElement;
} ];
return: boolean;
};
Expand Down
6 changes: 5 additions & 1 deletion packages/ckeditor5-list/src/listproperties/listpropertiesediting.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,12 @@ export class ListPropertiesEditing extends Plugin {
// Verify if the list view element (ul or ol) requires refreshing.
listEditing.on<ListEditingCheckAttributesEvent>(
'checkAttributes:list',
( evt, { viewElement, modelAttributes } ) => {
( evt, { viewElement, modelAttributes, modelReferenceElement } ) => {
for ( const strategy of strategies ) {
if ( !strategy.appliesToListItem( modelReferenceElement ) ) {
continue;
}

if ( strategy.getAttributeOnUpcast( viewElement ) != modelAttributes[ strategy.attributeName ] ) {
evt.return = true;
evt.stop();
Expand Down