/
list.ts
237 lines (199 loc) · 7.17 KB
/
list.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
/**
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module html-support/integrations/list
*/
import { isEqual } from 'lodash-es';
import { Plugin } from 'ckeditor5/src/core.js';
import type { UpcastElementEvent } from 'ckeditor5/src/engine.js';
import type { GetCallback } from 'ckeditor5/src/utils.js';
import type {
ListEditing,
ListEditingPostFixerEvent,
LegacyIndentCommand,
ListIndentCommand,
ListType,
ListUtils
} from '@ckeditor/ckeditor5-list';
import { getHtmlAttributeName, setViewAttributes } from '../utils.js';
import DataFilter, { type DataFilterRegisterEvent } from '../datafilter.js';
/**
* Provides the General HTML Support integration with the {@link module:list/list~List List} feature.
*/
export default class ListElementSupport extends Plugin {
/**
* @inheritDoc
*/
public static get requires() {
return [ DataFilter ] as const;
}
/**
* @inheritDoc
*/
public static get pluginName() {
return 'ListElementSupport' as const;
}
/**
* @inheritDoc
*/
public init(): void {
const editor = this.editor;
if ( !editor.plugins.has( 'ListEditing' ) ) {
return;
}
const schema = editor.model.schema;
const conversion = editor.conversion;
const dataFilter = editor.plugins.get( DataFilter );
const listEditing: ListEditing = editor.plugins.get( 'ListEditing' );
const listUtils: ListUtils = editor.plugins.get( 'ListUtils' );
const viewElements = [ 'ul', 'ol', 'li' ];
// Register downcast strategy.
// Note that this must be done before document list editing registers conversion in afterInit.
listEditing.registerDowncastStrategy( {
scope: 'item',
attributeName: 'htmlLiAttributes',
setAttributeOnDowncast: setViewAttributes
} );
listEditing.registerDowncastStrategy( {
scope: 'list',
attributeName: 'htmlUlAttributes',
setAttributeOnDowncast: setViewAttributes
} );
listEditing.registerDowncastStrategy( {
scope: 'list',
attributeName: 'htmlOlAttributes',
setAttributeOnDowncast: setViewAttributes
} );
dataFilter.on<DataFilterRegisterEvent>( 'register', ( evt, definition ) => {
if ( !viewElements.includes( definition.view! ) ) {
return;
}
evt.stop();
// Do not register same converters twice.
if ( schema.checkAttribute( '$block', 'htmlLiAttributes' ) ) {
return;
}
const allowAttributes = viewElements.map( element => getHtmlAttributeName( element ) );
schema.extend( '$listItem', { allowAttributes } );
conversion.for( 'upcast' ).add( dispatcher => {
dispatcher.on<UpcastElementEvent>(
'element:ul', viewToModelListAttributeConverter( 'htmlUlAttributes', dataFilter ), { priority: 'low' }
);
dispatcher.on<UpcastElementEvent>(
'element:ol', viewToModelListAttributeConverter( 'htmlOlAttributes', dataFilter ), { priority: 'low' }
);
dispatcher.on<UpcastElementEvent>(
'element:li', viewToModelListAttributeConverter( 'htmlLiAttributes', dataFilter ), { priority: 'low' }
);
} );
} );
// Make sure that all items in a single list (items at the same level & listType) have the same properties.
listEditing.on<ListEditingPostFixerEvent>( 'postFixer', ( evt, { listNodes, writer } ) => {
for ( const { node, previousNodeInList } of listNodes ) {
// This is a first item of a nested list.
if ( !previousNodeInList ) {
continue;
}
if ( previousNodeInList.getAttribute( 'listType' ) == node.getAttribute( 'listType' ) ) {
const attribute = getAttributeFromListType( previousNodeInList.getAttribute( 'listType' ) );
const value = previousNodeInList.getAttribute( attribute );
if (
!isEqual( node.getAttribute( attribute ), value ) &&
writer.model.schema.checkAttribute( node, attribute )
) {
writer.setAttribute( attribute, value, node );
evt.return = true;
}
}
if ( previousNodeInList.getAttribute( 'listItemId' ) == node.getAttribute( 'listItemId' ) ) {
const value = previousNodeInList.getAttribute( 'htmlLiAttributes' );
if (
!isEqual( node.getAttribute( 'htmlLiAttributes' ), value ) &&
writer.model.schema.checkAttribute( node, 'htmlLiAttributes' )
) {
writer.setAttribute( 'htmlLiAttributes', value, node );
evt.return = true;
}
}
}
} );
// Remove `ol` attributes from `ul` elements and vice versa.
listEditing.on<ListEditingPostFixerEvent>( 'postFixer', ( evt, { listNodes, writer } ) => {
for ( const { node } of listNodes ) {
const listType = node.getAttribute( 'listType' );
if ( !listUtils.isNumberedListType( listType ) && node.getAttribute( 'htmlOlAttributes' ) ) {
writer.removeAttribute( 'htmlOlAttributes', node );
evt.return = true;
}
if ( listUtils.isNumberedListType( listType ) && node.getAttribute( 'htmlUlAttributes' ) ) {
writer.removeAttribute( 'htmlUlAttributes', node );
evt.return = true;
}
}
} );
}
/**
* @inheritDoc
*/
public afterInit(): void {
const editor = this.editor;
if ( !editor.commands.get( 'indentList' ) ) {
return;
}
// Reset list attributes after indenting list items.
const indentList: LegacyIndentCommand | ListIndentCommand = editor.commands.get( 'indentList' )!;
this.listenTo( indentList, 'afterExecute', ( evt, changedBlocks ) => {
editor.model.change( writer => {
for ( const node of changedBlocks ) {
const attribute = getAttributeFromListType( node.getAttribute( 'listType' ) );
if ( !editor.model.schema.checkAttribute( node, attribute ) ) {
continue;
}
// Just reset the attribute.
// If there is a previous indented list that this node should be merged into,
// the postfixer will unify all the attributes of both sub-lists.
writer.setAttribute( attribute, {}, node );
}
} );
} );
}
}
/**
* View-to-model conversion helper preserving allowed attributes on {@link TODO}
* feature model element.
*
* @returns Returns a conversion callback.
*/
function viewToModelListAttributeConverter( attributeName: string, dataFilter: DataFilter ): GetCallback<UpcastElementEvent> {
return ( evt, data, conversionApi ) => {
const viewElement = data.viewItem;
if ( !data.modelRange ) {
Object.assign( data, conversionApi.convertChildren( data.viewItem, data.modelCursor ) );
}
const viewAttributes = dataFilter.processViewAttributes( viewElement, conversionApi );
for ( const item of data.modelRange!.getItems( { shallow: true } ) ) {
// Apply only to list item blocks.
if ( !item.hasAttribute( 'listItemId' ) ) {
continue;
}
// Set list attributes only on same level items, those nested deeper are already handled
// by the recursive conversion.
if ( item.hasAttribute( attributeName ) ) {
continue;
}
if ( conversionApi.writer.model.schema.checkAttribute( item, attributeName ) ) {
conversionApi.writer.setAttribute( attributeName, viewAttributes || {}, item );
}
}
};
}
/**
* Returns HTML attribute name based on provided list type.
*/
function getAttributeFromListType( listType: ListType ) {
return listType === 'numbered' || listType == 'customNumbered' ?
'htmlOlAttributes' :
'htmlUlAttributes';
}