Widget conversion helper methods

[piernik]

I want to create card bootstrap widget (https://getbootstrap.com/docs/4.5/components/card/).

If I want to create widget out of it I need to change my convertion and from this:

conversion.elementToElement({
            model: 'cardHeader',
            view: {
                name: 'h5',
                classes: 'card-header'
            }
        });

I have to write this:

conversion.for('upcast').elementToElement({
            model: 'cardHeader',
            view: {
                name: 'h5',
                classes: 'card-header'
            }
        });
        conversion.for('dataDowncast').elementToElement({
            model: 'cardHeader',
            view: {
                name: 'h5',
                classes: 'card-header'
            }
        });
        conversion.for('editingDowncast').elementToElement({
            model: 'cardHeader',
            view: (modelElement, viewWriter) => {
                // Note: You use a more specialized createEditableElement() method here.
                const h1 = viewWriter.createEditableElement('h5', {class: 'card-header'});

                return toWidgetEditable(h1, viewWriter);
            }
        });

There is much repetition.
I think that helper functions should be introduced like:
elementToWidget(config, editor); // if editor is needed
elementToWidgetEditable(config, editor);

[Reinmar]

Big 👍  from me. Adding this to the DX squad's backlog. This way or another we should simplify this.

[Reinmar]

Related feature: #1012.

[jodator]

Question: How to enhance conversion.for() from Widget feature?

Another idea: expose it on the Widget plugin.

Things to remember:

• use it in existing widget features
• update the block and inline widget tutorials

[jodator]

conversion.for().add( widget.elementToWidget() )
// or import
conversion.for().add( elementToWidget() )

[Reinmar]

In #1012 I'm discussing with myself whether toWidget() should end up in the Widget plugin instance or whether we should already predict that we'll have something like CKE5.widget.utils....

[jodator]

Duplicate detected: #1228. My comments in #1228 didn't age well. The helper looks like needed but its implementation might be cumbersome because the widget system is a separate feature and the covnersion is a "core" feature.

[jodator]

Depends on the outcome of #667.

[piernik]

@jodator @Reinmar more then a year have passed and we still don't have good and easy tools or tutorial how to create good widget plugins :/ I know that You focus on paid functionalities, but please help us.
I still didn't convert from ckeditor@4 :/

[idiazroncero]

The verbosity of this is a problem: you need to create three conversions for each element on your widget, which can easily become a nightmare (imagine a widget with 5,6,7 elements! that's up to 21 conversions to write and maintain...)

Huge +1 to any kind of helper, automation or any other way to write the same on a more structured, less repetitive way.

[CKEditorBot]

There has been no activity on this issue for the past year. We've marked it as stale and will close it in 30 days. We understand it may still be relevant, so if you're interested in the solution, leave a comment or reaction under this issue.

[CKEditorBot]

We've closed your issue due to inactivity over the last year. We understand that the issue may still be relevant. If so, feel free to open a new one (and link this issue to it).