Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

[Bug] Fix styled-components warnings for passing props to Dom (#3039)

Shan He6cc1ee4ef7bf
diff --git a/src/components/src/common/index.ts b/src/components/src/common/index.ts
index b616d2d8e..7bc2f525e 100644
--- a/src/components/src/common/index.ts
+++ b/src/components/src/common/index.ts
@@ -30,7 +30,7 @@ export {
SidePanelDivider,
SidePanelSection,
SpaceBetweenFlexbox,
- StyledAttrbution,
+ StyledAttribution,
StyledExportSection,
StyledFilterContent,
StyledFilteredOption,
diff --git a/src/components/src/common/styled-components.tsx b/src/components/src/common/styled-components.tsx
index ad5d81a2f..133a42820 100644
--- a/src/components/src/common/styled-components.tsx
+++ b/src/components/src/common/styled-components.tsx
@@ -543,14 +543,18 @@ export const StyledMapContainer = styled.div`
}
`;
-export type StyledAttrbutionProps = {
+export type StyledAttributionProps = {
mapLibCssClass: string;
mapLibAttributionCssClass: string;
};
-export const StyledAttrbution = styled.div.attrs<StyledAttrbutionProps>(props => ({
- className: props.mapLibAttributionCssClass
-}))<StyledAttrbutionProps>`
+export const StyledAttribution = styled.div
+ .withConfig({
+ shouldForwardProp: prop => !['mapLibCssClass', 'mapLibAttributionCssClass'].includes(prop)
+ })
+ .attrs<StyledAttributionProps>(props => ({
+ className: props.mapLibAttributionCssClass
+ }))<StyledAttributionProps>`
bottom: 0;
right: 0;
position: absolute;
@@ -722,9 +726,13 @@ interface MapControlButtonProps {
active?: boolean;
}
-export const MapControlButton = styled(Button).attrs(props => ({
- className: classnames('map-control-button', props.className)
-}))<MapControlButtonProps>`
+export const MapControlButton = styled(Button)
+ .withConfig({
+ shouldForwardProp: prop => !['active'].includes(prop)
+ })
+ .attrs(props => ({
+ className: classnames('map-control-button', props.className)
+ }))<MapControlButtonProps>`
box-shadow: 0 6px 12px 0 rgba(0, 0, 0, 0.16);
height: 32px;
width: 32px;
diff --git a/src/components/src/index.ts b/src/components/src/index.ts
index 32c680104..4e15b2fd9 100644
--- a/src/components/src/index.ts
+++ b/src/components/src/index.ts
@@ -425,7 +425,7 @@ export {
SidePanelDivider,
SidePanelSection,
SpaceBetweenFlexbox,
- StyledAttrbution,
+ StyledAttribution,
StyledExportSection,
StyledFilterContent,
StyledFilteredOption,
diff --git a/src/components/src/loading-indicator.tsx b/src/components/src/loading-indicator.tsx
index daa3a9f2c..58bef9bd7 100644
--- a/src/components/src/loading-indicator.tsx
+++ b/src/components/src/loading-indicator.tsx
@@ -5,17 +5,17 @@ import React, {PropsWithChildren} from 'react';
import styled, {withTheme} from 'styled-components';
type StyledContainerProps = {
- isVisible?: boolean;
- left: number;
+ $isVisible?: boolean;
+ $left: number;
};
export const StyledContainer = styled.div<StyledContainerProps>`
position: absolute;
- left: ${props => props.left}px;
+ left: ${props => props.$left}px;
bottom: ${props => props.theme.sidePanel.margin.left}px;
z-index: 1;
color: ${props => props.theme.textColorHl};
- opacity: ${props => (props.isVisible ? 1 : 0)};
+ opacity: ${props => (props.$isVisible ? 1 : 0)};
transition: opacity 0.5s ease-in-out;
background-color: ${props => props.theme.sidePanelBg};
border-radius: 0px;
@@ -40,7 +40,7 @@ const LoadingIndicator: React.FC<PropsWithChildren<LoadingIndicatorProps> & {the
const left = (activeSidePanel ? sidePanelWidth || 0 : 0) + theme.sidePanel.margin.left;
return (
- <StyledContainer isVisible={isVisible} left={left}>
+ <StyledContainer $isVisible={isVisible} $left={left}>
{children}
</StyledContainer>
);
diff --git a/src/components/src/map-container.tsx b/src/components/src/map-container.tsx
index 88407241e..b9abb3aa1 100644
--- a/src/components/src/map-container.tsx
+++ b/src/components/src/map-container.tsx
@@ -18,7 +18,7 @@ import MapPopoverFactory from './map/map-popover';
import MapControlFactory from './map/map-control';
import {
StyledMapContainer,
- StyledAttrbution,
+ StyledAttribution,
EndHorizontalFlexbox
} from './common/styled-components';
@@ -118,16 +118,16 @@ const MAP_STYLE: {[key: string]: React.CSSProperties} = {
const LOCALE_CODES_ARRAY = Object.keys(LOCALE_CODES);
interface StyledMapContainerProps {
- mixBlendMode?: string;
- mapLibCssClass: string;
+ $mixBlendMode?: string;
+ $mapLibCssClass: string;
}
const StyledMap = styled(StyledMapContainer)<StyledMapContainerProps>(
- ({mixBlendMode = 'normal', mapLibCssClass}) => `
+ ({$mixBlendMode = 'normal', $mapLibCssClass}) => `
#default-deckgl-overlay {
- mix-blend-mode: ${mixBlendMode};
+ mix-blend-mode: ${$mixBlendMode};
};
- *[${mapLibCssClass}-children] {
+ *[${$mapLibCssClass}-children] {
position: absolute;
}
`
@@ -246,7 +246,7 @@ export const Attribution: React.FC<AttributionProps> = ({
const memoizedComponents = useMemo(() => {
if (!showBaseMapLibLogo) {
return (
- <StyledAttrbution
+ <StyledAttribution
mapLibCssClass={baseMapLibraryConfig.mapLibCssClass}
mapLibAttributionCssClass={baseMapLibraryConfig.mapLibAttributionCssClass}
>
@@ -265,12 +265,12 @@ export const Attribution: React.FC<AttributionProps> = ({
</div>
) : null}
</EndHorizontalFlexbox>
- </StyledAttrbution>
+ </StyledAttribution>
);
}
return (
- <StyledAttrbution
+ <StyledAttribution
mapLibCssClass={baseMapLibraryConfig.mapLibCssClass}
mapLibAttributionCssClass={baseMapLibraryConfig.mapLibAttributionCssClass}
>
@@ -285,7 +285,7 @@ export const Attribution: React.FC<AttributionProps> = ({
{!isPalm ? <MapLibLogo baseMapLibraryConfig={baseMapLibraryConfig} /> : null}
</div>
</EndHorizontalFlexbox>
- </StyledAttrbution>
+ </StyledAttribution>
);
}, [
showBaseMapLibLogo,
@@ -1193,8 +1193,8 @@ export default function MapContainerFactory(
ref={this._ref}
style={this.styleSelector(this.props)}
onContextMenu={event => event.preventDefault()}
- mixBlendMode={visState.overlayBlending}
- mapLibCssClass={baseMapLibraryConfig.mapLibCssClass}
+ $mixBlendMode={visState.overlayBlending}
+ $mapLibCssClass={baseMapLibraryConfig.mapLibCssClass}
>
{mapContent}
</StyledMap>
diff --git a/src/components/src/map/map-control.tsx b/src/components/src/map/map-control.tsx
index 494c97163..b35264659 100644
--- a/src/components/src/map/map-control.tsx
+++ b/src/components/src/map/map-control.tsx
@@ -18,14 +18,14 @@ import {Datasets} from '@kepler.gl/table';
import {MapStateActions, UIStateActions} from '@kepler.gl/actions';
interface StyledMapControlProps {
- top?: number;
+ $top?: number;
}
const StyledMapControl = styled.div<StyledMapControlProps>`
right: 0;
padding: ${props => props.theme.mapControl.padding}px;
z-index: 10;
- margin-top: ${props => props.top || 0}px;
+ margin-top: ${props => props.$top || 0}px;
position: absolute;
display: grid;
row-gap: 8px;
@@ -122,7 +122,7 @@ function MapControlFactory(
...restProps
};
return (
- <StyledMapControl className="map-control" top={top}>
+ <StyledMapControl className="map-control" $top={top}>
{actionComponents.map((ActionComponent, index) => (
<ActionComponent key={index} className="map-control-action" {...actionComponentProps} />
))}