@deck.gl/core 9.2.0 → 9.2.2

package/package.json

@@ -3,7 +3,7 @@
   "description": "deck.gl core library",
   "license": "MIT",
   "type": "module",
-  "version": "9.2.0",
+  "version": "9.2.2",
   "publishConfig": {
     "access": "public"
   },
@@ -58,5 +58,5 @@
     "gl-matrix": "^3.0.0",
     "mjolnir.js": "^3.0.0"
   },
-  "gitHead": "3db2198607e45909bf4013a272569583cff0edd0"
+  "gitHead": "9e183d2ce23bb21d655752ed614da0ce5a6a0458"
 }

package/src/lib/deck.ts

@@ -93,7 +93,7 @@ export type DeckProps<ViewsT extends ViewOrViews = null> = {
   /** Controls the resolution of drawing buffer used for rendering.
    * @default `true` (use browser devicePixelRatio)
    */
-  useDevicePixels?: boolean;
+  useDevicePixels?: boolean | number;
   /** Extra pixels around the pointer to include while picking.
    * @default `0`
    */

package/src/lib/tooltip-widget.ts

@@ -45,7 +45,7 @@ export class TooltipWidget extends Widget<TooltipWidgetProps> {
   lastViewport?: Viewport;
 
   constructor(props: TooltipWidgetProps = {}) {
-    super(props, TooltipWidget.defaultProps);
+    super(props);
     this.setProps(props);
   }
 

package/src/lib/widget-manager.ts

@@ -201,12 +201,11 @@ export class WidgetManager {
     widget.deck = this.deck;
 
     // Create an attach the HTML root element
-    widget.rootElement = widget.onCreateRootElement();
+    widget.rootElement = widget._onAdd({deck: this.deck, viewId});
     if (widget.rootElement) {
       this._getContainer(viewId, placement).append(widget.rootElement);
     }
 
-    widget.onAdd?.({deck: this.deck, viewId});
     widget.updateHTML();
   }
 

package/src/lib/widget.ts

@@ -50,8 +50,12 @@ export abstract class Widget<
   deck?: Deck<ViewsT>;
   rootElement?: HTMLDivElement | null;
 
-  constructor(props: PropsT, defaultProps: Required<PropsT>) {
-    this.props = {...defaultProps, ...props};
+  constructor(props: PropsT) {
+    this.props = {
+      // @ts-expect-error `defaultProps` may not exist on constructor
+      ...(this.constructor.defaultProps as Required<PropsT>),
+      ...props
+    };
     // @ts-expect-error TODO(ib) - why is id considered optional even though we use Required<>
     this.id = this.props.id;
   }
@@ -86,16 +90,14 @@ export abstract class Widget<
     }
   }
 
-  // WIDGET LIFECYCLE
-
   // @note empty method calls have an overhead in V8 but it is very low, ~1ns
 
   /**
-   * Called to create the root DOM element for this widget
+   * Common utility to create the root DOM element for this widget
    * Configures the top-level styles and adds basic class names for theming
-   * @returns an optional UI element that should be appended to the Deck container
+   * @returns an UI element that should be appended to the Deck container
    */
-  onCreateRootElement(): HTMLDivElement {
+  protected onCreateRootElement(): HTMLDivElement {
     const CLASS_NAMES = [
       // Add class names for theming
       'deck-widget',
@@ -112,16 +114,25 @@ export abstract class Widget<
     return element;
   }
 
+  // WIDGET LIFECYCLE
+
   /** Called to render HTML into the root element */
   abstract onRenderHTML(rootElement: HTMLElement): void;
 
-  /** Called after the widget is added to a Deck instance and the DOM rootElement has been created */
+  /** Internal API called by Deck when the widget is first added to a Deck instance */
+  _onAdd(params: {deck: Deck<any>; viewId: string | null}): HTMLDivElement {
+    return this.onAdd(params) ?? this.onCreateRootElement();
+  }
+
+  /** Overridable by subclass - called when the widget is first added to a Deck instance
+   * @returns an optional UI element that should be appended to the Deck container
+   */
   onAdd(params: {
     /** The Deck instance that the widget is attached to */
     deck: Deck<any>;
     /** The id of the view that the widget is attached to */
     viewId: string | null;
-  }) {}
+  }): HTMLDivElement | void {}
 
   /** Called when the widget is removed */
   onRemove(): void {}