@deck.gl-community/widgets 9.2.5 → 9.3.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -1
- package/dist/graph-widgets/_deprecate/long-press-button.d.ts.map +1 -0
- package/dist/graph-widgets/_deprecate/long-press-button.js.map +1 -0
- package/dist/graph-widgets/_deprecate/view-control-widget.d.ts.map +1 -0
- package/dist/graph-widgets/_deprecate/view-control-widget.js.map +1 -0
- package/dist/{widgets → graph-widgets}/long-press-button.d.ts +1 -0
- package/dist/graph-widgets/long-press-button.d.ts.map +1 -0
- package/dist/{widgets → graph-widgets}/long-press-button.js +1 -0
- package/dist/graph-widgets/long-press-button.js.map +1 -0
- package/dist/graph-widgets/long-press-controller.d.ts.map +1 -0
- package/dist/graph-widgets/long-press-controller.js.map +1 -0
- package/dist/{widgets → graph-widgets}/pan-widget.d.ts +3 -2
- package/dist/graph-widgets/pan-widget.d.ts.map +1 -0
- package/dist/{widgets → graph-widgets}/pan-widget.js +19 -15
- package/dist/graph-widgets/pan-widget.js.map +1 -0
- package/dist/{widgets → graph-widgets}/zoom-range-widget.d.ts +3 -3
- package/dist/graph-widgets/zoom-range-widget.d.ts.map +1 -0
- package/dist/{widgets → graph-widgets}/zoom-range-widget.js +24 -23
- package/dist/graph-widgets/zoom-range-widget.js.map +1 -0
- package/dist/html-overlay-widgets/html-cluster-widget.d.ts.map +1 -0
- package/dist/html-overlay-widgets/html-cluster-widget.js.map +1 -0
- package/dist/{widgets → html-overlay-widgets}/html-overlay-item.d.ts +1 -0
- package/dist/html-overlay-widgets/html-overlay-item.d.ts.map +1 -0
- package/dist/html-overlay-widgets/html-overlay-item.js.map +1 -0
- package/dist/{widgets → html-overlay-widgets}/html-overlay-widget.d.ts +8 -2
- package/dist/html-overlay-widgets/html-overlay-widget.d.ts.map +1 -0
- package/dist/{widgets → html-overlay-widgets}/html-overlay-widget.js +21 -7
- package/dist/html-overlay-widgets/html-overlay-widget.js.map +1 -0
- package/dist/{widgets → html-overlay-widgets}/html-tooltip-widget.d.ts +1 -0
- package/dist/html-overlay-widgets/html-tooltip-widget.d.ts.map +1 -0
- package/dist/html-overlay-widgets/html-tooltip-widget.js.map +1 -0
- package/dist/index.cjs +5119 -87
- package/dist/index.cjs.map +4 -4
- package/dist/index.d.ts +33 -12
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +27 -6
- package/dist/index.js.map +1 -1
- package/dist/keyboard-shortcuts/keyboard-shortcuts-manager.d.ts +18 -0
- package/dist/keyboard-shortcuts/keyboard-shortcuts-manager.d.ts.map +1 -0
- package/dist/keyboard-shortcuts/keyboard-shortcuts-manager.js +47 -0
- package/dist/keyboard-shortcuts/keyboard-shortcuts-manager.js.map +1 -0
- package/dist/keyboard-shortcuts/keyboard-shortcuts.d.ts +22 -0
- package/dist/keyboard-shortcuts/keyboard-shortcuts.d.ts.map +1 -0
- package/dist/keyboard-shortcuts/keyboard-shortcuts.js +83 -0
- package/dist/keyboard-shortcuts/keyboard-shortcuts.js.map +1 -0
- package/dist/lib/settings/settings.d.ts +17 -0
- package/dist/lib/settings/settings.d.ts.map +1 -0
- package/dist/lib/settings/settings.js +140 -0
- package/dist/lib/settings/settings.js.map +1 -0
- package/dist/ready-to-upstream-widgets/reset-view-widget.d.ts +21 -0
- package/dist/ready-to-upstream-widgets/reset-view-widget.d.ts.map +1 -0
- package/dist/ready-to-upstream-widgets/reset-view-widget.js +29 -0
- package/dist/ready-to-upstream-widgets/reset-view-widget.js.map +1 -0
- package/dist/widget-components/icon-button.d.ts +12 -0
- package/dist/widget-components/icon-button.d.ts.map +1 -0
- package/dist/widget-components/icon-button.js +12 -0
- package/dist/widget-components/icon-button.js.map +1 -0
- package/dist/widget-components/select-widget-component.d.ts +15 -0
- package/dist/widget-components/select-widget-component.d.ts.map +1 -0
- package/dist/widget-components/select-widget-component.js +229 -0
- package/dist/widget-components/select-widget-component.js.map +1 -0
- package/dist/widget-panels/box-widget.d.ts +43 -0
- package/dist/widget-panels/box-widget.d.ts.map +1 -0
- package/dist/widget-panels/box-widget.js +191 -0
- package/dist/widget-panels/box-widget.js.map +1 -0
- package/dist/widget-panels/box-widget.test.d.ts +2 -0
- package/dist/widget-panels/box-widget.test.d.ts.map +1 -0
- package/dist/widget-panels/box-widget.test.js +41 -0
- package/dist/widget-panels/box-widget.test.js.map +1 -0
- package/dist/widget-panels/full-screen-panel-widget.d.ts +33 -0
- package/dist/widget-panels/full-screen-panel-widget.d.ts.map +1 -0
- package/dist/widget-panels/full-screen-panel-widget.js +153 -0
- package/dist/widget-panels/full-screen-panel-widget.js.map +1 -0
- package/dist/widget-panels/full-screen-panel-widget.test.d.ts +2 -0
- package/dist/widget-panels/full-screen-panel-widget.test.d.ts.map +1 -0
- package/dist/widget-panels/full-screen-panel-widget.test.js +40 -0
- package/dist/widget-panels/full-screen-panel-widget.test.js.map +1 -0
- package/dist/widget-panels/heap-memory-widget.d.ts +26 -0
- package/dist/widget-panels/heap-memory-widget.d.ts.map +1 -0
- package/dist/widget-panels/heap-memory-widget.js +156 -0
- package/dist/widget-panels/heap-memory-widget.js.map +1 -0
- package/dist/widget-panels/keyboard-shortcuts-widget.d.ts +46 -0
- package/dist/widget-panels/keyboard-shortcuts-widget.d.ts.map +1 -0
- package/dist/widget-panels/keyboard-shortcuts-widget.js +301 -0
- package/dist/widget-panels/keyboard-shortcuts-widget.js.map +1 -0
- package/dist/widget-panels/modal-widget.d.ts +62 -0
- package/dist/widget-panels/modal-widget.d.ts.map +1 -0
- package/dist/widget-panels/modal-widget.js +309 -0
- package/dist/widget-panels/modal-widget.js.map +1 -0
- package/dist/widget-panels/modal-widget.test.d.ts +2 -0
- package/dist/widget-panels/modal-widget.test.d.ts.map +1 -0
- package/dist/widget-panels/modal-widget.test.js +103 -0
- package/dist/widget-panels/modal-widget.test.js.map +1 -0
- package/dist/widget-panels/omni-box-widget.d.ts +59 -0
- package/dist/widget-panels/omni-box-widget.d.ts.map +1 -0
- package/dist/widget-panels/omni-box-widget.js +562 -0
- package/dist/widget-panels/omni-box-widget.js.map +1 -0
- package/dist/widget-panels/omni-box-widget.test.d.ts +2 -0
- package/dist/widget-panels/omni-box-widget.test.d.ts.map +1 -0
- package/dist/widget-panels/omni-box-widget.test.js +49 -0
- package/dist/widget-panels/omni-box-widget.test.js.map +1 -0
- package/dist/widget-panels/reset-view-widget.d.ts +20 -0
- package/dist/widget-panels/reset-view-widget.d.ts.map +1 -0
- package/dist/widget-panels/reset-view-widget.js +28 -0
- package/dist/widget-panels/reset-view-widget.js.map +1 -0
- package/dist/widget-panels/settings-panel.d.ts +49 -0
- package/dist/widget-panels/settings-panel.d.ts.map +1 -0
- package/dist/widget-panels/settings-panel.js +263 -0
- package/dist/widget-panels/settings-panel.js.map +1 -0
- package/dist/widget-panels/settings-panel.test.d.ts +2 -0
- package/dist/widget-panels/settings-panel.test.d.ts.map +1 -0
- package/dist/widget-panels/settings-panel.test.js +217 -0
- package/dist/widget-panels/settings-panel.test.js.map +1 -0
- package/dist/widget-panels/sidebar-widget.d.ts +65 -0
- package/dist/widget-panels/sidebar-widget.d.ts.map +1 -0
- package/dist/widget-panels/sidebar-widget.js +339 -0
- package/dist/widget-panels/sidebar-widget.js.map +1 -0
- package/dist/widget-panels/sidebar-widget.test.d.ts +2 -0
- package/dist/widget-panels/sidebar-widget.test.d.ts.map +1 -0
- package/dist/widget-panels/sidebar-widget.test.js +175 -0
- package/dist/widget-panels/sidebar-widget.test.js.map +1 -0
- package/dist/widget-panels/stats-panel.d.ts +34 -0
- package/dist/widget-panels/stats-panel.d.ts.map +1 -0
- package/dist/widget-panels/stats-panel.js +61 -0
- package/dist/widget-panels/stats-panel.js.map +1 -0
- package/dist/widget-panels/stats-panel.test.d.ts +2 -0
- package/dist/widget-panels/stats-panel.test.d.ts.map +1 -0
- package/dist/widget-panels/stats-panel.test.js +36 -0
- package/dist/widget-panels/stats-panel.test.js.map +1 -0
- package/dist/widget-panels/text-editor-panel-monaco-runtime.d.ts +17 -0
- package/dist/widget-panels/text-editor-panel-monaco-runtime.d.ts.map +1 -0
- package/dist/widget-panels/text-editor-panel-monaco-runtime.js +69 -0
- package/dist/widget-panels/text-editor-panel-monaco-runtime.js.map +1 -0
- package/dist/widget-panels/text-editor-panel.d.ts +42 -0
- package/dist/widget-panels/text-editor-panel.d.ts.map +1 -0
- package/dist/widget-panels/text-editor-panel.js +249 -0
- package/dist/widget-panels/text-editor-panel.js.map +1 -0
- package/dist/widget-panels/text-editor-panel.test.d.ts +2 -0
- package/dist/widget-panels/text-editor-panel.test.d.ts.map +1 -0
- package/dist/widget-panels/text-editor-panel.test.js +393 -0
- package/dist/widget-panels/text-editor-panel.test.js.map +1 -0
- package/dist/widget-panels/time-measure-widget.d.ts +49 -0
- package/dist/widget-panels/time-measure-widget.d.ts.map +1 -0
- package/dist/widget-panels/time-measure-widget.js +351 -0
- package/dist/widget-panels/time-measure-widget.js.map +1 -0
- package/dist/widget-panels/toast-manager.d.ts +24 -0
- package/dist/widget-panels/toast-manager.d.ts.map +1 -0
- package/dist/widget-panels/toast-manager.js +96 -0
- package/dist/widget-panels/toast-manager.js.map +1 -0
- package/dist/widget-panels/toast-manager.test.d.ts +2 -0
- package/dist/widget-panels/toast-manager.test.d.ts.map +1 -0
- package/dist/widget-panels/toast-manager.test.js +75 -0
- package/dist/widget-panels/toast-manager.test.js.map +1 -0
- package/dist/widget-panels/toast-widget.d.ts +20 -0
- package/dist/widget-panels/toast-widget.d.ts.map +1 -0
- package/dist/widget-panels/toast-widget.js +207 -0
- package/dist/widget-panels/toast-widget.js.map +1 -0
- package/dist/widget-panels/toast-widget.test.d.ts +2 -0
- package/dist/widget-panels/toast-widget.test.d.ts.map +1 -0
- package/dist/widget-panels/toast-widget.test.js +81 -0
- package/dist/widget-panels/toast-widget.test.js.map +1 -0
- package/dist/widget-panels/toggle-widget.d.ts +34 -0
- package/dist/widget-panels/toggle-widget.d.ts.map +1 -0
- package/dist/widget-panels/toggle-widget.js +46 -0
- package/dist/widget-panels/toggle-widget.js.map +1 -0
- package/dist/widget-panels/toolbar-widget.d.ts +53 -0
- package/dist/widget-panels/toolbar-widget.d.ts.map +1 -0
- package/dist/widget-panels/toolbar-widget.js +160 -0
- package/dist/widget-panels/toolbar-widget.js.map +1 -0
- package/dist/widget-panels/toolbar-widget.test.d.ts +2 -0
- package/dist/widget-panels/toolbar-widget.test.d.ts.map +1 -0
- package/dist/widget-panels/toolbar-widget.test.js +105 -0
- package/dist/widget-panels/toolbar-widget.test.js.map +1 -0
- package/dist/widget-panels/widget-containers.d.ts +275 -0
- package/dist/widget-panels/widget-containers.d.ts.map +1 -0
- package/dist/widget-panels/widget-containers.js +761 -0
- package/dist/widget-panels/widget-containers.js.map +1 -0
- package/dist/widget-panels/widget-containers.test.d.ts +2 -0
- package/dist/widget-panels/widget-containers.test.d.ts.map +1 -0
- package/dist/widget-panels/widget-containers.test.js +337 -0
- package/dist/widget-panels/widget-containers.test.js.map +1 -0
- package/dist/widget-panels/y-zoom-widget.d.ts +66 -0
- package/dist/widget-panels/y-zoom-widget.d.ts.map +1 -0
- package/dist/widget-panels/y-zoom-widget.js +264 -0
- package/dist/widget-panels/y-zoom-widget.js.map +1 -0
- package/dist/widget-panels/y-zoom-widget.test.d.ts +2 -0
- package/dist/widget-panels/y-zoom-widget.test.d.ts.map +1 -0
- package/dist/widget-panels/y-zoom-widget.test.js +71 -0
- package/dist/widget-panels/y-zoom-widget.test.js.map +1 -0
- package/dist/widgets/heap-memory-widget.d.ts +26 -0
- package/dist/widgets/heap-memory-widget.d.ts.map +1 -0
- package/dist/widgets/heap-memory-widget.js +158 -0
- package/dist/widgets/heap-memory-widget.js.map +1 -0
- package/dist/widgets/keyboard-shortcuts-widget.d.ts +28 -0
- package/dist/widgets/keyboard-shortcuts-widget.d.ts.map +1 -0
- package/dist/widgets/keyboard-shortcuts-widget.js +125 -0
- package/dist/widgets/keyboard-shortcuts-widget.js.map +1 -0
- package/dist/widgets/omni-box-widget.d.ts +59 -0
- package/dist/widgets/omni-box-widget.d.ts.map +1 -0
- package/dist/widgets/omni-box-widget.js +493 -0
- package/dist/widgets/omni-box-widget.js.map +1 -0
- package/dist/widgets/settings-widget.d.ts +64 -0
- package/dist/widgets/settings-widget.d.ts.map +1 -0
- package/dist/widgets/settings-widget.js +148 -0
- package/dist/widgets/settings-widget.js.map +1 -0
- package/dist/widgets/view-manager-utils.d.ts +1 -1
- package/dist/widgets/view-manager-utils.d.ts.map +1 -1
- package/dist/widgets/view-manager-utils.js.map +1 -1
- package/package.json +4 -3
- package/src/{widgets → graph-widgets}/long-press-button.tsx +1 -0
- package/src/{widgets → graph-widgets}/pan-widget.tsx +30 -23
- package/src/{widgets → graph-widgets}/zoom-range-widget.tsx +36 -34
- package/src/{widgets → html-overlay-widgets}/html-overlay-item.tsx +1 -0
- package/src/{widgets → html-overlay-widgets}/html-overlay-widget.tsx +32 -9
- package/src/{widgets → html-overlay-widgets}/html-tooltip-widget.tsx +1 -0
- package/src/index.ts +109 -12
- package/src/keyboard-shortcuts/keyboard-shortcuts-manager.ts +58 -0
- package/src/keyboard-shortcuts/keyboard-shortcuts.ts +113 -0
- package/src/keyboard-shortcuts/keyboard-shortcuts.ts.disabled +107 -0
- package/src/lib/settings/settings.ts +203 -0
- package/src/ready-to-upstream-widgets/reset-view-widget.tsx +57 -0
- package/src/widget-components/icon-button.tsx +38 -0
- package/src/widget-components/select-widget-component.tsx +354 -0
- package/src/widget-panels/box-widget.test.tsx +50 -0
- package/src/widget-panels/box-widget.tsx +284 -0
- package/src/widget-panels/full-screen-panel-widget.test.tsx +49 -0
- package/src/widget-panels/full-screen-panel-widget.tsx +223 -0
- package/src/widget-panels/heap-memory-widget.tsx +221 -0
- package/src/widget-panels/keyboard-shortcuts-widget.tsx +511 -0
- package/src/widget-panels/modal-widget.test.tsx +124 -0
- package/src/widget-panels/modal-widget.tsx +464 -0
- package/src/widget-panels/omni-box-widget.test.tsx +59 -0
- package/src/widget-panels/omni-box-widget.tsx +849 -0
- package/src/widget-panels/reset-view-widget.tsx +56 -0
- package/src/widget-panels/settings-panel.test.tsx +286 -0
- package/src/widget-panels/settings-panel.tsx +619 -0
- package/src/widget-panels/sidebar-widget.test.tsx +215 -0
- package/src/widget-panels/sidebar-widget.tsx +525 -0
- package/src/widget-panels/stats-panel.test.tsx +41 -0
- package/src/widget-panels/stats-panel.tsx +108 -0
- package/src/widget-panels/text-editor-panel-monaco-runtime.ts +97 -0
- package/src/widget-panels/text-editor-panel.test.tsx +618 -0
- package/src/widget-panels/text-editor-panel.tsx +375 -0
- package/src/widget-panels/time-measure-widget.tsx +445 -0
- package/src/widget-panels/toast-manager.test.ts +98 -0
- package/src/widget-panels/toast-manager.ts +134 -0
- package/src/widget-panels/toast-widget.test.tsx +105 -0
- package/src/widget-panels/toast-widget.tsx +293 -0
- package/src/widget-panels/toggle-widget.tsx +93 -0
- package/src/widget-panels/toolbar-widget.test.ts +129 -0
- package/src/widget-panels/toolbar-widget.tsx +293 -0
- package/src/widget-panels/widget-containers.test.tsx +453 -0
- package/src/widget-panels/widget-containers.tsx +1330 -0
- package/src/widget-panels/worker-modules.d.ts +7 -0
- package/src/widget-panels/y-zoom-widget.test.tsx +101 -0
- package/src/widget-panels/y-zoom-widget.tsx +376 -0
- package/src/widgets/heap-memory-widget.tsx +223 -0
- package/src/widgets/keyboard-shortcuts-widget.tsx +245 -0
- package/src/widgets/omni-box-widget.tsx +768 -0
- package/src/widgets/settings-widget.tsx +277 -0
- package/src/widgets/view-manager-utils.ts +1 -1
- package/dist/_deprecate/long-press-button.d.ts.map +0 -1
- package/dist/_deprecate/long-press-button.js.map +0 -1
- package/dist/_deprecate/view-control-widget.d.ts.map +0 -1
- package/dist/_deprecate/view-control-widget.js.map +0 -1
- package/dist/widgets/html-cluster-widget.d.ts.map +0 -1
- package/dist/widgets/html-cluster-widget.js.map +0 -1
- package/dist/widgets/html-overlay-item.d.ts.map +0 -1
- package/dist/widgets/html-overlay-item.js.map +0 -1
- package/dist/widgets/html-overlay-widget.d.ts.map +0 -1
- package/dist/widgets/html-overlay-widget.js.map +0 -1
- package/dist/widgets/html-tooltip-widget.d.ts.map +0 -1
- package/dist/widgets/html-tooltip-widget.js.map +0 -1
- package/dist/widgets/long-press-button.d.ts.map +0 -1
- package/dist/widgets/long-press-button.js.map +0 -1
- package/dist/widgets/long-press-controller.d.ts.map +0 -1
- package/dist/widgets/long-press-controller.js.map +0 -1
- package/dist/widgets/pan-widget.d.ts.map +0 -1
- package/dist/widgets/pan-widget.js.map +0 -1
- package/dist/widgets/zoom-range-widget.d.ts.map +0 -1
- package/dist/widgets/zoom-range-widget.js.map +0 -1
- /package/dist/{_deprecate → graph-widgets/_deprecate}/long-press-button.d.ts +0 -0
- /package/dist/{_deprecate → graph-widgets/_deprecate}/long-press-button.js +0 -0
- /package/dist/{_deprecate → graph-widgets/_deprecate}/view-control-widget.d.ts +0 -0
- /package/dist/{_deprecate → graph-widgets/_deprecate}/view-control-widget.js +0 -0
- /package/dist/{widgets → graph-widgets}/long-press-controller.d.ts +0 -0
- /package/dist/{widgets → graph-widgets}/long-press-controller.js +0 -0
- /package/dist/{widgets → html-overlay-widgets}/html-cluster-widget.d.ts +0 -0
- /package/dist/{widgets → html-overlay-widgets}/html-cluster-widget.js +0 -0
- /package/dist/{widgets → html-overlay-widgets}/html-overlay-item.js +0 -0
- /package/dist/{widgets → html-overlay-widgets}/html-tooltip-widget.js +0 -0
- /package/src/{_deprecate → graph-widgets/_deprecate}/long-press-button.tsx +0 -0
- /package/src/{_deprecate → graph-widgets/_deprecate}/view-control-widget.tsx +0 -0
- /package/src/{widgets → graph-widgets}/long-press-controller.ts +0 -0
- /package/src/{widgets → html-overlay-widgets}/html-cluster-widget.ts +0 -0
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import {afterEach, describe, expect, it, vi} from 'vitest';
|
|
2
|
+
|
|
3
|
+
import {YZoomWidget} from './y-zoom-widget';
|
|
4
|
+
|
|
5
|
+
type MockViewportOptions = {
|
|
6
|
+
id?: string;
|
|
7
|
+
zoomY?: number;
|
|
8
|
+
zoomX?: number;
|
|
9
|
+
minZoom?: number | [number, number];
|
|
10
|
+
maxZoom?: number | [number, number];
|
|
11
|
+
target?: [number, number, number];
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Creates a minimal orthographic viewport-shaped object for widget tests.
|
|
16
|
+
*/
|
|
17
|
+
function createViewport(options: MockViewportOptions = {}) {
|
|
18
|
+
return {
|
|
19
|
+
id: options.id ?? 'main',
|
|
20
|
+
zoomY: options.zoomY ?? 0,
|
|
21
|
+
zoomX: options.zoomX ?? 0,
|
|
22
|
+
minZoom: options.minZoom,
|
|
23
|
+
maxZoom: options.maxZoom,
|
|
24
|
+
target: options.target ?? [0, 0, 0]
|
|
25
|
+
} as any;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Builds a widget instance with a spyable HTML update path.
|
|
30
|
+
*/
|
|
31
|
+
function createWidget(props: ConstructorParameters<typeof YZoomWidget>[0] = {}) {
|
|
32
|
+
const widget = new YZoomWidget(props);
|
|
33
|
+
const updateHTMLSpy = vi.spyOn(widget, 'updateHTML').mockImplementation(() => undefined);
|
|
34
|
+
return {widget, updateHTMLSpy};
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
afterEach(() => {
|
|
38
|
+
vi.restoreAllMocks();
|
|
39
|
+
document.body.innerHTML = '';
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
describe('YZoomWidget', () => {
|
|
43
|
+
it('does not re-render for viewport updates when Y zoom and bounds are unchanged', () => {
|
|
44
|
+
const {widget, updateHTMLSpy} = createWidget();
|
|
45
|
+
const viewport = createViewport({zoomY: 2, minZoom: [-5, -3], maxZoom: [5, 4]});
|
|
46
|
+
|
|
47
|
+
widget.onViewportChange(viewport);
|
|
48
|
+
widget.onViewportChange(viewport);
|
|
49
|
+
|
|
50
|
+
expect(updateHTMLSpy).toHaveBeenCalledTimes(1);
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
it('re-renders when Y zoom changes', () => {
|
|
54
|
+
const {widget, updateHTMLSpy} = createWidget();
|
|
55
|
+
|
|
56
|
+
widget.onViewportChange(createViewport({zoomY: 1, minZoom: [-5, -3], maxZoom: [5, 4]}));
|
|
57
|
+
widget.onViewportChange(createViewport({zoomY: 2, minZoom: [-5, -3], maxZoom: [5, 4]}));
|
|
58
|
+
|
|
59
|
+
expect(updateHTMLSpy).toHaveBeenCalledTimes(2);
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
it('re-renders when effective zoom bounds change without changing Y zoom', () => {
|
|
63
|
+
const {widget, updateHTMLSpy} = createWidget();
|
|
64
|
+
|
|
65
|
+
widget.onViewportChange(createViewport({zoomY: 1, minZoom: [-5, -3], maxZoom: [5, 4]}));
|
|
66
|
+
widget.onViewportChange(createViewport({zoomY: 1, minZoom: [-5, -2], maxZoom: [5, 4]}));
|
|
67
|
+
|
|
68
|
+
expect(updateHTMLSpy).toHaveBeenCalledTimes(2);
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
it('only re-renders once across repeated identical viewport updates', () => {
|
|
72
|
+
const {widget, updateHTMLSpy} = createWidget();
|
|
73
|
+
const viewport = createViewport({zoomY: 1.5, minZoom: [-5, -3], maxZoom: [5, 4]});
|
|
74
|
+
|
|
75
|
+
widget.onViewportChange(viewport);
|
|
76
|
+
widget.onViewportChange(viewport);
|
|
77
|
+
widget.onViewportChange(viewport);
|
|
78
|
+
|
|
79
|
+
expect(updateHTMLSpy).toHaveBeenCalledTimes(1);
|
|
80
|
+
});
|
|
81
|
+
|
|
82
|
+
it('does not double re-render when a widget-driven zoom is followed by the matching viewport callback', () => {
|
|
83
|
+
const {widget, updateHTMLSpy} = createWidget();
|
|
84
|
+
const viewport = createViewport({zoomY: 1, zoomX: 0, minZoom: [-5, -3], maxZoom: [5, 4]});
|
|
85
|
+
const deck = {
|
|
86
|
+
_onViewStateChange: vi.fn()
|
|
87
|
+
} as any;
|
|
88
|
+
|
|
89
|
+
widget.deck = deck;
|
|
90
|
+
widget.onViewportChange(viewport);
|
|
91
|
+
updateHTMLSpy.mockClear();
|
|
92
|
+
|
|
93
|
+
(widget as any).updateViewState(viewport, 2);
|
|
94
|
+
widget.onViewportChange(
|
|
95
|
+
createViewport({zoomY: 2, zoomX: 0, minZoom: [-5, -3], maxZoom: [5, 4]})
|
|
96
|
+
);
|
|
97
|
+
|
|
98
|
+
expect(updateHTMLSpy).toHaveBeenCalledTimes(1);
|
|
99
|
+
expect(deck._onViewStateChange).toHaveBeenCalledTimes(1);
|
|
100
|
+
});
|
|
101
|
+
});
|
|
@@ -0,0 +1,376 @@
|
|
|
1
|
+
/** @jsxImportSource preact */
|
|
2
|
+
import {OrthographicViewport, Widget} from '@deck.gl/core';
|
|
3
|
+
import {render} from 'preact';
|
|
4
|
+
|
|
5
|
+
import {IconButton, makeTextIcon} from '../widget-components/icon-button';
|
|
6
|
+
|
|
7
|
+
import type {Deck, OrthographicViewState, WidgetPlacement, WidgetProps} from '@deck.gl/core';
|
|
8
|
+
import type {JSX} from 'preact';
|
|
9
|
+
|
|
10
|
+
export type YZoomWidgetProps = WidgetProps & {
|
|
11
|
+
contentBounds?: [[number, number], [number, number]];
|
|
12
|
+
viewId?: string | null;
|
|
13
|
+
targetViewId?: string | null;
|
|
14
|
+
placement?: WidgetPlacement;
|
|
15
|
+
minZoom?: number;
|
|
16
|
+
maxZoom?: number;
|
|
17
|
+
step?: number;
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
const DEFAULT_ZOOM_LIMITS = {min: -20, max: 20} as const;
|
|
21
|
+
|
|
22
|
+
type RenderedZoomState = {
|
|
23
|
+
clampedZoom: number;
|
|
24
|
+
minZoom: number;
|
|
25
|
+
maxZoom: number;
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
const WRAPPER_STYLE: JSX.CSSProperties = {
|
|
29
|
+
display: 'flex',
|
|
30
|
+
flexDirection: 'column',
|
|
31
|
+
alignItems: 'center',
|
|
32
|
+
gap: '4px',
|
|
33
|
+
background: 'var(--button-background)',
|
|
34
|
+
border: '1px solid var(--button-stroke)',
|
|
35
|
+
boxShadow: 'var(--button-shadow)',
|
|
36
|
+
borderRadius: 'var(--button-corner-radius)',
|
|
37
|
+
margin: 'var(--widget-margin) 0',
|
|
38
|
+
padding: '4px 2px',
|
|
39
|
+
width: 'var(--button-size)',
|
|
40
|
+
boxSizing: 'border-box',
|
|
41
|
+
userSelect: 'none',
|
|
42
|
+
pointerEvents: 'auto'
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
const ZOOM_BUTTON_STYLE: JSX.CSSProperties = {
|
|
46
|
+
boxShadow: 'none'
|
|
47
|
+
};
|
|
48
|
+
|
|
49
|
+
const SLIDER_CONTAINER_STYLE: JSX.CSSProperties = {
|
|
50
|
+
display: 'flex',
|
|
51
|
+
alignItems: 'stretch',
|
|
52
|
+
height: '120px',
|
|
53
|
+
padding: '2px 0'
|
|
54
|
+
};
|
|
55
|
+
|
|
56
|
+
const VERTICAL_SLIDER_STYLE: JSX.CSSProperties = {
|
|
57
|
+
writingMode: 'vertical-lr',
|
|
58
|
+
height: '120px',
|
|
59
|
+
width: '14px',
|
|
60
|
+
margin: 0,
|
|
61
|
+
padding: 0
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
function cloneViewState(viewState: unknown): Record<string, unknown> {
|
|
65
|
+
return viewState && typeof viewState === 'object'
|
|
66
|
+
? {...(viewState as Record<string, unknown>)}
|
|
67
|
+
: {};
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
function hasViewManager(deck: Deck): boolean {
|
|
71
|
+
return Boolean((deck as Deck & {viewManager?: unknown}).viewManager);
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
function stopEventPropagation(event: Event) {
|
|
75
|
+
event.stopPropagation();
|
|
76
|
+
if (
|
|
77
|
+
typeof (event as {stopImmediatePropagation?: () => void}).stopImmediatePropagation ===
|
|
78
|
+
'function'
|
|
79
|
+
) {
|
|
80
|
+
event.stopImmediatePropagation();
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
function getZoomLimitForAxis(
|
|
85
|
+
limit: OrthographicViewState['minZoom' | 'maxZoom'] | undefined,
|
|
86
|
+
axisIndex: 0 | 1
|
|
87
|
+
): number | undefined {
|
|
88
|
+
if (Array.isArray(limit)) {
|
|
89
|
+
const [x, y] = limit;
|
|
90
|
+
return axisIndex === 0 ? x : (y ?? x);
|
|
91
|
+
}
|
|
92
|
+
return typeof limit === 'number' && Number.isFinite(limit) ? limit : undefined;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
function clamp(value: number, min: number, max: number): number {
|
|
96
|
+
if (value < min) return min;
|
|
97
|
+
if (value > max) return max;
|
|
98
|
+
return value;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
export class YZoomWidget extends Widget<YZoomWidgetProps> {
|
|
102
|
+
static override defaultProps = {
|
|
103
|
+
...Widget.defaultProps,
|
|
104
|
+
id: 'y-zoom',
|
|
105
|
+
viewId: null,
|
|
106
|
+
targetViewId: null,
|
|
107
|
+
placement: 'top-left',
|
|
108
|
+
minZoom: undefined,
|
|
109
|
+
maxZoom: undefined,
|
|
110
|
+
step: 0.1
|
|
111
|
+
} satisfies Required<WidgetProps> & Required<Pick<YZoomWidgetProps, 'step'>> & YZoomWidgetProps;
|
|
112
|
+
|
|
113
|
+
placement: WidgetPlacement = 'top-left';
|
|
114
|
+
className = 'deck-widget-y-zoom';
|
|
115
|
+
step: number;
|
|
116
|
+
currentZoom = 0;
|
|
117
|
+
inferredMinZoom: number | null = null;
|
|
118
|
+
inferredMaxZoom: number | null = null;
|
|
119
|
+
lastRenderedZoomState: RenderedZoomState | null = null;
|
|
120
|
+
|
|
121
|
+
constructor(props: YZoomWidgetProps = {}) {
|
|
122
|
+
super({...YZoomWidget.defaultProps, ...props});
|
|
123
|
+
this.viewId = props.viewId ?? null;
|
|
124
|
+
this.placement = props.placement ?? 'top-left';
|
|
125
|
+
this.step = props.step ?? YZoomWidget.defaultProps.step;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
override setProps(props: Partial<YZoomWidgetProps>): void {
|
|
129
|
+
if (props.viewId !== undefined) {
|
|
130
|
+
this.viewId = props.viewId;
|
|
131
|
+
}
|
|
132
|
+
if (props.placement !== undefined) {
|
|
133
|
+
this.placement = props.placement;
|
|
134
|
+
}
|
|
135
|
+
if (props.step !== undefined) {
|
|
136
|
+
this.step = props.step;
|
|
137
|
+
}
|
|
138
|
+
super.setProps(props);
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
override onAdd({deck, viewId}: {deck: Deck; viewId: string | null}): void {
|
|
142
|
+
this.deck = deck;
|
|
143
|
+
if (this.viewId === undefined) {
|
|
144
|
+
this.viewId = viewId;
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
override onRemove(): void {
|
|
149
|
+
this.deck = undefined;
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
override onRenderHTML(rootElement: HTMLElement): void {
|
|
153
|
+
const {minZoom, maxZoom, clampedZoom} = this.getRenderedZoomState();
|
|
154
|
+
this.lastRenderedZoomState = {minZoom, maxZoom, clampedZoom};
|
|
155
|
+
|
|
156
|
+
const handleInput = (event: Event) => {
|
|
157
|
+
stopEventPropagation(event);
|
|
158
|
+
this.handleZoomTo(Number((event.target as HTMLInputElement).value));
|
|
159
|
+
};
|
|
160
|
+
|
|
161
|
+
const addVerticalOrient = (element: HTMLInputElement | null) => {
|
|
162
|
+
element?.setAttribute('orient', 'vertical');
|
|
163
|
+
};
|
|
164
|
+
|
|
165
|
+
const stopPointerPropagation: JSX.PointerEventHandler<HTMLElement> = (event) => {
|
|
166
|
+
stopEventPropagation(event as unknown as Event);
|
|
167
|
+
};
|
|
168
|
+
|
|
169
|
+
const stopWheelPropagation: JSX.WheelEventHandler<HTMLElement> = (event) => {
|
|
170
|
+
stopEventPropagation(event as unknown as Event);
|
|
171
|
+
};
|
|
172
|
+
|
|
173
|
+
const stopMousePropagation: JSX.MouseEventHandler<HTMLElement> = (event) => {
|
|
174
|
+
stopEventPropagation(event as unknown as Event);
|
|
175
|
+
};
|
|
176
|
+
|
|
177
|
+
render(
|
|
178
|
+
<div className="deck-widget-button-group" style={WRAPPER_STYLE}>
|
|
179
|
+
<IconButton
|
|
180
|
+
icon={makeTextIcon('—')}
|
|
181
|
+
style={ZOOM_BUTTON_STYLE}
|
|
182
|
+
title="zoom out"
|
|
183
|
+
onClick={() => this.handleZoomDelta(-this.step)}
|
|
184
|
+
/>
|
|
185
|
+
<div
|
|
186
|
+
style={SLIDER_CONTAINER_STYLE}
|
|
187
|
+
onPointerDown={stopPointerPropagation}
|
|
188
|
+
onPointerMove={stopPointerPropagation}
|
|
189
|
+
onPointerUp={stopPointerPropagation}
|
|
190
|
+
onWheel={stopWheelPropagation}
|
|
191
|
+
onMouseDown={stopMousePropagation}
|
|
192
|
+
onMouseMove={stopMousePropagation}
|
|
193
|
+
onMouseUp={stopMousePropagation}
|
|
194
|
+
>
|
|
195
|
+
<input
|
|
196
|
+
ref={addVerticalOrient}
|
|
197
|
+
type="range"
|
|
198
|
+
min={String(minZoom)}
|
|
199
|
+
max={String(maxZoom)}
|
|
200
|
+
step={String(this.step)}
|
|
201
|
+
value={String(clampedZoom)}
|
|
202
|
+
aria-label="Adjust Y-axis zoom"
|
|
203
|
+
style={VERTICAL_SLIDER_STYLE}
|
|
204
|
+
onInput={handleInput}
|
|
205
|
+
onChange={handleInput}
|
|
206
|
+
onPointerDown={stopPointerPropagation}
|
|
207
|
+
onPointerMove={stopPointerPropagation}
|
|
208
|
+
onPointerUp={stopPointerPropagation}
|
|
209
|
+
onWheel={stopWheelPropagation}
|
|
210
|
+
onMouseDown={stopMousePropagation}
|
|
211
|
+
onMouseMove={stopMousePropagation}
|
|
212
|
+
onMouseUp={stopMousePropagation}
|
|
213
|
+
/>
|
|
214
|
+
</div>
|
|
215
|
+
<IconButton
|
|
216
|
+
icon={makeTextIcon('+')}
|
|
217
|
+
style={ZOOM_BUTTON_STYLE}
|
|
218
|
+
title="zoom in"
|
|
219
|
+
onClick={() => this.handleZoomDelta(this.step)}
|
|
220
|
+
/>
|
|
221
|
+
</div>,
|
|
222
|
+
rootElement
|
|
223
|
+
);
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
override onViewportChange(viewport: OrthographicViewport): void {
|
|
227
|
+
const targetViewId = this.props.targetViewId ?? this.viewId;
|
|
228
|
+
if (targetViewId && targetViewId !== viewport.id) return;
|
|
229
|
+
|
|
230
|
+
const viewState = this.getViewportViewState(viewport);
|
|
231
|
+
const zoomY = viewport.zoomY;
|
|
232
|
+
this.currentZoom = zoomY;
|
|
233
|
+
|
|
234
|
+
if (this.props.minZoom === undefined) {
|
|
235
|
+
const minZoom = getZoomLimitForAxis(viewState.minZoom, 1);
|
|
236
|
+
if (Number.isFinite(minZoom)) {
|
|
237
|
+
this.inferredMinZoom = minZoom;
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
if (this.props.maxZoom === undefined) {
|
|
242
|
+
const maxZoom = getZoomLimitForAxis(viewState.maxZoom, 1);
|
|
243
|
+
if (Number.isFinite(maxZoom)) {
|
|
244
|
+
this.inferredMaxZoom = maxZoom;
|
|
245
|
+
}
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
this.updateHTMLIfRenderedStateChanged();
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
/**
|
|
252
|
+
* Returns the effective min/max bounds and the clamped zoom value currently shown in the slider.
|
|
253
|
+
*/
|
|
254
|
+
private getRenderedZoomState(): RenderedZoomState {
|
|
255
|
+
const {minZoom, maxZoom} = this.getZoomBounds();
|
|
256
|
+
return {
|
|
257
|
+
minZoom,
|
|
258
|
+
maxZoom,
|
|
259
|
+
clampedZoom: clamp(this.currentZoom, minZoom, maxZoom)
|
|
260
|
+
};
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
/**
|
|
264
|
+
* Re-renders the widget only when the displayed slider state changed.
|
|
265
|
+
*/
|
|
266
|
+
private updateHTMLIfRenderedStateChanged(): void {
|
|
267
|
+
const nextState = this.getRenderedZoomState();
|
|
268
|
+
const previousState = this.lastRenderedZoomState;
|
|
269
|
+
if (
|
|
270
|
+
previousState &&
|
|
271
|
+
previousState.clampedZoom === nextState.clampedZoom &&
|
|
272
|
+
previousState.minZoom === nextState.minZoom &&
|
|
273
|
+
previousState.maxZoom === nextState.maxZoom
|
|
274
|
+
) {
|
|
275
|
+
return;
|
|
276
|
+
}
|
|
277
|
+
this.lastRenderedZoomState = nextState;
|
|
278
|
+
this.updateHTML();
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
/**
|
|
282
|
+
* Resolves the slider min/max bounds from explicit props or inferred viewport limits.
|
|
283
|
+
*/
|
|
284
|
+
private getZoomBounds(): {minZoom: number; maxZoom: number} {
|
|
285
|
+
const minZoom = this.props.minZoom ?? this.inferredMinZoom ?? Number.NEGATIVE_INFINITY;
|
|
286
|
+
const maxZoom = this.props.maxZoom ?? this.inferredMaxZoom ?? Number.POSITIVE_INFINITY;
|
|
287
|
+
|
|
288
|
+
if (minZoom > maxZoom) {
|
|
289
|
+
return {minZoom: maxZoom, maxZoom: minZoom};
|
|
290
|
+
}
|
|
291
|
+
return {
|
|
292
|
+
minZoom: Number.isFinite(minZoom) ? minZoom : DEFAULT_ZOOM_LIMITS.min,
|
|
293
|
+
maxZoom: Number.isFinite(maxZoom) ? maxZoom : DEFAULT_ZOOM_LIMITS.max
|
|
294
|
+
};
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
private getTargetViewports(): OrthographicViewport[] {
|
|
298
|
+
const deck = this.deck;
|
|
299
|
+
if (!deck) {
|
|
300
|
+
return [];
|
|
301
|
+
}
|
|
302
|
+
if (this.viewId) {
|
|
303
|
+
if (hasViewManager(deck)) {
|
|
304
|
+
const viewport = (deck as Deck & {viewManager?: any}).viewManager?.getViewport(
|
|
305
|
+
this.props.targetViewId ?? this.viewId
|
|
306
|
+
);
|
|
307
|
+
return viewport ? [viewport] : [];
|
|
308
|
+
}
|
|
309
|
+
return [];
|
|
310
|
+
}
|
|
311
|
+
return deck.getViewports() as OrthographicViewport[];
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
private getViewportViewState(viewport: OrthographicViewport): OrthographicViewState {
|
|
315
|
+
const deck = this.deck;
|
|
316
|
+
const viewManager =
|
|
317
|
+
deck && hasViewManager(deck) ? (deck as Deck & {viewManager?: any}).viewManager : null;
|
|
318
|
+
const viewId = this.viewId || viewport.id;
|
|
319
|
+
if (viewManager) {
|
|
320
|
+
try {
|
|
321
|
+
return {...viewManager.getViewState(viewId)} as OrthographicViewState;
|
|
322
|
+
} catch (err) {
|
|
323
|
+
return cloneViewState(viewManager.viewState) as OrthographicViewState;
|
|
324
|
+
}
|
|
325
|
+
}
|
|
326
|
+
return cloneViewState(viewport) as OrthographicViewState;
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
private handleZoomDelta(delta: number) {
|
|
330
|
+
const {minZoom, maxZoom} = this.getZoomBounds();
|
|
331
|
+
|
|
332
|
+
for (const viewport of this.getTargetViewports()) {
|
|
333
|
+
const zoomY = viewport.zoomY;
|
|
334
|
+
const nextZoom = clamp(zoomY + delta, minZoom, maxZoom);
|
|
335
|
+
this.updateViewState(viewport, nextZoom);
|
|
336
|
+
}
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
private handleZoomTo(zoom: number) {
|
|
340
|
+
const {minZoom, maxZoom} = this.getZoomBounds();
|
|
341
|
+
const nextZoom = clamp(zoom, minZoom, maxZoom);
|
|
342
|
+
|
|
343
|
+
for (const viewport of this.getTargetViewports()) {
|
|
344
|
+
this.updateViewState(viewport, nextZoom);
|
|
345
|
+
}
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
private updateViewState(viewport: OrthographicViewport, nextZoomY: number) {
|
|
349
|
+
if (!this.deck) {
|
|
350
|
+
return;
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
const {contentBounds} = this.props;
|
|
354
|
+
const viewState = this.getViewportViewState(viewport);
|
|
355
|
+
const zoomX = viewport.zoomX;
|
|
356
|
+
const newViewState = {...viewState, zoom: [zoomX, nextZoomY]};
|
|
357
|
+
if (contentBounds) {
|
|
358
|
+
const targetY = viewport.target?.[1] ?? 0;
|
|
359
|
+
const minY = contentBounds[0][1];
|
|
360
|
+
const maxY = contentBounds[1][1];
|
|
361
|
+
if (targetY < minY || targetY > maxY) {
|
|
362
|
+
const nextViewport = new OrthographicViewport({...viewport, zoomY: nextZoomY});
|
|
363
|
+
const anchor = [contentBounds[0][0], Math.max(minY, Math.min(maxY, targetY))];
|
|
364
|
+
const anchorPixels = viewport.project(anchor);
|
|
365
|
+
newViewState.target = nextViewport.panByPosition(anchor, anchorPixels).target;
|
|
366
|
+
}
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
const viewId = this.viewId || viewport.id || 'default-view';
|
|
370
|
+
this.currentZoom = nextZoomY;
|
|
371
|
+
this.updateHTMLIfRenderedStateChanged();
|
|
372
|
+
|
|
373
|
+
// @ts-expect-error Using private method until a public alternative is available
|
|
374
|
+
this.deck._onViewStateChange({viewId, viewState: newViewState, interactionState: {}});
|
|
375
|
+
}
|
|
376
|
+
}
|
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
/** @jsxImportSource preact */
|
|
2
|
+
import {Widget} from '@deck.gl/core';
|
|
3
|
+
import {render} from 'preact';
|
|
4
|
+
import {useEffect, useMemo, useState} from 'preact/hooks';
|
|
5
|
+
|
|
6
|
+
import type {WidgetPlacement, WidgetProps} from '@deck.gl/core';
|
|
7
|
+
import type {JSX} from 'preact';
|
|
8
|
+
|
|
9
|
+
type HeapMemoryInfo = {
|
|
10
|
+
jsHeapSizeLimit: number;
|
|
11
|
+
totalJSHeapSize: number;
|
|
12
|
+
usedJSHeapSize: number;
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
export type HeapMemoryWidgetProps = WidgetProps & {
|
|
16
|
+
placement?: WidgetPlacement;
|
|
17
|
+
/** How frequently to poll the heap usage, in milliseconds. */
|
|
18
|
+
pollIntervalMs?: number;
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
const DEFAULT_MEMORY_INFO: HeapMemoryInfo = {
|
|
22
|
+
jsHeapSizeLimit: 0,
|
|
23
|
+
totalJSHeapSize: 0,
|
|
24
|
+
usedJSHeapSize: 0
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
function clampRatio(value: number): number {
|
|
28
|
+
if (!Number.isFinite(value) || value <= 0) {
|
|
29
|
+
return 0;
|
|
30
|
+
}
|
|
31
|
+
if (value >= 1) {
|
|
32
|
+
return 1;
|
|
33
|
+
}
|
|
34
|
+
return value;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
function formatGigabytesValue(bytes: number): string {
|
|
38
|
+
if (!Number.isFinite(bytes)) {
|
|
39
|
+
return '0.00';
|
|
40
|
+
}
|
|
41
|
+
const gigabytes = bytes / 1024 / 1024 / 1024;
|
|
42
|
+
return gigabytes.toFixed(2);
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
type HeapMemoryWidgetViewProps = {
|
|
46
|
+
pollIntervalMs: number;
|
|
47
|
+
};
|
|
48
|
+
|
|
49
|
+
function HeapMemoryWidgetView({pollIntervalMs}: HeapMemoryWidgetViewProps) {
|
|
50
|
+
const [memoryInfo, setMemoryInfo] = useState<HeapMemoryInfo>(DEFAULT_MEMORY_INFO);
|
|
51
|
+
|
|
52
|
+
useEffect(() => {
|
|
53
|
+
let isMounted = true;
|
|
54
|
+
|
|
55
|
+
const updateMemory = () => {
|
|
56
|
+
if (!isMounted || typeof window === 'undefined') {
|
|
57
|
+
return;
|
|
58
|
+
}
|
|
59
|
+
const memory = (window.performance as Performance & {memory?: HeapMemoryInfo}).memory;
|
|
60
|
+
if (!memory) {
|
|
61
|
+
return;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
setMemoryInfo({
|
|
65
|
+
jsHeapSizeLimit: memory.jsHeapSizeLimit ?? 0,
|
|
66
|
+
totalJSHeapSize: memory.totalJSHeapSize ?? 0,
|
|
67
|
+
usedJSHeapSize: memory.usedJSHeapSize ?? 0
|
|
68
|
+
});
|
|
69
|
+
};
|
|
70
|
+
|
|
71
|
+
updateMemory();
|
|
72
|
+
const interval = window.setInterval(updateMemory, Math.max(500, pollIntervalMs));
|
|
73
|
+
return () => {
|
|
74
|
+
isMounted = false;
|
|
75
|
+
window.clearInterval(interval);
|
|
76
|
+
};
|
|
77
|
+
}, [pollIntervalMs]);
|
|
78
|
+
|
|
79
|
+
const {jsHeapSizeLimit, totalJSHeapSize, usedJSHeapSize} = memoryInfo;
|
|
80
|
+
|
|
81
|
+
const {usedRatio, reservedRatio} = useMemo(() => {
|
|
82
|
+
const limit = jsHeapSizeLimit || 0;
|
|
83
|
+
if (!limit) {
|
|
84
|
+
return {usedRatio: 0, reservedRatio: 0} as const;
|
|
85
|
+
}
|
|
86
|
+
const used = clampRatio(usedJSHeapSize / limit);
|
|
87
|
+
const total = clampRatio(totalJSHeapSize / limit);
|
|
88
|
+
|
|
89
|
+
return {
|
|
90
|
+
usedRatio: used,
|
|
91
|
+
reservedRatio: Math.max(0, total - used)
|
|
92
|
+
} as const;
|
|
93
|
+
}, [jsHeapSizeLimit, totalJSHeapSize, usedJSHeapSize]);
|
|
94
|
+
|
|
95
|
+
const gradient = useMemo(() => {
|
|
96
|
+
const usedColor =
|
|
97
|
+
usedRatio < 0.5
|
|
98
|
+
? 'rgba(107, 114, 128, 0.55)'
|
|
99
|
+
: usedRatio < 0.8
|
|
100
|
+
? 'rgba(234, 179, 8, 0.6)'
|
|
101
|
+
: 'rgba(239, 68, 68, 0.7)';
|
|
102
|
+
const reservedColor = 'rgba(148, 163, 184, 0.35)';
|
|
103
|
+
const remainingColor = 'rgba(226, 232, 240, 0.35)';
|
|
104
|
+
|
|
105
|
+
const usedPercent = (usedRatio * 100).toFixed(2);
|
|
106
|
+
const reservedEnd = ((usedRatio + reservedRatio) * 100).toFixed(2);
|
|
107
|
+
|
|
108
|
+
return `linear-gradient(90deg, ${usedColor} 0%, ${usedColor} ${usedPercent}%, ${reservedColor} ${usedPercent}%, ${reservedColor} ${reservedEnd}%, ${remainingColor} ${reservedEnd}%, ${remainingColor} 100%)`;
|
|
109
|
+
}, [reservedRatio, usedRatio]);
|
|
110
|
+
|
|
111
|
+
const hasMemoryInfo = jsHeapSizeLimit > 0;
|
|
112
|
+
const valueText = hasMemoryInfo ? formatGigabytesValue(usedJSHeapSize) : 'N/A';
|
|
113
|
+
const title = hasMemoryInfo ? `Heap Size: ${valueText}GB` : 'Heap Size unavailable';
|
|
114
|
+
|
|
115
|
+
const buttonStyle: JSX.CSSProperties = {
|
|
116
|
+
position: 'relative',
|
|
117
|
+
padding: 0,
|
|
118
|
+
borderRadius: 'var(--button-corner-radius)',
|
|
119
|
+
backgroundImage: gradient,
|
|
120
|
+
backgroundColor: 'var(--button-background)',
|
|
121
|
+
color: 'var(--deck-widget-text-color, #111827)',
|
|
122
|
+
border: '1px solid var(--button-stroke)',
|
|
123
|
+
boxShadow: 'var(--button-shadow)',
|
|
124
|
+
overflow: 'hidden',
|
|
125
|
+
display: 'flex',
|
|
126
|
+
alignItems: 'center',
|
|
127
|
+
justifyContent: 'center',
|
|
128
|
+
flexDirection: 'column',
|
|
129
|
+
gap: '0px',
|
|
130
|
+
fontSize: '10px',
|
|
131
|
+
fontWeight: 700,
|
|
132
|
+
userSelect: 'none',
|
|
133
|
+
backgroundRepeat: 'no-repeat',
|
|
134
|
+
backgroundSize: '100% 100%',
|
|
135
|
+
width: '100%',
|
|
136
|
+
height: '100%'
|
|
137
|
+
};
|
|
138
|
+
|
|
139
|
+
return (
|
|
140
|
+
<div className="deck-widget-button">
|
|
141
|
+
<button
|
|
142
|
+
className="deck-widget-icon-button deck-widget-heap-memory"
|
|
143
|
+
type="button"
|
|
144
|
+
title={title}
|
|
145
|
+
aria-label="Heap size"
|
|
146
|
+
style={buttonStyle}
|
|
147
|
+
>
|
|
148
|
+
<span
|
|
149
|
+
style={{
|
|
150
|
+
lineHeight: 1.05,
|
|
151
|
+
fontSize: '10px',
|
|
152
|
+
textShadow: '0 1px 1px rgba(255, 255, 255, 0.35)'
|
|
153
|
+
}}
|
|
154
|
+
>
|
|
155
|
+
{valueText}
|
|
156
|
+
</span>
|
|
157
|
+
<span
|
|
158
|
+
style={{
|
|
159
|
+
lineHeight: 1,
|
|
160
|
+
fontSize: '9px',
|
|
161
|
+
textShadow: '0 1px 1px rgba(255, 255, 255, 0.35)'
|
|
162
|
+
}}
|
|
163
|
+
>
|
|
164
|
+
GB
|
|
165
|
+
</span>
|
|
166
|
+
</button>
|
|
167
|
+
</div>
|
|
168
|
+
);
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
export class HeapMemoryWidget extends Widget<HeapMemoryWidgetProps> {
|
|
172
|
+
static override defaultProps = {
|
|
173
|
+
...Widget.defaultProps,
|
|
174
|
+
id: 'heap-memory',
|
|
175
|
+
placement: 'top-right',
|
|
176
|
+
pollIntervalMs: 2000
|
|
177
|
+
} satisfies Required<WidgetProps> &
|
|
178
|
+
Required<Pick<HeapMemoryWidgetProps, 'placement' | 'pollIntervalMs'>> &
|
|
179
|
+
HeapMemoryWidgetProps;
|
|
180
|
+
|
|
181
|
+
placement: WidgetPlacement = HeapMemoryWidget.defaultProps.placement;
|
|
182
|
+
className = 'deck-widget-heap-memory';
|
|
183
|
+
|
|
184
|
+
#pollIntervalMs = HeapMemoryWidget.defaultProps.pollIntervalMs;
|
|
185
|
+
#rootElement: HTMLElement | null = null;
|
|
186
|
+
|
|
187
|
+
constructor(props: HeapMemoryWidgetProps = {}) {
|
|
188
|
+
super({...HeapMemoryWidget.defaultProps, ...props});
|
|
189
|
+
if (props.placement !== undefined) {
|
|
190
|
+
this.placement = props.placement;
|
|
191
|
+
}
|
|
192
|
+
if (props.pollIntervalMs !== undefined) {
|
|
193
|
+
this.#pollIntervalMs = props.pollIntervalMs;
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
override setProps(props: Partial<HeapMemoryWidgetProps>): void {
|
|
198
|
+
if (props.placement !== undefined) {
|
|
199
|
+
this.placement = props.placement;
|
|
200
|
+
}
|
|
201
|
+
if (props.pollIntervalMs !== undefined) {
|
|
202
|
+
this.#pollIntervalMs = props.pollIntervalMs;
|
|
203
|
+
}
|
|
204
|
+
super.setProps(props);
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
override onRenderHTML(rootElement: HTMLElement): void {
|
|
208
|
+
this.#rootElement = rootElement;
|
|
209
|
+
const className = ['deck-widget', this.className, this.props.className]
|
|
210
|
+
.filter(Boolean)
|
|
211
|
+
.join(' ');
|
|
212
|
+
|
|
213
|
+
rootElement.className = className;
|
|
214
|
+
|
|
215
|
+
render(<HeapMemoryWidgetView pollIntervalMs={this.#pollIntervalMs} />, rootElement);
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
override onRemove(): void {
|
|
219
|
+
if (this.#rootElement) {
|
|
220
|
+
render(null, this.#rootElement);
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
}
|