Skip to content

Conversation

@pkliesch
Copy link
Contributor

@pkliesch pkliesch commented May 18, 2022

CKEditor 5 has been updated from 32.0.0 to 34.0.0.

This corresponding related CKEditor artifacts have been updates as well:

  • @ckeditor/ckeditor5-dev-utils to 30.1.3
  • @ckeditor/ckeditor5-dev-webpack-plugin to 30.1.3
  • @ckeditor/ckeditor5-inspector to 4.0.0

List Feature

For list feature, we changed to so-called document-lists for the example application. This is required, as CoreMedia RichText 1.0 allows also block-level elements such as paragraphs, tables, etc. in lists.

It is recommended, that you update possible usages of List to DocumentList as well, when using CKEditor 5 for editing CoreMedia RichText.

- import List from '@ckeditor/ckeditor5-list/src/list';
+ import DocumentList from '@ckeditor/ckeditor5-list/src/documentlist';

ClassicEditor.create(document.querySelector('.editor'), {
  // ...
  plugins: [
-    List,
+    DocumentList,
    // ...
  ]

Typings Adjusted

Typings got adjusted according to the CKEditor 5 API changes. Note, that in general, it is recommended to use typings as provided at DefinitelyTyped (like ckeditor-core) until ckeditor/ckeditor5#11704 is resolved.

CKEditor 5 Migration Notes

The following migration notes are applicable:

@mmichaelis mmichaelis changed the title Update CKEditor5 to version 34 Update CKEditor5 to version 34.0.0 May 19, 2022
@mmichaelis mmichaelis added the breaking Marks Pull-Requests, which introduce breaking changes. label May 19, 2022
Copy link
Member

@mmichaelis mmichaelis left a comment

Choose a reason for hiding this comment

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

Thanks for the update. Adjusted the PR description to provide some more details.

Added one note, that we should provide integration (contract) tests asap for the list feature to identify possible open gaps.

Comment on lines +1343 to +1360
<ul>
<li><br/>Lorem Linebreak</li>
<li><span>Lorem Ipusum in additional span tag</span></li>
<li><em>Italic Lorem Ipsum in em tag</em></li>
<li><strong>Bold Lorem Ipsum in strong tag</strong></li>
<li>Lorem <sup>Ipsum</sup> (sup tag)</li>
<li>Lorem <sub>Ipsum</sub> (sub tag)</li>
<li><a xlink:href="https://example.org/">Link to example.org</a></li>
</ul>
<p>The next list contains block elements (&lt;p>, &lt;ol>, &lt;blockquote>, &lt;pre>, &lt;table> and &lt;img>). </p>
<ul>
<li><p>Lorem Ipsum in Paragraph</p></li>
<li><ol><li>Lorem Ipsum List Element</li></ol></li>
<li><pre>Lorem Ipsum Blocktext</pre></li>
<li><blockquote>Lorem Ipsum Blockquote</blockquote></li>
<li><table><tr><td>Lorem Ipsum Table Cell</td></tr></table></li>
<li><img xlink:href="${INLINE_IMG}" alt="inline image"/></li>
</ul>
Copy link
Member

Choose a reason for hiding this comment

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

For manual tests, examples are enough for a first smoke-test. In the end, we should provide integration (contract) tests, also validating different combinations of attributes on various layers.

pkliesch added 2 commits May 19, 2022 16:15
# Conflicts:
#	app/package.json
#	packages/ckeditor5-common/package.json
#	packages/ckeditor5-coremedia-content-clipboard/package.json
#	packages/ckeditor5-coremedia-images/package.json
#	packages/ckeditor5-coremedia-link/package.json
#	packages/ckeditor5-coremedia-richtext-support/package.json
#	packages/ckeditor5-coremedia-richtext/package.json
#	packages/ckeditor5-coremedia-studio-essentials/package.json
#	packages/ckeditor5-coremedia-studio-integration-mock/package.json
#	packages/ckeditor5-dataprocessor-support/package.json
#	packages/ckeditor5-symbol-on-paste-mapper/package.json
#	pnpm-lock.yaml
@pkliesch pkliesch merged commit 5cd7e7b into main May 19, 2022
@pkliesch pkliesch deleted the update/to-ckeditor5-v34 branch May 19, 2022 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking Marks Pull-Requests, which introduce breaking changes.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants