Add widgets prop to Deck class #8023

chrisgervang · 2023-07-25T20:21:07Z

Background

To build any widgets we'll need some interface in Deck to add them. This adds a declarative interfaces to the Deck API for applications to add/update/remove widgets.

Note: This PR adds a private imperative "addDefault" similar to EffectManager so that the tooltip widget isn't affected by an application. There is ongoing discussion around a public imperative interface.

Change List

Add widgets prop to Deck for declarative use cases.
Adds private useDefault function to WidgetManager to maintain tooltip functionality
Simplifies WidgetManager "add widget" interface by adding placement and viewId as widget members.
Updated docs

coveralls · 2023-07-25T20:36:37Z

coverage: 89.85%. remained the same when pulling fc6be2c on chr/deck-widgets-prop into f368dea on master.

Pessimistress

The list needs to be deep compared in every setProps call. See implementation of the EffectManager.

chrisgervang

Thanks @Pessimistress for adding the declarative and imperative functions. Are there any caveats? Also, what do you think about adding a removeDefault with this design?

modules/core/src/lib/widget-manager.ts

chrisgervang · 2023-08-03T23:57:33Z

modules/core/src/lib/widget-manager.ts

    for (const id in this.containers) {
      this.containers[id].remove();
    }
  }

-  add(
+  // Imperative API, not affected by the declarative prop
+  addDefault(


Can an imperative user call this to add a widget in their application?

It's not exposed right now, we need an overall strategy for imperative APIs (layers, views, effects, widgets).

chrisgervang · 2023-08-05T00:09:58Z

test/modules/core/lib/widget-manager.spec.js

+    this.id = props.id;
+    this.viewId = props.viewId || null;
+    this.placement = props.placement || 'top-left';


I see, weather or not to include these members as props would be case-by-case. For instance, doesn't make sense for tooltip to have a placement prop.

Not sure if the meaning of these constants can be extended, but tooltips could be positioned relative to the cursor.

The placement for that use-case would still be "fill" I imagine, since it can still be anywhere in the map container. Marker would use the same placement, and also wouldn't expose container placement.

I'd imagine positioning relative to cursor would be internal to the widget.

chrisgervang · 2023-08-05T00:14:59Z

test/modules/core/lib/widget-manager.spec.js

-  widgetManager.add(widgetB, {viewId: 'map', placement: 'bottom-right'});
-  t.is(widgetManager.widgets.length, 2, 'widget is added');
-  t.is(widgetB._viewId, 'map', 'view id is assigned');
+  const widgetB = new TestWidget({id: 'B', viewId: 'map', placement: 'bottom-right'});


I like this API change. Having placement and viewId on add didn't make sense.

modules/core/src/lib/deck.ts

ibgreen · 2023-08-06T17:11:43Z

modules/core/src/lib/deck.ts

@@ -988,7 +992,7 @@ export default class Deck {
      deck: this,
      parentElement: this.canvas?.parentElement
    });
-    this.widgetManager.add(new Tooltip(), {placement: 'fill'});
+    this.widgetManager.addDefault(new Tooltip());


Nit: Is there any way to avoid addDefault()? Such "global" registration is usually best avoided if possible. Can the tooltip be added when it is actually used?

We'd want to consider if changing it could break something since the 8.9 and prior always adds a tooltip to the container.

modules/core/src/lib/widget-manager.ts

ibgreen · 2023-08-06T17:14:56Z

modules/core/src/lib/widget-manager.ts

-  lastViewports: {[id: string]: Viewport} = {};
+
+  /** Widgets added via the imperative API */
+  private defaultWidgets: Widget[] = [];


Maybe the names could be more reflective of the comments - imperativeWidgets / declarativeWidgets / allWidgets etc?

Yes maybe.. there's ongoing discussion in a new RFC on what our imperative API could be.

modules/core/src/lib/widget-manager.ts

ibgreen · 2023-08-06T17:19:16Z

modules/core/src/lib/widget-manager.ts

-      // widget already added
-      return;
+  /** Imperative API. Widgets added this way are not affected by the declarative prop. */
+  addDefault(widget: Widget) {


I was about to suggest a different name, but I guess this was renamed to addDefault based on previous comments.

ibgreen · 2023-08-06T17:20:19Z

test/modules/core/lib/widget-manager.spec.js

+    this.id = props.id;
+    this.viewId = props.viewId || null;
+    this.placement = props.placement || 'top-left';


Not sure if the meaning of these constants can be extended, but tooltips could be positioned relative to the cursor.

--------- Co-authored-by: Xiaoji Chen <cxiaoji@gmail.com>

chrisgervang requested review from Pessimistress and ibgreen July 25, 2023 20:21

Pessimistress reviewed Jul 25, 2023

View reviewed changes

Pessimistress force-pushed the chr/deck-widgets-prop branch from fc6be2c to f783461 Compare August 3, 2023 22:59

Pessimistress changed the title ~~add(deck) _widget prop~~ Add widgets prop to Deck class Aug 3, 2023

chrisgervang commented Aug 4, 2023

View reviewed changes

Pessimistress approved these changes Aug 4, 2023

View reviewed changes

chrisgervang and others added 4 commits August 4, 2023 15:55

add(deck) _widget prop

fceab53

declarative widgets api

bfa10b6

Add comments

adfc21a

fix test

46be41a

Pessimistress force-pushed the chr/deck-widgets-prop branch from b00ae70 to 46be41a Compare August 4, 2023 22:55

simplify widget api

f37b35e

chrisgervang commented Aug 5, 2023

View reviewed changes

chrisgervang mentioned this pull request Aug 6, 2023

add(widgets) fullscreen widget #8024

Merged

ibgreen approved these changes Aug 6, 2023

View reviewed changes

chrisgervang added 3 commits August 8, 2023 12:59

docs

024d1bc

Merge branch 'master' into chr/deck-widgets-prop

3caa7e8

add(core) export types

debbf1e

chrisgervang merged commit 1d56226 into master Aug 15, 2023
2 checks passed

chrisgervang deleted the chr/deck-widgets-prop branch August 15, 2023 19:28

Pessimistress added a commit that referenced this pull request Aug 24, 2023

Add widgets prop to Deck class (#8023)

4f3057a

--------- Co-authored-by: Xiaoji Chen <cxiaoji@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add widgets prop to Deck class #8023

Add widgets prop to Deck class #8023

chrisgervang commented Jul 25, 2023 •

edited

coveralls commented Jul 25, 2023

Pessimistress left a comment

chrisgervang left a comment

chrisgervang Aug 3, 2023

Pessimistress Aug 4, 2023

chrisgervang Aug 5, 2023

ibgreen Aug 6, 2023

chrisgervang Aug 6, 2023 •

edited

chrisgervang Aug 5, 2023

ibgreen Aug 6, 2023

chrisgervang Aug 6, 2023

ibgreen Aug 6, 2023

chrisgervang Aug 6, 2023

ibgreen Aug 6, 2023

ibgreen Aug 6, 2023

Add widgets prop to Deck class #8023

Add widgets prop to Deck class #8023

Conversation

chrisgervang commented Jul 25, 2023 • edited

Background

Change List

coveralls commented Jul 25, 2023

Pessimistress left a comment

Choose a reason for hiding this comment

chrisgervang left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisgervang Aug 6, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisgervang commented Jul 25, 2023 •

edited

chrisgervang Aug 6, 2023 •

edited