Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[feat] Using tippy for map popover (#1539)
Shan He9bcb3415f62d
diff --git a/package.json b/package.jsonindex 1c8686e7f..8346fd181 100644--- a/package.json+++ b/package.json@@ -95,6 +95,7 @@"@mapbox/geo-viewport": "^0.4.1","@mapbox/geojson-normalize": "0.0.1","@mapbox/vector-tile": "^1.3.1",+ "@tippyjs/react": "^4.2.0","@turf/bbox": "^6.0.1","@turf/boolean-within": "^6.0.1","@turf/helpers": "^6.1.4",@@ -281,6 +282,6 @@"Giuseppe Macri <[email protected]>"],"volta": {- "node": "10.23.0"+ "node": "12.19.0"}-}+}\ No newline at end of filediff --git a/src/components/map-container.js b/src/components/map-container.jsindex 8144fb5bc..23e3025c4 100644--- a/src/components/map-container.js+++ b/src/components/map-container.js@@ -49,6 +49,8 @@ import {} from 'constants/default-settings';import {OVERLAY_TYPE} from 'layers/base-layer';+import ErrorBoundary from 'components/common/error-boundary';+/** @type {{[key: string]: React.CSSProperties}} */const MAP_STYLE = {container: {@@ -293,16 +295,11 @@ export default function MapContainerFactory(MapPopover, MapControl, Editor) {mousePos: {mousePosition, coordinate, pinned}} = this.props;- if (!mousePosition) {+ if (!mousePosition || !interactionConfig.tooltip) {return null;}- // if clicked something, ignore hover behavior- let layerHoverProp = null;- let layerPinnedProp = null;- const position = {x: mousePosition[0], y: mousePosition[1]};- let pinnedPosition = {};- layerHoverProp = getLayerHoverProp({+ const layerHoverProp = getLayerHoverProp({interactionConfig,hoverInfo,layers,@@ -314,10 +311,9 @@ export default function MapContainerFactory(MapPopover, MapControl, Editor) {? interactionConfig.tooltip.config.compareMode: false;- const hasTooltip = pinned || clicked;- const hasComparisonTooltip = compareMode || (!clicked && !pinned);-- if (hasTooltip) {+ let pinnedPosition = {};+ let layerPinnedProp = null;+ if (pinned || clicked) {// project lnglat to screen so that tooltip follows the object on zoomconst viewport = new WebMercatorViewport(mapState);const lngLat = clicked ? clicked.lngLat : pinned.coordinate;@@ -334,34 +330,38 @@ export default function MapContainerFactory(MapPopover, MapControl, Editor) {layerHoverProp.compareType = interactionConfig.tooltip.config.compareType;}}+const commonProp = {onClose: this._onCloseMapPopover,mapW: mapState.width,mapH: mapState.height,- zoom: mapState.zoom+ zoom: mapState.zoom,+ container: this._deck ? this._deck.canvas : undefined};return (- <div>- {hasTooltip && (+ <ErrorBoundary>+ {layerPinnedProp && (<MapPopover{...pinnedPosition}{...commonProp}layerHoverProp={layerPinnedProp}coordinate={interactionConfig.coordinate.enabled && (pinned || {}).coordinate}- frozen={Boolean(hasTooltip)}+ frozen={true}isBase={compareMode}/>)}- {hasComparisonTooltip && (+ {layerHoverProp && (!layerPinnedProp || compareMode) && (<MapPopover- {...position}+ x={mousePosition[0]}+ y={mousePosition[1]}{...commonProp}layerHoverProp={layerHoverProp}+ frozen={false}coordinate={interactionConfig.coordinate.enabled && coordinate}/>)}- </div>+ </ErrorBoundary>);}diff --git a/src/components/map/layer-hover-info.js b/src/components/map/layer-hover-info.jsindex 78fdde9ce..3c0ccfe83 100644--- a/src/components/map/layer-hover-info.js+++ b/src/components/map/layer-hover-info.js@@ -31,8 +31,6 @@ export const StyledLayerName = styled(CenterFlexbox)`font-size: 12px;letter-spacing: 0.43px;text-transform: capitalize;- padding: 0 14px;- margin-top: 12px;svg {margin-right: 4px;diff --git a/src/components/map/map-popover.d.ts b/src/components/map/map-popover.d.tsindex 3f9277768..b572ea3d9 100644--- a/src/components/map/map-popover.d.ts+++ b/src/components/map/map-popover.d.ts@@ -1,3 +1,4 @@+import React from 'react';import {FunctionComponent} from 'react';import {IntlShape} from 'react-intl';import {LayerHoverProp} from '../../utils/layer-utils';@@ -12,6 +13,7 @@ export type MapPopoverProps = {layerHoverProp: LayerHoverProp | null;isBase?: boolean;zoom: number;+ container?: HTMLElement | null;onClose: () => void;};diff --git a/src/components/map/map-popover.js b/src/components/map/map-popover.jsindex a427cc0b9..aefb3fba4 100644--- a/src/components/map/map-popover.js+++ b/src/components/map/map-popover.js@@ -18,26 +18,34 @@// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN// THE SOFTWARE.-import React, {useState, useCallback, useRef, useLayoutEffect} from 'react';+import React, {useState} from 'react';import styled from 'styled-components';import LayerHoverInfoFactory from './layer-hover-info';import CoordinateInfoFactory from './coordinate-info';-import {Pin, ArrowLeft, ArrowRight} from 'components/common/icons';-import ErrorBoundary from 'components/common/error-boundary';+import {ArrowLeft, ArrowRight, Pin} from 'components/common/icons';import {injectIntl} from 'react-intl';import {FormattedMessage} from 'localization';+import Tippy from '@tippyjs/react/headless';const MAX_WIDTH = 500;const MAX_HEIGHT = 600;const StyledMapPopover = styled.div`+ display: flex;+ flex-direction: column;+ max-width: ${MAX_WIDTH}px;+ max-height: ${MAX_HEIGHT}px;+ padding: 14px;+ & > * + * {+ margin-top: 6px;+ }${props => props.theme.scrollBar};+ font-family: ${props => props.theme.fontFamily};font-size: 11px;font-weight: 500;background-color: ${props => props.theme.panelBackground};color: ${props => props.theme.textColor};z-index: 1000;- position: absolute;overflow-x: auto;box-shadow: ${props => props.theme.panelBoxShadow};@@ -45,57 +53,73 @@ const StyledMapPopover = styled.div`background-color: ${props => `${props.theme.panelBackground}dd`};}- .gutter {- height: 6px;- margin-bottom: 20px;- }-.primary-label {color: ${props => props.theme.notificationColors.success};- position: absolute;- right: 18px;- top: 10px;font-size: 10px;}+ .map-popover__layer-info,+ .coordingate-hover-info {+ & > * + * {+ margin-top: 7px;+ }+ }+table {- margin: 2px 12px 12px 12px;width: auto;+ display: grid;+ border-collapse: collapse;+ row-gap: 5px;+ column-gap: 5px;+ }- tbody {- border-top: transparent;- border-bottom: transparent;- }+ .coordingate-hover-info > table {+ grid-template-columns: auto auto auto;+ }+ .map-popover__layer-info > table {+ grid-template-columns: auto auto;+ }- td {- border-color: transparent;- padding: 4px;- color: ${props => props.theme.textColor};- }+ tbody,+ tr {+ display: contents;+ }- td.row__value {- text-align: right;- font-weight: 500;- color: ${props => props.theme.textColorHl};- }+ td {+ border-color: transparent;+ color: ${props => props.theme.textColor};+ }++ td.row__value {+ text-align: right;+ font-weight: 500;+ color: ${props => props.theme.textColorHl};}`;-const StyledIcon = styled.div`- position: absolute;- left: 50%;- transform: rotate(30deg);- top: 10px;- color: ${props => props.theme.activeColor};+const PinnedButtons = styled.div`+ display: flex;+ align-self: center;+ align-items: center;+ justify-items: center;+ & > * + * {+ margin-left: 10px;+ }+`;- &.popover-arrow-left {- left: 40%;- transform: rotate(0deg);+const PopoverContent = styled.div`+ display: flex;+ flex-direction: column;+ & > * + * {+ margin-top: 12px;}+`;++const StyledIcon = styled.div`+ color: ${props => props.theme.activeColor};- &.popover-arrow-right {- left: 60%;- transform: rotate(0deg);+ &.popover-pin {+ transform: rotate(30deg);}:hover {@@ -106,80 +130,47 @@ const StyledIcon = styled.div`MapPopoverFactory.deps = [LayerHoverInfoFactory, CoordinateInfoFactory];-export function getPosition({x, y, mapW, mapH, width, height, isLeft}) {- const topOffset = 20;- const leftOffset = 20;- if (![x, y, mapW, mapH, width, height].every(Number.isFinite)) {- return {};- }-- const pos = {};- if (x + leftOffset + width > mapW || isLeft) {- pos.right = mapW - x + leftOffset;- } else {- pos.left = x + leftOffset;- }-- if (y + topOffset + height > mapH) {- pos.bottom = 10;- } else {- pos.top = y + topOffset;- }-- return pos;+function createVirtualReference(container, x, y, size = 0) {+ const bounds =+ container && container.getBoundingClientRect ? container.getBoundingClientRect() : {};+ const left = (bounds.left || 0) + x - size / 2;+ const top = (bounds.top || 0) + y - size / 2;+ return {+ left,+ top,+ right: left + size,+ bottom: top + size,+ width: size,+ height: size+ };}-function hasPosChanged({oldPos = {}, newPos = {}}) {- for (const key in newPos) {- if (oldPos[key] !== newPos[key]) {- return true;- }- }- for (const key in oldPos) {- if (oldPos[key] !== newPos[key]) {- return true;- }+function getOffsetForPlacement({placement, reference, popper}, gap = 20) {+ switch (placement) {+ case 'top-start':+ case 'bottom-start':+ return [gap, gap];+ case 'top-end':+ case 'bottom-end':+ return [-gap, gap];+ default:+ return [0, 0];}- return false;}-// hooks-export function usePosition({layerHoverProp, x, y, mapW, mapH}, popover) {- const [isLeft, setIsLeft] = useState(false);- const [pos, setPosition] = useState({});-- const moveLeft = useCallback(() => setIsLeft(true), [setIsLeft]);- const moveRight = useCallback(() => setIsLeft(false), [setIsLeft]);- const hoverData = layerHoverProp && layerHoverProp.data;-- useLayoutEffect(() => {- const node = popover.current;-- if (!node || !hoverData) {- return;- }-- const width = Math.round(node.offsetWidth);- const height = Math.round(node.offsetHeight);-- if (Number.isFinite(width) && width > 0 && Number.isFinite(height) && height > 0) {- const newPos = getPosition({- x,- y,- mapW,- mapH,- width,- height,- isLeft- });- if (hasPosChanged({oldPos: pos, newPos})) {- setPosition(newPos);+function getPopperOptions(container) {+ return {+ modifiers: [+ {+ name: 'preventOverflow',+ options: {+ boundary: container+ }}- }- }, [x, y, mapH, mapW, isLeft, hoverData, pos, popover]);-- return {moveLeft, moveRight, isLeft, pos};+ ]+ };}+export default function MapPopoverFactory(LayerHoverInfo, CoordinateInfo) {/** @type {typeof import('./map-popover').MapPopover} */const MapPopover = ({@@ -192,54 +183,56 @@ export default function MapPopoverFactory(LayerHoverInfo, CoordinateInfo) {layerHoverProp,isBase,zoom,+ container,onClose}) => {- const popover = useRef(null);- const {moveLeft, moveRight, isLeft, pos} = usePosition(- {layerHoverProp, x, y, mapW, mapH},- popover- );-+ const [horizontalPlacement, setHorizontalPlacement] = useState('start');+ const moveLeft = () => setHorizontalPlacement('end');+ const moveRight = () => setHorizontalPlacement('start');return (- <ErrorBoundary>- <StyledMapPopover- ref={popover}- className="map-popover"- style={{- ...pos,- maxWidth: MAX_WIDTH,- maxHeight: MAX_HEIGHT- }}- >- {frozen ? (- <div className="map-popover__top">- <div className="gutter" />- {!isLeft && (- <StyledIcon className="popover-arrow-left" onClick={moveLeft}>- <ArrowLeft />+ <Tippy+ popperOptions={getPopperOptions(container)}+ zIndex={999} /* should be below Modal which has zIndex=1000 */+ visible={true}+ interactive={true}+ getReferenceClientRect={() => createVirtualReference(container, x, y)}+ // @ts-ignore+ placement={`bottom-${horizontalPlacement}`}+ // @ts-ignore+ offset={getOffsetForPlacement}+ appendTo={document.body}+ render={attrs => (+ <StyledMapPopover {...attrs} className="map-popover">+ {frozen ? (+ <PinnedButtons>+ {horizontalPlacement === 'start' && (+ <StyledIcon className="popover-arrow-left" onClick={moveLeft}>+ <ArrowLeft />+ </StyledIcon>+ )}+ <StyledIcon className="popover-pin" onClick={onClose}>+ <Pin height="16px" /></StyledIcon>- )}- <StyledIcon className="popover-pin" onClick={onClose}>- <Pin height="16px" />- </StyledIcon>- {isLeft && (- <StyledIcon className="popover-arrow-right" onClick={moveRight}>- <ArrowRight />- </StyledIcon>- )}- {isBase && (- <div className="primary-label">- <FormattedMessage id="mapPopover.primary" />- </div>- )}- </div>- ) : null}- {Array.isArray(coordinate) && <CoordinateInfo coordinate={coordinate} zoom={zoom} />}- {layerHoverProp && <LayerHoverInfo {...layerHoverProp} />}- </StyledMapPopover>- </ErrorBoundary>+ {horizontalPlacement === 'end' && (+ <StyledIcon className="popover-arrow-right" onClick={moveRight}>+ <ArrowRight />+ </StyledIcon>+ )}+ {isBase && (+ <div className="primary-label">+ <FormattedMessage id="mapPopover.primary" />+ </div>+ )}+ </PinnedButtons>+ ) : null}+ <PopoverContent>+ {Array.isArray(coordinate) && <CoordinateInfo coordinate={coordinate} zoom={zoom} />}+ {layerHoverProp && <LayerHoverInfo {...layerHoverProp} />}+ </PopoverContent>+ </StyledMapPopover>+ )}+ />);};-return injectIntl(MapPopover);}diff --git a/test/browser/components/map/map-popover-test.js b/test/browser/components/map/map-popover-test.jsindex d24c93fce..4cfc8086d 100644--- a/test/browser/components/map/map-popover-test.js+++ b/test/browser/components/map/map-popover-test.js@@ -21,11 +21,10 @@import React from 'react';import sinon from 'sinon';import test from 'tape';-import {renderHook} from '@testing-library/react-hooks';import {Pin} from 'components/common/icons';import {IntlWrapper, mountWithTheme} from 'test/helpers/component-utils';-import MapPopoverFactory, {usePosition} from 'components/map/map-popover';+import MapPopoverFactory from 'components/map/map-popover';import {appInjector} from 'components';const MapPopover = appInjector.get(MapPopoverFactory);@@ -57,42 +56,3 @@ test('Map Popover - render', t => {t.end();});--test('Map Popover -> renderHooks', t => {- const wrapper = ({children}) => <IntlWrapper>{children}</IntlWrapper>;- const ref = {- current: {- offsetWidth: 50,- offsetHeight: 50- }- };- const layerHoverProp = {data: [1]};-- const {result} = renderHook(- () =>- usePosition(- {- x: 100,- y: 200,- mapW: 600,- mapH: 800,- layerHoverProp- },- ref- ),- {- wrapper- }- );-- t.deepEqual(- result.current.pos,- {- left: 120,- top: 220- },- 'should calculate correct pos'- );-- t.end();-});diff --git a/test/setup-browser-env.js b/test/setup-browser-env.jsindex 357b56ec8..7487c053d 100644--- a/test/setup-browser-env.js+++ b/test/setup-browser-env.js@@ -113,6 +113,7 @@ function mockCanvas(globalWindow) {global.window = window;global.document = window.document;global.HTMLElement = window.HTMLElement;+global.Element = window.Element;global.fetch = window.fetch;Object.keys(global.window).forEach(property => {diff --git a/yarn.lock b/yarn.lockindex c2f761ec0..599655d24 100644--- a/yarn.lock+++ b/yarn.lock@@ -2702,6 +2702,11 @@"@nodelib/fs.scandir" "2.1.3"fastq "^1.6.0"+"@popperjs/core@^2.4.4":+ version "2.6.0"+ resolved "https://registry.yarnpkg.com/@popperjs/core/-/core-2.6.0.tgz#f022195afdfc942e088ee2101285a1d31c7d727f"+ integrity sha512-cPqjjzuFWNK3BSKLm0abspP0sp/IGOli4p5I5fKFAzdS8fvjdOwDCfZqAaIiXd9lPkOWi3SUUfZof3hEb7J/uw==+"@probe.gl/[email protected]", "@probe.gl/stats@^3.3.0":version "3.3.0"resolved "https://registry.yarnpkg.com/@probe.gl/stats/-/stats-3.3.0.tgz#66f684ead7cee1f2aad5ee5e9d297e84e08c5536"@@ -2756,6 +2761,13 @@"@babel/runtime" "^7.12.5""@types/testing-library__react-hooks" "^3.4.0"+"@tippyjs/react@^4.2.0":+ version "4.2.0"+ resolved "https://registry.yarnpkg.com/@tippyjs/react/-/react-4.2.0.tgz#a1cb369d0051099e8a7e4ceb59f809abd9955283"+ integrity sha512-T6UcHtwtGkvgsBQ4bNp8BtXGxa2ujfOkWUogYkRtN4UVJ2QRgDdFoJeaPxdndnVYFEa2uTVxSFxs8QkSkZ2Gdw==+ dependencies:+ tippy.js "^6.2.0"+"@turf/[email protected]", "@turf/bbox@^6.0.1":version "6.0.1"resolved "https://registry.yarnpkg.com/@turf/bbox/-/bbox-6.0.1.tgz#b966075771475940ee1c16be2a12cf389e6e923a"@@ -14626,6 +14638,13 @@ tinyqueue@^2.0.3:resolved "https://registry.yarnpkg.com/tinyqueue/-/tinyqueue-2.0.3.tgz#64d8492ebf39e7801d7bd34062e29b45b2035f08"integrity sha512-ppJZNDuKGgxzkHihX8v9v9G5f+18gzaTfrukGrq6ueg0lmH4nqVnA2IPG0AEH3jKEk2GRJCUhDoqpoiw3PHLBA==+tippy.js@^6.2.0:+ version "6.2.7"+ resolved "https://registry.yarnpkg.com/tippy.js/-/tippy.js-6.2.7.tgz#62fb34eda23f7d78151ddca922b62818c1ab9869"+ integrity sha512-k+kWF9AJz5xLQHBi3K/XlmJiyu+p9gsCyc5qZhxxGaJWIW8SMjw1R+C7saUnP33IM8gUhDA2xX//ejRSwqR0tA==+ dependencies:+ "@popperjs/core" "^2.4.4"+tmp@^0.0.33:version "0.0.33"resolved "https://registry.yarnpkg.com/tmp/-/tmp-0.0.33.tgz#6d34335889768d21b2bcda0aa277ced3b1bfadf9"