@deck.gl/react 8.8.0-alpha.6 → 8.8.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/dist/es5/deckgl.js +27 -23
- package/dist/es5/deckgl.js.map +1 -1
- package/dist/es5/index.js.map +1 -1
- package/dist/es5/utils/evaluate-children.js +19 -12
- package/dist/es5/utils/evaluate-children.js.map +1 -1
- package/dist/es5/utils/extract-jsx-layers.js +20 -17
- package/dist/es5/utils/extract-jsx-layers.js.map +1 -1
- package/dist/es5/utils/extract-styles.js.map +1 -1
- package/dist/es5/utils/inherits-from.js.map +1 -1
- package/dist/es5/utils/position-children-under-views.js +8 -2
- package/dist/es5/utils/position-children-under-views.js.map +1 -1
- package/dist/es5/utils/use-isomorphic-layout-effect.js.map +1 -1
- package/dist/esm/deckgl.js +25 -16
- package/dist/esm/deckgl.js.map +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/utils/evaluate-children.js +13 -12
- package/dist/esm/utils/evaluate-children.js.map +1 -1
- package/dist/esm/utils/extract-jsx-layers.js +16 -14
- package/dist/esm/utils/extract-jsx-layers.js.map +1 -1
- package/dist/esm/utils/extract-styles.js.map +1 -1
- package/dist/esm/utils/inherits-from.js.map +1 -1
- package/dist/esm/utils/position-children-under-views.js +2 -2
- package/dist/esm/utils/position-children-under-views.js.map +1 -1
- package/dist/esm/utils/use-isomorphic-layout-effect.js.map +1 -1
- package/package.json +3 -2
- package/src/{deckgl.js → deckgl.ts} +61 -26
- package/src/index.ts +26 -0
- package/src/utils/evaluate-children.ts +47 -0
- package/src/utils/{extract-jsx-layers.js → extract-jsx-layers.ts} +36 -17
- package/src/utils/{extract-styles.js → extract-styles.ts} +16 -3
- package/src/utils/{inherits-from.js → inherits-from.ts} +1 -1
- package/src/utils/{position-children-under-views.js → position-children-under-views.ts} +36 -7
- package/src/utils/{use-isomorphic-layout-effect.js → use-isomorphic-layout-effect.ts} +0 -0
- package/typed/deckgl.d.ts +23 -1
- package/typed/deckgl.d.ts.map +1 -1
- package/typed/deckgl.js +194 -0
- package/typed/index.d.ts +4 -1
- package/typed/index.d.ts.map +1 -1
- package/{src → typed}/index.js +2 -3
- package/typed/utils/evaluate-children.d.ts +3 -1
- package/typed/utils/evaluate-children.d.ts.map +1 -1
- package/typed/utils/evaluate-children.js +33 -0
- package/typed/utils/extract-jsx-layers.d.ts +9 -6
- package/typed/utils/extract-jsx-layers.d.ts.map +1 -1
- package/typed/utils/extract-jsx-layers.js +77 -0
- package/typed/utils/extract-styles.d.ts +6 -15
- package/typed/utils/extract-styles.d.ts.map +1 -1
- package/typed/utils/extract-styles.js +32 -0
- package/typed/utils/inherits-from.d.ts +1 -1
- package/typed/utils/inherits-from.d.ts.map +1 -1
- package/typed/utils/inherits-from.js +10 -0
- package/typed/utils/position-children-under-views.d.ts +13 -4
- package/typed/utils/position-children-under-views.d.ts.map +1 -1
- package/typed/utils/position-children-under-views.js +75 -0
- package/typed/utils/use-isomorphic-layout-effect.d.ts +2 -1
- package/typed/utils/use-isomorphic-layout-effect.d.ts.map +1 -1
- package/typed/utils/use-isomorphic-layout-effect.js +5 -0
- package/src/utils/evaluate-children.js +0 -38
|
@@ -1,38 +1,53 @@
|
|
|
1
|
-
import React
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
import {createElement} from 'react';
|
|
2
3
|
import {inheritsFrom} from './inherits-from';
|
|
3
4
|
import {Layer, View} from '@deck.gl/core';
|
|
5
|
+
import {isComponent} from './evaluate-children';
|
|
6
|
+
import type {LayersList} from '@deck.gl/core';
|
|
4
7
|
|
|
5
8
|
// recursively wrap render callbacks in `View`
|
|
6
|
-
function wrapInView(node) {
|
|
7
|
-
if (!node) {
|
|
8
|
-
return node;
|
|
9
|
-
}
|
|
9
|
+
function wrapInView(node: React.ReactNode): React.ReactNode {
|
|
10
10
|
if (typeof node === 'function') {
|
|
11
11
|
// React.Children does not traverse functions.
|
|
12
12
|
// All render callbacks must be protected under a <View>
|
|
13
|
+
// @ts-expect-error View is not a ReactJSXElement constructor. Only used as a temporary wrapper and will be removed in extractJSXLayers
|
|
13
14
|
return createElement(View, {}, node);
|
|
14
15
|
}
|
|
15
16
|
if (Array.isArray(node)) {
|
|
16
17
|
return node.map(wrapInView);
|
|
17
18
|
}
|
|
18
|
-
if (node
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
19
|
+
if (isComponent(node)) {
|
|
20
|
+
if (node.type === React.Fragment) {
|
|
21
|
+
return wrapInView(node.props.children);
|
|
22
|
+
}
|
|
23
|
+
if (inheritsFrom(node.type, View)) {
|
|
24
|
+
return node;
|
|
25
|
+
}
|
|
23
26
|
}
|
|
24
27
|
return node;
|
|
25
28
|
}
|
|
26
29
|
|
|
27
30
|
// extracts any deck.gl layers masquerading as react elements from props.children
|
|
28
|
-
export default function extractJSXLayers({
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
31
|
+
export default function extractJSXLayers({
|
|
32
|
+
children,
|
|
33
|
+
layers = [],
|
|
34
|
+
views = null
|
|
35
|
+
}: {
|
|
36
|
+
children?: React.ReactNode;
|
|
37
|
+
layers?: LayersList;
|
|
38
|
+
views?: View | View[] | null;
|
|
39
|
+
}): {
|
|
40
|
+
children: React.ReactNode[];
|
|
41
|
+
layers: LayersList;
|
|
42
|
+
views: View | View[] | null;
|
|
43
|
+
} {
|
|
44
|
+
const reactChildren: React.ReactNode[] = []; // extract real react elements (i.e. not deck.gl layers)
|
|
45
|
+
const jsxLayers: LayersList = []; // extracted layer from react children, will add to deck.gl layer array
|
|
46
|
+
const jsxViews: Record<string, View> = {};
|
|
32
47
|
|
|
33
48
|
// React.children
|
|
34
49
|
React.Children.forEach(wrapInView(children), reactElement => {
|
|
35
|
-
if (reactElement) {
|
|
50
|
+
if (isComponent(reactElement)) {
|
|
36
51
|
// For some reason Children.forEach doesn't filter out `null`s
|
|
37
52
|
const ElementType = reactElement.type;
|
|
38
53
|
if (inheritsFrom(ElementType, Layer)) {
|
|
@@ -43,10 +58,13 @@ export default function extractJSXLayers({children, layers, views}) {
|
|
|
43
58
|
}
|
|
44
59
|
|
|
45
60
|
// empty id => default view
|
|
46
|
-
if (ElementType
|
|
61
|
+
if (inheritsFrom(ElementType, View) && ElementType !== View && reactElement.props.id) {
|
|
62
|
+
// @ts-ignore Cannot instantiate an abstract class (View)
|
|
47
63
|
const view = new ElementType(reactElement.props);
|
|
48
64
|
jsxViews[view.id] = view;
|
|
49
65
|
}
|
|
66
|
+
} else if (reactElement) {
|
|
67
|
+
reactChildren.push(reactElement);
|
|
50
68
|
}
|
|
51
69
|
});
|
|
52
70
|
|
|
@@ -69,7 +87,7 @@ export default function extractJSXLayers({children, layers, views}) {
|
|
|
69
87
|
return {layers, children: reactChildren, views};
|
|
70
88
|
}
|
|
71
89
|
|
|
72
|
-
function createLayer(LayerType, reactProps) {
|
|
90
|
+
function createLayer(LayerType: typeof Layer, reactProps: any): Layer {
|
|
73
91
|
const props = {};
|
|
74
92
|
// Layer.defaultProps is treated as ReactElement.defaultProps and merged into react props
|
|
75
93
|
// Remove them
|
|
@@ -79,5 +97,6 @@ function createLayer(LayerType, reactProps) {
|
|
|
79
97
|
props[key] = reactProps[key];
|
|
80
98
|
}
|
|
81
99
|
}
|
|
100
|
+
// @ts-ignore Cannot instantiate an abstract class (Layer)
|
|
82
101
|
return new LayerType(props);
|
|
83
102
|
}
|
|
@@ -1,10 +1,23 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
|
|
1
3
|
const CANVAS_ONLY_STYLES = {
|
|
2
4
|
mixBlendMode: null
|
|
3
5
|
};
|
|
4
6
|
|
|
5
|
-
export default function extractStyles({
|
|
7
|
+
export default function extractStyles({
|
|
8
|
+
width,
|
|
9
|
+
height,
|
|
10
|
+
style
|
|
11
|
+
}: {
|
|
12
|
+
width?: string | number;
|
|
13
|
+
height?: string | number;
|
|
14
|
+
style?: Partial<CSSStyleDeclaration> | null;
|
|
15
|
+
}): {
|
|
16
|
+
containerStyle: React.CSSProperties;
|
|
17
|
+
canvasStyle: React.CSSProperties;
|
|
18
|
+
} {
|
|
6
19
|
// This styling is enforced for correct positioning with children
|
|
7
|
-
const containerStyle = {
|
|
20
|
+
const containerStyle: React.CSSProperties = {
|
|
8
21
|
position: 'absolute',
|
|
9
22
|
zIndex: 0,
|
|
10
23
|
left: 0,
|
|
@@ -14,7 +27,7 @@ export default function extractStyles({width, height, style}) {
|
|
|
14
27
|
};
|
|
15
28
|
|
|
16
29
|
// Fill the container
|
|
17
|
-
const canvasStyle = {
|
|
30
|
+
const canvasStyle: React.CSSProperties = {
|
|
18
31
|
left: 0,
|
|
19
32
|
top: 0
|
|
20
33
|
};
|
|
@@ -1,19 +1,45 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
1
2
|
import {createElement} from 'react';
|
|
2
3
|
import {View} from '@deck.gl/core';
|
|
3
4
|
import {inheritsFrom} from './inherits-from';
|
|
4
|
-
import evaluateChildren from './evaluate-children';
|
|
5
|
+
import evaluateChildren, {isComponent} from './evaluate-children';
|
|
6
|
+
|
|
7
|
+
import type {Deck, DeckProps, Viewport} from '@deck.gl/core';
|
|
8
|
+
import type {EventManager} from 'mjolnir.js';
|
|
9
|
+
|
|
10
|
+
export type DeckGLContextValue = {
|
|
11
|
+
viewport: Viewport;
|
|
12
|
+
container: HTMLElement;
|
|
13
|
+
eventManager: EventManager;
|
|
14
|
+
onViewStateChange: DeckProps['onViewStateChange'];
|
|
15
|
+
};
|
|
5
16
|
|
|
6
17
|
// Iterate over views and reposition children associated with views
|
|
7
18
|
// TODO - Can we supply a similar function for the non-React case?
|
|
8
|
-
export default function positionChildrenUnderViews({
|
|
19
|
+
export default function positionChildrenUnderViews({
|
|
20
|
+
children,
|
|
21
|
+
deck,
|
|
22
|
+
ContextProvider
|
|
23
|
+
}: {
|
|
24
|
+
children: React.ReactNode[];
|
|
25
|
+
deck?: Deck;
|
|
26
|
+
ContextProvider?: React.Context<DeckGLContextValue>['Provider'];
|
|
27
|
+
}): React.ReactNode[] {
|
|
28
|
+
// @ts-expect-error accessing protected property
|
|
9
29
|
const {viewManager} = deck || {};
|
|
10
30
|
|
|
11
31
|
if (!viewManager || !viewManager.views.length) {
|
|
12
32
|
return [];
|
|
13
33
|
}
|
|
14
34
|
|
|
15
|
-
const views
|
|
16
|
-
|
|
35
|
+
const views: Record<
|
|
36
|
+
string,
|
|
37
|
+
{
|
|
38
|
+
viewport: Viewport;
|
|
39
|
+
children: React.ReactNode[];
|
|
40
|
+
}
|
|
41
|
+
> = {};
|
|
42
|
+
const defaultViewId = (viewManager.views[0] as View).id;
|
|
17
43
|
|
|
18
44
|
// Sort children by view id
|
|
19
45
|
for (const child of children) {
|
|
@@ -21,12 +47,12 @@ export default function positionChildrenUnderViews({children, deck, ContextProvi
|
|
|
21
47
|
let viewId = defaultViewId;
|
|
22
48
|
let viewChildren = child;
|
|
23
49
|
|
|
24
|
-
if (inheritsFrom(child.type, View)) {
|
|
50
|
+
if (isComponent(child) && inheritsFrom(child.type, View)) {
|
|
25
51
|
viewId = child.props.id || defaultViewId;
|
|
26
52
|
viewChildren = child.props.children;
|
|
27
53
|
}
|
|
28
54
|
|
|
29
|
-
const viewport = viewManager.getViewport(viewId);
|
|
55
|
+
const viewport = viewManager.getViewport(viewId) as Viewport;
|
|
30
56
|
const viewState = viewManager.getViewState(viewId);
|
|
31
57
|
|
|
32
58
|
// Drop (auto-hide) elements with viewId that are not matched by any current view
|
|
@@ -70,12 +96,15 @@ export default function positionChildrenUnderViews({children, deck, ContextProvi
|
|
|
70
96
|
const viewElement = createElement('div', {key, id: key, style}, ...viewChildren);
|
|
71
97
|
|
|
72
98
|
if (ContextProvider) {
|
|
73
|
-
const contextValue = {
|
|
99
|
+
const contextValue: DeckGLContextValue = {
|
|
74
100
|
viewport,
|
|
101
|
+
// @ts-expect-error accessing protected property
|
|
75
102
|
container: deck.canvas.offsetParent,
|
|
103
|
+
// @ts-expect-error accessing protected property
|
|
76
104
|
eventManager: deck.eventManager,
|
|
77
105
|
onViewStateChange: params => {
|
|
78
106
|
params.viewId = viewId;
|
|
107
|
+
// @ts-expect-error accessing protected method
|
|
79
108
|
deck._onViewStateChange(params);
|
|
80
109
|
}
|
|
81
110
|
};
|
|
File without changes
|
package/typed/deckgl.d.ts
CHANGED
|
@@ -1,3 +1,25 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
import { Deck } from '@deck.gl/core/typed';
|
|
3
|
+
import type { DeckGLContextValue } from './utils/position-children-under-views';
|
|
4
|
+
import type { DeckProps } from '@deck.gl/core/typed';
|
|
5
|
+
/** DeckGL React component props */
|
|
6
|
+
export declare type DeckGLProps = Omit<DeckProps, 'width' | 'height' | 'gl' | 'parent' | 'canvas' | '_customRender'> & {
|
|
7
|
+
width?: string | number;
|
|
8
|
+
height?: string | number;
|
|
9
|
+
children?: React.ReactNode;
|
|
10
|
+
ContextProvider?: React.Context<DeckGLContextValue>['Provider'];
|
|
11
|
+
};
|
|
12
|
+
export declare type DeckGLRef = {
|
|
13
|
+
deck?: Deck;
|
|
14
|
+
pickObject: Deck['pickObject'];
|
|
15
|
+
pickObjects: Deck['pickObjects'];
|
|
16
|
+
pickMultipleObjects: Deck['pickMultipleObjects'];
|
|
17
|
+
};
|
|
18
|
+
declare const DeckGL: React.ForwardRefExoticComponent<Omit<DeckProps, "width" | "height" | "gl" | "parent" | "canvas" | "_customRender"> & {
|
|
19
|
+
width?: string | number | undefined;
|
|
20
|
+
height?: string | number | undefined;
|
|
21
|
+
children?: React.ReactNode;
|
|
22
|
+
ContextProvider?: React.Provider<DeckGLContextValue> | undefined;
|
|
23
|
+
} & React.RefAttributes<DeckGLRef>>;
|
|
1
24
|
export default DeckGL;
|
|
2
|
-
declare const DeckGL: any;
|
|
3
25
|
//# sourceMappingURL=deckgl.d.ts.map
|
package/typed/deckgl.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deckgl.d.ts","sourceRoot":"","sources":["../src/deckgl.
|
|
1
|
+
{"version":3,"file":"deckgl.d.ts","sourceRoot":"","sources":["../src/deckgl.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAU/B,OAAO,EAAC,IAAI,EAAC,MAAM,eAAe,CAAC;AAOnC,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,uCAAuC,CAAC;AAC9E,OAAO,KAAK,EAAC,SAAS,EAAW,MAAM,eAAe,CAAC;AAevD,mCAAmC;AACnC,oBAAY,WAAW,GAAG,IAAI,CAC5B,SAAS,EACT,OAAO,GAAG,QAAQ,GAAG,IAAI,GAAG,QAAQ,GAAG,QAAQ,GAAG,eAAe,CAClE,GAAG;IACF,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,eAAe,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC;CACjE,CAAC;AAEF,oBAAY,SAAS,GAAG;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC/B,WAAW,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IACjC,mBAAmB,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;CAClD,CAAC;AAuDF,QAAA,MAAM,MAAM;;;eAhEC,MAAM,SAAS;;mCAqN1B,CAAC;AAIH,eAAe,MAAM,CAAC"}
|
package/typed/deckgl.js
ADDED
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
// Copyright (c) 2015 - 2017 Uber Technologies, Inc.
|
|
2
|
+
//
|
|
3
|
+
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
4
|
+
// of this software and associated documentation files (the "Software"), to deal
|
|
5
|
+
// in the Software without restriction, including without limitation the rights
|
|
6
|
+
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
7
|
+
// copies of the Software, and to permit persons to whom the Software is
|
|
8
|
+
// furnished to do so, subject to the following conditions:
|
|
9
|
+
//
|
|
10
|
+
// The above copyright notice and this permission notice shall be included in
|
|
11
|
+
// all copies or substantial portions of the Software.
|
|
12
|
+
//
|
|
13
|
+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
14
|
+
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
15
|
+
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
16
|
+
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
17
|
+
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
18
|
+
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
19
|
+
// THE SOFTWARE.
|
|
20
|
+
import { createElement, useRef, useState, useMemo, useEffect, useImperativeHandle, forwardRef } from 'react';
|
|
21
|
+
import { Deck } from '@deck.gl/core';
|
|
22
|
+
import useIsomorphicLayoutEffect from './utils/use-isomorphic-layout-effect';
|
|
23
|
+
import extractJSXLayers from './utils/extract-jsx-layers';
|
|
24
|
+
import positionChildrenUnderViews from './utils/position-children-under-views';
|
|
25
|
+
import extractStyles from './utils/extract-styles';
|
|
26
|
+
/* eslint-disable max-statements, accessor-pairs */
|
|
27
|
+
function getRefHandles(thisRef) {
|
|
28
|
+
const handles = {
|
|
29
|
+
pickObject: opts => thisRef.deck.pickObject(opts),
|
|
30
|
+
pickMultipleObjects: opts => thisRef.deck.pickMultipleObjects(opts),
|
|
31
|
+
pickObjects: opts => thisRef.deck.pickObjects(opts)
|
|
32
|
+
};
|
|
33
|
+
Object.defineProperty(handles, 'deck', {
|
|
34
|
+
get: () => thisRef.deck
|
|
35
|
+
});
|
|
36
|
+
return handles;
|
|
37
|
+
}
|
|
38
|
+
function redrawDeck(thisRef) {
|
|
39
|
+
if (thisRef.redrawReason) {
|
|
40
|
+
// Only redraw if we have received a dirty flag
|
|
41
|
+
thisRef.deck._drawLayers(thisRef.redrawReason);
|
|
42
|
+
thisRef.redrawReason = null;
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
function createDeckInstance(thisRef, props) {
|
|
46
|
+
// Allows a subclass of Deck to be used
|
|
47
|
+
// TODO - update propTypes / defaultProps?
|
|
48
|
+
const DeckClass = props.Deck || Deck;
|
|
49
|
+
const deck = new DeckClass({
|
|
50
|
+
...props,
|
|
51
|
+
style: null,
|
|
52
|
+
width: '100%',
|
|
53
|
+
height: '100%',
|
|
54
|
+
// The Deck's animation loop is independent from React's render cycle, causing potential
|
|
55
|
+
// synchronization issues. We provide this custom render function to make sure that React
|
|
56
|
+
// and Deck update on the same schedule.
|
|
57
|
+
_customRender: redrawReason => {
|
|
58
|
+
// Save the dirty flag for later
|
|
59
|
+
thisRef.redrawReason = redrawReason;
|
|
60
|
+
// Viewport/view state is passed to child components as props.
|
|
61
|
+
// If they have changed, we need to trigger a React rerender to update children props.
|
|
62
|
+
const viewports = deck.viewManager.getViewports();
|
|
63
|
+
if (thisRef.lastRenderedViewports !== viewports) {
|
|
64
|
+
// Viewports have changed, update children props first.
|
|
65
|
+
// This will delay the Deck canvas redraw till after React update (in useLayoutEffect)
|
|
66
|
+
// so that the canvas does not get rendered before the child components update.
|
|
67
|
+
thisRef.forceUpdate(v => v + 1);
|
|
68
|
+
}
|
|
69
|
+
else {
|
|
70
|
+
redrawDeck(thisRef);
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
});
|
|
74
|
+
return deck;
|
|
75
|
+
}
|
|
76
|
+
const DeckGL = forwardRef((props, ref) => {
|
|
77
|
+
// A reference to persistent states
|
|
78
|
+
const _thisRef = useRef({});
|
|
79
|
+
const thisRef = _thisRef.current;
|
|
80
|
+
// A mechanism to force redraw
|
|
81
|
+
const [version, setVersion] = useState(0);
|
|
82
|
+
thisRef.forceUpdate = setVersion;
|
|
83
|
+
// DOM refs
|
|
84
|
+
const containerRef = useRef(null);
|
|
85
|
+
const canvasRef = useRef(null);
|
|
86
|
+
// extract any deck.gl layers masquerading as react elements from props.children
|
|
87
|
+
const jsxProps = useMemo(() => extractJSXLayers(props), [props.layers, props.views, props.children]);
|
|
88
|
+
// Callbacks
|
|
89
|
+
let inRender = true;
|
|
90
|
+
const handleViewStateChange = params => {
|
|
91
|
+
if (inRender && props.viewState) {
|
|
92
|
+
// Callback may invoke a state update. Defer callback to after render() to avoid React error
|
|
93
|
+
// In React StrictMode, render is executed twice and useEffect/useLayoutEffect is executed once
|
|
94
|
+
// Store deferred parameters in ref so that we can access it in another render
|
|
95
|
+
thisRef.viewStateUpdateRequested = params;
|
|
96
|
+
return null;
|
|
97
|
+
}
|
|
98
|
+
thisRef.viewStateUpdateRequested = null;
|
|
99
|
+
return props.onViewStateChange(params);
|
|
100
|
+
};
|
|
101
|
+
const handleInteractionStateChange = params => {
|
|
102
|
+
if (inRender) {
|
|
103
|
+
// Callback may invoke a state update. Defer callback to after render() to avoid React error
|
|
104
|
+
// In React StrictMode, render is executed twice and useEffect/useLayoutEffect is executed once
|
|
105
|
+
// Store deferred parameters in ref so that we can access it in another render
|
|
106
|
+
thisRef.interactionStateUpdateRequested = params;
|
|
107
|
+
}
|
|
108
|
+
else {
|
|
109
|
+
thisRef.interactionStateUpdateRequested = null;
|
|
110
|
+
props.onInteractionStateChange(params);
|
|
111
|
+
}
|
|
112
|
+
};
|
|
113
|
+
// Update Deck's props. If Deck needs redraw, this will trigger a call to `_customRender` in
|
|
114
|
+
// the next animation frame.
|
|
115
|
+
// Needs to be called both from initial mount, and when new props are received
|
|
116
|
+
const deckProps = useMemo(() => {
|
|
117
|
+
const forwardProps = {
|
|
118
|
+
...props,
|
|
119
|
+
// Override user styling props. We will set the canvas style in render()
|
|
120
|
+
style: null,
|
|
121
|
+
width: '100%',
|
|
122
|
+
height: '100%',
|
|
123
|
+
layers: jsxProps.layers,
|
|
124
|
+
views: jsxProps.views,
|
|
125
|
+
onViewStateChange: handleViewStateChange,
|
|
126
|
+
onInteractionStateChange: handleInteractionStateChange
|
|
127
|
+
};
|
|
128
|
+
// The defaultValue for _customRender is null, which would overwrite the definition
|
|
129
|
+
// of _customRender. Remove to avoid frequently redeclaring the method here.
|
|
130
|
+
delete forwardProps._customRender;
|
|
131
|
+
if (thisRef.deck) {
|
|
132
|
+
thisRef.deck.setProps(forwardProps);
|
|
133
|
+
}
|
|
134
|
+
return forwardProps;
|
|
135
|
+
}, [props]);
|
|
136
|
+
useEffect(() => {
|
|
137
|
+
thisRef.deck = createDeckInstance(thisRef, {
|
|
138
|
+
...deckProps,
|
|
139
|
+
parent: containerRef.current,
|
|
140
|
+
canvas: canvasRef.current
|
|
141
|
+
});
|
|
142
|
+
return () => thisRef.deck.finalize();
|
|
143
|
+
}, []);
|
|
144
|
+
useIsomorphicLayoutEffect(() => {
|
|
145
|
+
// render has just been called. The children are positioned based on the current view state.
|
|
146
|
+
// Redraw Deck canvas immediately, if necessary, using the current view state, so that it
|
|
147
|
+
// matches the child components.
|
|
148
|
+
redrawDeck(thisRef);
|
|
149
|
+
// Execute deferred callbacks
|
|
150
|
+
const { viewStateUpdateRequested, interactionStateUpdateRequested } = thisRef;
|
|
151
|
+
if (viewStateUpdateRequested) {
|
|
152
|
+
handleViewStateChange(viewStateUpdateRequested);
|
|
153
|
+
}
|
|
154
|
+
if (interactionStateUpdateRequested) {
|
|
155
|
+
handleInteractionStateChange(interactionStateUpdateRequested);
|
|
156
|
+
}
|
|
157
|
+
});
|
|
158
|
+
useImperativeHandle(ref, () => getRefHandles(thisRef), []);
|
|
159
|
+
const { viewManager } = thisRef.deck || {};
|
|
160
|
+
const currentViewports = viewManager && viewManager.getViewports();
|
|
161
|
+
const { ContextProvider, width, height, id, style } = props;
|
|
162
|
+
const { containerStyle, canvasStyle } = useMemo(() => extractStyles({ width, height, style }), [width, height, style]);
|
|
163
|
+
// Props changes may lead to 3 types of updates:
|
|
164
|
+
// 1. Only the WebGL canvas - updated in Deck's render cycle (next animation frame)
|
|
165
|
+
// 2. Only the DOM - updated in React's lifecycle (now)
|
|
166
|
+
// 3. Both the WebGL canvas and the DOM - defer React rerender to next animation frame just
|
|
167
|
+
// before Deck redraw to ensure perfect synchronization & avoid excessive redraw
|
|
168
|
+
// This is because multiple changes may happen to Deck between two frames e.g. transition
|
|
169
|
+
if ((!thisRef.viewStateUpdateRequested && thisRef.lastRenderedViewports === currentViewports) || // case 2
|
|
170
|
+
thisRef.version !== version // case 3 just before deck redraws
|
|
171
|
+
) {
|
|
172
|
+
thisRef.lastRenderedViewports = currentViewports;
|
|
173
|
+
thisRef.version = version;
|
|
174
|
+
// Render the background elements (typically react-map-gl instances)
|
|
175
|
+
// using the view descriptors
|
|
176
|
+
const childrenUnderViews = positionChildrenUnderViews({
|
|
177
|
+
children: jsxProps.children,
|
|
178
|
+
deck: thisRef.deck,
|
|
179
|
+
ContextProvider
|
|
180
|
+
});
|
|
181
|
+
const canvas = createElement('canvas', {
|
|
182
|
+
key: 'canvas',
|
|
183
|
+
id: id || 'deckgl-overlay',
|
|
184
|
+
ref: canvasRef,
|
|
185
|
+
style: canvasStyle
|
|
186
|
+
});
|
|
187
|
+
// Render deck.gl as the last child
|
|
188
|
+
thisRef.control = createElement('div', { id: `${id || 'deckgl'}-wrapper`, ref: containerRef, style: containerStyle }, [canvas, childrenUnderViews]);
|
|
189
|
+
}
|
|
190
|
+
inRender = false;
|
|
191
|
+
return thisRef.control;
|
|
192
|
+
});
|
|
193
|
+
DeckGL.defaultProps = Deck.defaultProps;
|
|
194
|
+
export default DeckGL;
|
package/typed/index.d.ts
CHANGED
|
@@ -1,2 +1,5 @@
|
|
|
1
|
-
export { default as DeckGL
|
|
1
|
+
export { default as DeckGL } from './deckgl';
|
|
2
|
+
export { default } from './deckgl';
|
|
3
|
+
export type { DeckGLContextValue } from './utils/position-children-under-views';
|
|
4
|
+
export type { DeckGLRef, DeckGLProps } from './deckgl';
|
|
2
5
|
//# sourceMappingURL=index.d.ts.map
|
package/typed/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAC,OAAO,IAAI,MAAM,EAAC,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAC,OAAO,EAAC,MAAM,UAAU,CAAC;AAGjC,YAAY,EAAC,kBAAkB,EAAC,MAAM,uCAAuC,CAAC;AAC9E,YAAY,EAAC,SAAS,EAAE,WAAW,EAAC,MAAM,UAAU,CAAC"}
|
package/{src → typed}/index.js
RENAMED
|
@@ -17,6 +17,5 @@
|
|
|
17
17
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
18
18
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
19
19
|
// THE SOFTWARE.
|
|
20
|
-
|
|
21
|
-
export {default
|
|
22
|
-
export {default} from './deckgl';
|
|
20
|
+
export { default as DeckGL } from './deckgl';
|
|
21
|
+
export { default } from './deckgl';
|
|
@@ -1,2 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
export default function evaluateChildren(children: React.ReactNode, childProps: any): React.ReactNode;
|
|
3
|
+
export declare function isComponent(child: React.ReactNode): child is React.ReactElement;
|
|
2
4
|
//# sourceMappingURL=evaluate-children.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"evaluate-children.d.ts","sourceRoot":"","sources":["../../src/utils/evaluate-children.
|
|
1
|
+
{"version":3,"file":"evaluate-children.d.ts","sourceRoot":"","sources":["../../src/utils/evaluate-children.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACtC,QAAQ,EAAE,KAAK,CAAC,SAAS,EACzB,UAAU,EAAE,GAAG,GACd,KAAK,CAAC,SAAS,CAqBjB;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,SAAS,GAAG,KAAK,IAAI,KAAK,CAAC,YAAY,CAE/E"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { cloneElement } from 'react';
|
|
2
|
+
const MAP_STYLE = { position: 'absolute', zIndex: -1 };
|
|
3
|
+
export default function evaluateChildren(children, childProps) {
|
|
4
|
+
if (!children) {
|
|
5
|
+
return children;
|
|
6
|
+
}
|
|
7
|
+
if (typeof children === 'function') {
|
|
8
|
+
return children(childProps);
|
|
9
|
+
}
|
|
10
|
+
if (Array.isArray(children)) {
|
|
11
|
+
return children.map(child => evaluateChildren(child, childProps));
|
|
12
|
+
}
|
|
13
|
+
// Special treatment for react-map-gl's Map component
|
|
14
|
+
// to support shorthand use case <DeckGL><StaticMap /></DeckGL>
|
|
15
|
+
if (isReactMap(children)) {
|
|
16
|
+
// Place map under the canvas
|
|
17
|
+
childProps.style = MAP_STYLE;
|
|
18
|
+
return cloneElement(children, childProps);
|
|
19
|
+
}
|
|
20
|
+
if (needsDeckGLViewProps(children)) {
|
|
21
|
+
return cloneElement(children, childProps);
|
|
22
|
+
}
|
|
23
|
+
return children;
|
|
24
|
+
}
|
|
25
|
+
function isReactMap(child) {
|
|
26
|
+
const componentClass = child && child.type;
|
|
27
|
+
const componentProps = componentClass && componentClass.defaultProps;
|
|
28
|
+
return componentProps && componentProps.mapStyle;
|
|
29
|
+
}
|
|
30
|
+
function needsDeckGLViewProps(child) {
|
|
31
|
+
const componentClass = child && child.type;
|
|
32
|
+
return componentClass && componentClass.deckGLViewProps;
|
|
33
|
+
}
|
|
@@ -1,10 +1,13 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
import { View } from '@deck.gl/core/typed';
|
|
3
|
+
import type { LayersList } from '@deck.gl/core/typed';
|
|
1
4
|
export default function extractJSXLayers({ children, layers, views }: {
|
|
2
|
-
children
|
|
3
|
-
layers
|
|
4
|
-
views
|
|
5
|
+
children?: React.ReactNode;
|
|
6
|
+
layers?: LayersList;
|
|
7
|
+
views?: View | View[] | null;
|
|
5
8
|
}): {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
views:
|
|
9
|
+
children: React.ReactNode[];
|
|
10
|
+
layers: LayersList;
|
|
11
|
+
views: View | View[] | null;
|
|
9
12
|
};
|
|
10
13
|
//# sourceMappingURL=extract-jsx-layers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"extract-jsx-layers.d.ts","sourceRoot":"","sources":["../../src/utils/extract-jsx-layers.
|
|
1
|
+
{"version":3,"file":"extract-jsx-layers.d.ts","sourceRoot":"","sources":["../../src/utils/extract-jsx-layers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAQ,IAAI,EAAC,MAAM,eAAe,CAAC;AAE1C,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAyB9C,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,EACvC,QAAQ,EACR,MAAW,EACX,KAAY,EACb,EAAE;IACD,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,KAAK,CAAC,EAAE,IAAI,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;CAC9B,GAAG;IACF,QAAQ,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC;IAC5B,MAAM,EAAE,UAAU,CAAC;IACnB,KAAK,EAAE,IAAI,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;CAC7B,CA6CA"}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import React, { createElement } from 'react';
|
|
2
|
+
import { inheritsFrom } from './inherits-from';
|
|
3
|
+
import { Layer, View } from '@deck.gl/core';
|
|
4
|
+
// recursively wrap render callbacks in `View`
|
|
5
|
+
function wrapInView(node) {
|
|
6
|
+
if (!node) {
|
|
7
|
+
return node;
|
|
8
|
+
}
|
|
9
|
+
if (typeof node === 'function') {
|
|
10
|
+
// React.Children does not traverse functions.
|
|
11
|
+
// All render callbacks must be protected under a <View>
|
|
12
|
+
return createElement(View, {}, node);
|
|
13
|
+
}
|
|
14
|
+
if (Array.isArray(node)) {
|
|
15
|
+
return node.map(wrapInView);
|
|
16
|
+
}
|
|
17
|
+
if (node.type === React.Fragment) {
|
|
18
|
+
return wrapInView(node.props.children);
|
|
19
|
+
}
|
|
20
|
+
if (inheritsFrom(node.type, View)) {
|
|
21
|
+
return node;
|
|
22
|
+
}
|
|
23
|
+
return node;
|
|
24
|
+
}
|
|
25
|
+
// extracts any deck.gl layers masquerading as react elements from props.children
|
|
26
|
+
export default function extractJSXLayers({ children, layers, views }) {
|
|
27
|
+
const reactChildren = []; // extract real react elements (i.e. not deck.gl layers)
|
|
28
|
+
const jsxLayers = []; // extracted layer from react children, will add to deck.gl layer array
|
|
29
|
+
const jsxViews = {};
|
|
30
|
+
// React.children
|
|
31
|
+
React.Children.forEach(wrapInView(children), reactElement => {
|
|
32
|
+
if (reactElement) {
|
|
33
|
+
// For some reason Children.forEach doesn't filter out `null`s
|
|
34
|
+
const ElementType = reactElement.type;
|
|
35
|
+
if (inheritsFrom(ElementType, Layer)) {
|
|
36
|
+
const layer = createLayer(ElementType, reactElement.props);
|
|
37
|
+
jsxLayers.push(layer);
|
|
38
|
+
}
|
|
39
|
+
else {
|
|
40
|
+
reactChildren.push(reactElement);
|
|
41
|
+
}
|
|
42
|
+
// empty id => default view
|
|
43
|
+
if (ElementType !== View && inheritsFrom(ElementType, View) && reactElement.props.id) {
|
|
44
|
+
const view = new ElementType(reactElement.props);
|
|
45
|
+
jsxViews[view.id] = view;
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
});
|
|
49
|
+
// Avoid modifying views if no JSX views were found
|
|
50
|
+
if (Object.keys(jsxViews).length > 0) {
|
|
51
|
+
// If a view is specified in both views prop and JSX, use the one in views
|
|
52
|
+
if (Array.isArray(views)) {
|
|
53
|
+
views.forEach(view => {
|
|
54
|
+
jsxViews[view.id] = view;
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
else if (views) {
|
|
58
|
+
jsxViews[views.id] = views;
|
|
59
|
+
}
|
|
60
|
+
views = Object.values(jsxViews);
|
|
61
|
+
}
|
|
62
|
+
// Avoid modifying layers array if no JSX layers were found
|
|
63
|
+
layers = jsxLayers.length > 0 ? [...jsxLayers, ...layers] : layers;
|
|
64
|
+
return { layers, children: reactChildren, views };
|
|
65
|
+
}
|
|
66
|
+
function createLayer(LayerType, reactProps) {
|
|
67
|
+
const props = {};
|
|
68
|
+
// Layer.defaultProps is treated as ReactElement.defaultProps and merged into react props
|
|
69
|
+
// Remove them
|
|
70
|
+
const defaultProps = LayerType.defaultProps || {};
|
|
71
|
+
for (const key in reactProps) {
|
|
72
|
+
if (defaultProps[key] !== reactProps[key]) {
|
|
73
|
+
props[key] = reactProps[key];
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
return new LayerType(props);
|
|
77
|
+
}
|
|
@@ -1,19 +1,10 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
1
2
|
export default function extractStyles({ width, height, style }: {
|
|
2
|
-
width
|
|
3
|
-
height
|
|
4
|
-
style
|
|
3
|
+
width?: string | number;
|
|
4
|
+
height?: string | number;
|
|
5
|
+
style?: Partial<CSSStyleDeclaration> | null;
|
|
5
6
|
}): {
|
|
6
|
-
containerStyle:
|
|
7
|
-
|
|
8
|
-
zIndex: number;
|
|
9
|
-
left: number;
|
|
10
|
-
top: number;
|
|
11
|
-
width: any;
|
|
12
|
-
height: any;
|
|
13
|
-
};
|
|
14
|
-
canvasStyle: {
|
|
15
|
-
left: number;
|
|
16
|
-
top: number;
|
|
17
|
-
};
|
|
7
|
+
containerStyle: React.CSSProperties;
|
|
8
|
+
canvasStyle: React.CSSProperties;
|
|
18
9
|
};
|
|
19
10
|
//# sourceMappingURL=extract-styles.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"extract-styles.d.ts","sourceRoot":"","sources":["../../src/utils/extract-styles.
|
|
1
|
+
{"version":3,"file":"extract-styles.d.ts","sourceRoot":"","sources":["../../src/utils/extract-styles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAM/B,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,EACpC,KAAK,EACL,MAAM,EACN,KAAK,EACN,EAAE;IACD,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC;CAC7C,GAAG;IACF,cAAc,EAAE,KAAK,CAAC,aAAa,CAAC;IACpC,WAAW,EAAE,KAAK,CAAC,aAAa,CAAC;CAClC,CA8BA"}
|