yjs-widgets does not play well with Lumino widgets

[martinRenou]

Issue

One cannot easily create a yjs-widgets based on Lumino. Because the node element that the Renderer provides is not yet attached:

class YJupyterCADWidget implements IJupyterYWidget {
  constructor(yModel: JupyterYModel, node: HTMLElement) {
    this.yModel = yModel;
    this.node = node;

    const widget = new LuminoWidget();

    // The following does not work! Because this.node is not yet attached to the DOM
    Widget.attach(widget, this.node);
  }

  yModel: JupyterYModel;
  node: HTMLElement;
}

Fix proposition

I would like to suggest modifying the JupyterYWidget to get closer to the logic we have in ipywidgets. Basically, the Widget class would be expected to have a node element that would either be a Lumino Widget:

  async renderModel(mimeModel: IRenderMime.IMimeModel): Promise<void> {
    const modelId = mimeModel.data[this._mimeType]!['model_id'];

    this._yModel = this._modelFactory.getYModel(modelId);
    if (!this._yModel) {
      return;
    }

    const widget = this._modelFactory.createYWidget(modelId);
    this.addWidget(widget.node)
  }

[davidbrochart]

I trust you on this one! I don't know Lumino.

[martinRenou]

Honestly I'm not sure forcing a Lumino would be the best way to go. But at the same time Lumino is all over the place in JupyterLab so...

[davidbrochart]

I mean yjs-widgets is already misleading, right? It's all about JupyterLab.
You mean people making e.g. React widgets won't be able to use yjs-widgets?

[martinRenou]

They would, you can make a Lumino widget that contains a react component.

It's all about JupyterLab.

Ok let's go with the fix I suggested above then?

[davidbrochart]

👍