Merge pull request #223 from martinRenou/opt_client_ready_event

Make client ready event optional

Author: martinRenou

.github/workflows/main.yml

@@ -99,7 +99,7 @@ jobs:
             jlab_version: 3
           - python: '3.9'
             dist: 'ipycanvas*.whl'
-            jlab_version: 2
+            jlab_version: 2.3.2
 
     steps:
 
@@ -128,8 +128,8 @@ jobs:
           pip install -vv ${{ matrix.dist }}
 
       - name: Manually install labextension for lab2
-        if: ${{ matrix.jlab_version }} == 2
-        run: jupyter labextension install .
+        if: ${{ matrix.jlab_version }} == 2.3.2
+        run: jupyter labextension install --debug .
 
       - name: Test installation files
         run: |

ipycanvas/canvas.py

@@ -254,6 +254,8 @@ class Canvas(_CanvasBase):
     _model_name = Unicode('CanvasModel').tag(sync=True)
     _view_name = Unicode('CanvasView').tag(sync=True)
 
+    _send_client_ready_event = Bool(True).tag(sync=True)
+
     #: (valid HTML color or Gradient or Pattern) The color for filling rectangles and paths. Default to ``'black'``.
     fill_style = Union((Color(), Instance(_CanvasGradient), Instance(Pattern)), default_value='black')
 

src/widget.ts

@@ -244,6 +244,7 @@ class CanvasModel extends DOMWidgetModel {
       height: 500,
       sync_image_data: false,
       image_data: null,
+      _send_client_ready_event: true,
     };
   }
 
@@ -275,7 +276,9 @@ class CanvasModel extends DOMWidgetModel {
     this.on('change:sync_image_data', this.syncImageData.bind(this));
     this.on('msg:custom', this.onCommand.bind(this));
 
-    this.send({ event: 'client_ready' }, {});
+    if (this.get('_send_client_ready_event')) {
+      this.send({ event: 'client_ready' }, {});
+    }
   }
 
   private async drawImageData() {