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

Jump to bottom

Enable support for reconversion in elementToElement() #10359

Closed
Mgsy opened this issue Aug 16, 2021 · 1 comment · Fixed by #11211
Closed

Enable support for reconversion in elementToElement() #10359

Mgsy opened this issue Aug 16, 2021 · 1 comment · Fixed by #11211
Assignees
@dawidurbanski
Labels
domain:dx This issue reports a developer experience problem or possible improvement. package:engine squad:core Issue to be handled by the Core team. type:task This issue reports a chore (non-production change) and other types of "todos".
Milestone
iteration 51 (v33...

Comments

@Mgsy
Copy link
Member

Mgsy commented Aug 16, 2021

Provide a description of the task

Scope

  • Introduce: Support for an object format of the model property to handle attributes + name + children
  • Conversion helpers: insertElement()
  • downcastElementToElement()
@Mgsy Mgsy added type:task This issue reports a chore (non-production change) and other types of "todos". domain:dx This issue reports a developer experience problem or possible improvement. squad:compat labels Aug 16, 2021
@Mgsy Mgsy changed the title Introduce elementToElement() Enable support for reconversion in elementToElement() Aug 16, 2021
@Mgsy Mgsy added this to the nice-to-have milestone Aug 19, 2021
@Mgsy Mgsy modified the milestones: nice-to-have, iteration 47 Sep 13, 2021
@Reinmar
Copy link
Member

Reinmar commented Sep 16, 2021

Note from the refinement:

  • Sub-task: Introduce: Support for an object format of the model property to handle attributes + name + children
    • Triggers reconversion of that element
    • Use cases: none currently, but it's clear that it's needed and the API will be consistent
    • TODO: find a better name children - it's unclear what it triggers
      • children makes the parent element be reconverted when the list of its children changes (children are converted separately).
  • Sub-task: Changes necessary for insertElement()
    • We don't need support for slots here. We can be inspired by insertStructure which is already implemented.
    • Changes needed because of reconvert option of elementToElement()
    • TODO:
      • reinsertNodes() - it will be reused from elementToStructure support.
      • check for the element to have no children (for that we should use elementToStructure())
    • DO NOT:
      • Try to reuse the view element that was mapped to the element being reconverted. It's fine to re-create it – reasonably cheap and easier to implement.
  • Sub-task: Update HTML Embed feature to use elementToElement instead of triggerBy.
    • Done in e2S
  • Sub-task: downcastElementToElement()
    • Plug a listener to reduceChanges
  • Tests: If there's a lack of tests for insertElement (it may happen that we only tested elementToElement so far), it's not a part of this task to introduce them. However, if there are tests, we should introduce new ones to cover new changes.

@dawidurbanski dawidurbanski mentioned this issue Sep 20, 2021
Merged
niegowski added a commit that referenced this issue Sep 22, 2021
@niegowski
Merge pull request #10557 from ckeditor/ck/10359/reconversion/element…
ed9afa5 
…ToElement

Feature (engine): Added support for reconversion in `DowncastHelpers#elementToElement()` downcast helper. Closes #10359.
@dawidurbanski dawidurbanski mentioned this issue Feb 8, 2022
Merged
dawidurbanski added a commit that referenced this issue Feb 9, 2022
@dawidurbanski
Merge pull request #11211 from ckeditor/ck/10294/reconversion
9f17c59 
Feature (engine): The DowncastWriter#createContainerElement() should accept a list of children so bigger view structures can be created in one call. Closes #10714.

Feature (engine): The elementToElement downcast helper will log a console warning if multiple elements have been created. Closes #10610.

Feature (engine): The DowncastDispatcher will throw an error if any of the model items were not consumed while converting. Closes #10377.

Feature (engine): Introducing convertItem(), convertChildren() and convertAttributes() in the downcast conversion API interface.

Feature (engine): Added support for reconversion in DowncastHelpers#elementToElement() downcast helper. Closes #10359.

Feature (engine): Added DowncastHelpers#elementToStructure() downcast helper with reconversion support. Closes #10358.

Feature (engine): It's now possible to trigger a nested conversion while downcasting an element.

Docs (engine): Overhauled the conversion documentation and introduced the documentation for conversion helpers. Closes #10294.

Internal (engine): elementToStructure() should throw when invoked for an element that allows $text. Closes #11163.

Internal (engine): Replaced conversionApi.slotFor() in elementToStructure with writer.createSlot(). Closes #11179.

Internal (engine): Reconversion helpers can coexist with Differ#refreshItem() children.

Other (engine): Implemented the EditingController#reconvertMarker() method to be used instead of Writer#updateMarker() for marker reconversion purposes. Implemented the EditingController#reconvertItem() method to replace Differ#refreshItem(). Closes #10659.

Other (engine): The attribute and child nodes conversion events are fired by the lowest priority handler for the insert event instead of by DowncastDispatcher itself. Closes #10376.

Other (engine): Events are fired by the DowncastDispatcher even if they were previously consumed. It's the conversion handler's responsibility to check if it can be consumed or if it was already consumed by other converters.

Other (engine): The DowncastDispatcher#convert() method introduced as a replacement to previously used convertInsert(). The new method handles not only nodes conversion but also markers.

Internal (horizontal-line): The horizontalLine element downcast conversion has been changed from elementToElement to elementToStructure.

Internal (html-support): HTML elements downcast conversion have been changed from elementToElement to elementToStructure.

Internal (image): The imageBlock and imageInline elements downcast conversion have been changed from elementToElement to elementToStructure.

Internal (link): Link inlineWidget element downcast conversion has been changed from elementToElement to elementToStructure.

Internal (media-embed): The media element downcast conversion has been changed from elementToElement to elementToStructure.

Internal (page-break): The pageBreak element downcast conversion has been changed from elementToElement to elementToStructure.

Internal (widget): The blockWidget and inlineWidget elements downcast conversion have been changed from elementToElement to elementToStructure.

Internal (heading): Added missing consuming converter.

Internal (heading): Code adjusted to changes in DowncastDispatcher API.

Internal (html-embed): Code adjusted to the removal of triggerBy conversion option.

Other (list): The ckeditor5-list package was restructured into subdirectories. Closes #10811.

Other (list): Downcast conversion should consume downcasted attributes.

Other (table): Table downcast conversion migrated to elementToStructure() downcast helper. Closes #10502.

Tests (clipboard): Added missing downcast conversion.

Tests (image): Tests updated to properly handle non-consumed errors fired by the DowncastDispatcher.

Tests (alignment, autoformat, block-quote, engine, html-support, image, indent, table, word-count): Tests updated after list package restructuring.

Tests (html-support): Fixed test for checking if an attribute was consumed while converting.

Docs (ckeditor5): Links in the migration guide point to the new conversion documentation.

MAJOR BREAKING CHANGE (list): The ListEditing, ListUI, ListStyleEditing, ListStyleUI, TodoListEditing, TodoListUI plugins were moved to the dedicated subdirectories (list, liststyle, todolist).

MAJOR BREAKING CHANGE (engine): Removed the Differ#refreshItem() method from the public API. Replaced by EditingController#reconvertItem() (see #10659).

MAJOR BREAKING CHANGE (engine): The DowncastDispatcher will throw an error if any of the model items were not consumed while converting. Read the conversion-model-consumable-not-consumed error documentation for more information.

MAJOR BREAKING CHANGE (engine): The DowncastDispatcher#conversionApi property is no longer available. The instances of DowncastConversionApi being created at the start of conversion.

MAJOR BREAKING CHANGE (engine): The support for the triggerBy option for downcast helpers is removed and replaced with the new elementToStructure() options.

MINOR BREAKING CHANGE (media-embed): The createMediaFigureElement helper function first argument has been changed from writer object to conversionApi object.

MINOR BREAKING CHANGE (table): The downcast converters of the table feature has been rewritten with the use of elementToStructure() and the re-conversion mechanism. See #10502.
@Reinmar Reinmar modified the milestones: iteration 47, iteration 51 Feb 11, 2022
@Reinmar Reinmar added package:engine squad:core Issue to be handled by the Core team. labels Feb 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dawidurbanski dawidurbanski

Labels
domain:dx This issue reports a developer experience problem or possible improvement. package:engine squad:core Issue to be handled by the Core team. type:task This issue reports a chore (non-production change) and other types of "todos".
Projects
None yet
Milestone
iteration 51 (v33.0.0)
Development

Successfully merging a pull request may close this issue.

New reconversion system ckeditor/ckeditor5
3 participants
@Reinmar @dawidurbanski @Mgsy