Skip to content

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

[Chore]: Technical: add types for side panel root components (#1822)

jagerts5ee0cd4fc047
diff --git a/src/components/side-panel.tsx b/src/components/side-panel.tsx
index 033f1135d..22bc3845d 100644
--- a/src/components/side-panel.tsx
+++ b/src/components/side-panel.tsx
@@ -18,11 +18,8 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
-import React, {useCallback, useMemo, ComponentType} from 'react';
+import React, {useCallback, useMemo} from 'react';
import {FormattedMessage} from 'localization';
-import {Datasets, Filter, InteractionConfig, MapStyle} from '../reducers';
-import {Layer, LayerClassesType} from '../layers';
-import {UiState} from 'reducers/ui-state-updaters';
import {
EXPORT_DATA_ID,
@@ -48,43 +45,7 @@ import PanelTitleFactory from './side-panel/panel-title';
import styled from 'styled-components';
import get from 'lodash.get';
-
-import * as MapStyleActions from 'actions/map-style-actions';
-import * as VisStateActions from 'actions/vis-state-actions';
-import * as MapStateActions from 'actions/map-state-actions';
-import * as UIStateActions from 'actions/ui-state-actions';
-
-type SidePanelItem = {
- id: string;
- label: string;
- iconComponent: ComponentType<any>;
- component?: ComponentType<any>;
-};
-
-type SidePanelProps = {
- appName: string;
- appWebsite: string;
- filters: Filter[];
- interactionConfig: InteractionConfig;
- layerBlending: string;
- layers: Layer[];
- layerClasses: LayerClassesType;
- layerOrder: number[];
- mapStyle: MapStyle;
- onSaveMap?: () => void;
- width: number;
- mapInfo: {title: string; description: string};
- datasets: Datasets;
- uiStateActions: typeof UIStateActions;
- visStateActions: typeof VisStateActions;
- mapStateActions: typeof MapStateActions;
- mapStyleActions: typeof MapStyleActions;
- uiState: UiState;
- availableProviders: {hasShare: boolean; hasStorage: boolean};
- mapSaved?: string | null;
- panels: SidePanelItem[];
- version: string;
-};
+import {SidePanelProps} from './types';
export const StyledSidePanelContent = styled.div`
${props => props.theme.sidePanelScrollBar};
diff --git a/src/components/side-panel/cloud-storage-dropdown.js b/src/components/side-panel/cloud-storage-dropdown.tsx
similarity index 100%
rename from src/components/side-panel/cloud-storage-dropdown.js
rename to src/components/side-panel/cloud-storage-dropdown.tsx
diff --git a/src/components/side-panel/custom-panel.js b/src/components/side-panel/custom-panel.tsx
similarity index 100%
rename from src/components/side-panel/custom-panel.js
rename to src/components/side-panel/custom-panel.tsx
diff --git a/src/components/side-panel/filter-manager.js b/src/components/side-panel/filter-manager.tsx
similarity index 83%
rename from src/components/side-panel/filter-manager.js
rename to src/components/side-panel/filter-manager.tsx
index 002c65150..afd88d39d 100644
--- a/src/components/side-panel/filter-manager.js
+++ b/src/components/side-panel/filter-manager.tsx
@@ -19,16 +19,31 @@
// THE SOFTWARE.
import React, {useCallback, useMemo} from 'react';
-import PropTypes from 'prop-types';
import {FormattedMessage} from 'localization';
import {Button, SidePanelDivider, SidePanelSection} from 'components/common/styled-components';
import {Add} from 'components/common/icons';
import SourceDataCatalogFactory from './common/source-data-catalog';
import FilterPanelFactory from './filter-panel/filter-panel';
+import {Datasets, Filter} from 'reducers';
+import {Layer} from 'layers';
+import * as VisStateActions from 'actions/vis-state-actions';
+import {ActionHandler} from 'actions';
+
+type FilterManagerProps = {
+ filters: Filter[];
+ datasets: Datasets;
+ layers: Layer[];
+ showDatasetTable: ActionHandler<typeof VisStateActions.showDatasetTable>;
+ updateTableColor: ActionHandler<typeof VisStateActions.updateTableColor>;
+ visStateActions: typeof VisStateActions;
+};
FilterManagerFactory.deps = [SourceDataCatalogFactory, FilterPanelFactory];
-function FilterManagerFactory(SourceDataCatalog, FilterPanel) {
+function FilterManagerFactory(
+ SourceDataCatalog: ReturnType<typeof SourceDataCatalogFactory>,
+ FilterPanel: ReturnType<typeof FilterPanelFactory>
+) {
const FilterManager = ({
filters = [],
datasets,
@@ -36,13 +51,13 @@ function FilterManagerFactory(SourceDataCatalog, FilterPanel) {
showDatasetTable,
updateTableColor,
visStateActions
- }) => {
+ }: FilterManagerProps) => {
const {
addFilter,
enlargeFilter,
removeFilter,
setFilter,
- toggleAnimation,
+ toggleFilterAnimation,
toggleFilterFeature
} = visStateActions;
const isAnyFilterAnimating = filters.some(f => f.isAnimating);
@@ -80,7 +95,7 @@ function FilterManagerFactory(SourceDataCatalog, FilterPanel) {
isAnyFilterAnimating={isAnyFilterAnimating}
removeFilter={() => removeFilter(idx)}
enlargeFilter={() => enlargeFilter(idx)}
- toggleAnimation={() => toggleAnimation(idx)}
+ toggleAnimation={() => toggleFilterAnimation(idx)}
toggleFilterFeature={() => toggleFilterFeature(idx)}
setFilter={setFilter}
/>
@@ -99,18 +114,6 @@ function FilterManagerFactory(SourceDataCatalog, FilterPanel) {
);
};
- FilterManager.propTypes = {
- datasets: PropTypes.object,
- layers: PropTypes.arrayOf(PropTypes.any).isRequired,
- filters: PropTypes.arrayOf(PropTypes.any).isRequired,
- showDatasetTable: PropTypes.func.isRequired,
- updateTableColor: PropTypes.func.isRequired,
- visStateActions: PropTypes.object.isRequired,
-
- // fields can be undefined when dataset is not selected
- fields: PropTypes.arrayOf(PropTypes.any)
- };
-
return FilterManager;
}
diff --git a/src/components/side-panel/filter-panel/filter-panel.tsx b/src/components/side-panel/filter-panel/filter-panel.tsx
index 5eba60f60..8c9ed3852 100644
--- a/src/components/side-panel/filter-panel/filter-panel.tsx
+++ b/src/components/side-panel/filter-panel/filter-panel.tsx
@@ -33,6 +33,7 @@ import PolygonFilterPanelFactory from 'components/filters/filter-panels/polygon-
import {Filter} from 'reducers/vis-state-updaters';
import {Field} from 'utils/table-utils/kepler-table';
import {FilterPanelProps} from 'components/filters/filter-panels/types';
+import {Layer} from 'layers';
const StyledFilterPanel = styled.div`
margin-bottom: 12px;
@@ -41,6 +42,11 @@ const StyledFilterPanel = styled.div`
interface FilterPanelPropsImpl extends Omit<FilterPanelProps, 'allAvailableFields'> {
filters: Filter[];
+ layers: ReadonlyArray<Layer>;
+ isAnyFilterAnimating: boolean;
+ enlargeFilter: () => void;
+ toggleAnimation: () => void;
+ toggleFilterFeature: () => void;
}
FilterPanelFactory.deps = [
diff --git a/src/components/side-panel/interaction-manager.js b/src/components/side-panel/interaction-manager.tsx
similarity index 78%
rename from src/components/side-panel/interaction-manager.js
rename to src/components/side-panel/interaction-manager.tsx
index 608e0b804..5a8765612 100644
--- a/src/components/side-panel/interaction-manager.js
+++ b/src/components/side-panel/interaction-manager.tsx
@@ -19,13 +19,26 @@
// THE SOFTWARE.
import React from 'react';
+import {Datasets, InteractionConfig} from 'reducers';
import InteractionPanelFactory from './interaction-panel/interaction-panel';
+import * as VisStateActions from 'actions/vis-state-actions';
+
+type InteractionManagerProps = {
+ interactionConfig: InteractionConfig;
+ datasets: Datasets;
+ visStateActions: typeof VisStateActions;
+};
InteractionManagerFactory.deps = [InteractionPanelFactory];
-function InteractionManagerFactory(InteractionPanel) {
- const InteractionManager = ({interactionConfig, datasets, visStateActions}) => {
+function InteractionManagerFactory(InteractionPanel: ReturnType<typeof InteractionPanelFactory>) {
+ const InteractionManager = ({
+ interactionConfig,
+ datasets,
+ visStateActions
+ }: InteractionManagerProps) => {
const {interactionConfigChange: onConfigChange} = visStateActions;
+
return (
<div className="interaction-manager">
{Object.keys(interactionConfig).map(key => (
diff --git a/src/components/side-panel/interaction-panel/tooltip-config.tsx b/src/components/side-panel/interaction-panel/tooltip-config.tsx
index 34691f7aa..43087ca90 100644
--- a/src/components/side-panel/interaction-panel/tooltip-config.tsx
+++ b/src/components/side-panel/interaction-panel/tooltip-config.tsx
@@ -36,6 +36,8 @@ import ItemSelector from 'components/common/item-selector/item-selector';
import {COMPARE_TYPES} from 'constants/tooltip';
import FieldSelectorFactory from '../../common/field-selector';
import {GEOCODER_DATASET_NAME} from 'constants/default-settings';
+import KeplerTable from 'utils/table-utils/kepler-table';
+import {Datasets} from 'reducers';
const TooltipConfigWrapper = styled.div`
.item-selector > div > div {
@@ -83,18 +85,7 @@ type TooltipConfigProps = {
compareMode: boolean;
compareType: string[];
}) => void;
- datasets: {
- [key: string]: {
- id: string;
- fields: {
- format?: string;
- id?: string;
- name?: string;
- fieldIdx?: number;
- type?: number;
- }[];
- };
- };
+ datasets: Datasets;
intl: IntlShape;
};
@@ -113,20 +104,14 @@ type DatasetTooltipConfigProps = {
compareMode: boolean;
compareType: string[];
}) => void;
- dataset: {
- id: string;
- fields: {
- format?: string;
- id?: string;
- name?: string;
- fieldIdx?: number;
- type?: number;
- }[];
- };
+ dataset: KeplerTable;
};
TooltipConfigFactory.deps = [DatasetTagFactory, FieldSelectorFactory];
-function TooltipConfigFactory(DatasetTag, FieldSelector: ReturnType<typeof FieldSelectorFactory>) {
+function TooltipConfigFactory(
+ DatasetTag: ReturnType<typeof DatasetTagFactory>,
+ FieldSelector: ReturnType<typeof FieldSelectorFactory>
+) {
const DatasetTooltipConfig = ({config, onChange, dataset}: DatasetTooltipConfigProps) => {
const dataId = dataset.id;
return (
diff --git a/src/components/side-panel/layer-manager.js b/src/components/side-panel/layer-manager.tsx
similarity index 75%
rename from src/components/side-panel/layer-manager.js
rename to src/components/side-panel/layer-manager.tsx
index f66b62794..fd192920f 100644
--- a/src/components/side-panel/layer-manager.js
+++ b/src/components/side-panel/layer-manager.tsx
@@ -20,8 +20,7 @@
import React, {Component, useCallback} from 'react';
-import PropTypes from 'prop-types';
-import {injectIntl} from 'react-intl';
+import {injectIntl, WrappedComponentProps} from 'react-intl';
import {FormattedMessage} from 'localization';
import styled from 'styled-components';
@@ -36,6 +35,34 @@ import ItemSelector from 'components/common/item-selector/item-selector';
import {PanelLabel, SidePanelDivider, SidePanelSection} from 'components/common/styled-components';
import {LAYER_BLENDINGS} from 'constants/default-settings';
+import {Datasets} from 'reducers';
+import {Layer, LayerClassesType} from 'layers';
+import * as UiStateActions from 'actions/ui-state-actions';
+import * as VisStateActions from 'actions/vis-state-actions';
+import {SidePanelItem} from 'components/types';
+import {LayerPanelListView} from 'reducers/ui-state-updaters';
+import {ActionHandler} from 'actions';
+
+type LayerBlendingSelectorProps = {
+ layerBlending: string;
+ updateLayerBlending: ActionHandler<typeof VisStateActions.updateLayerBlending>;
+} & WrappedComponentProps;
+
+type LayerManagerProps = {
+ datasets: Datasets;
+ layers: Layer[];
+ layerOrder: number[];
+ layerClasses: LayerClassesType;
+ layerBlending: string;
+ uiStateActions: typeof UiStateActions;
+ visStateActions: typeof VisStateActions;
+ showAddDataModal: ActionHandler<typeof UiStateActions.toggleModal>;
+ removeDataset: ActionHandler<typeof UiStateActions.openDeleteModal>;
+ showDatasetTable: ActionHandler<typeof VisStateActions.showDatasetTable>;
+ updateTableColor: ActionHandler<typeof VisStateActions.updateTableColor>;
+ layerPanelListView: LayerPanelListView;
+ panelMetadata: SidePanelItem;
+} & WrappedComponentProps;
const LayerHeader = styled.div.attrs({
className: 'layer-manager-header'
@@ -46,7 +73,11 @@ const LayerHeader = styled.div.attrs({
margin-top: 16px;
`;
-const LayerBlendingSelector = ({layerBlending, updateLayerBlending, intl}) => {
+const LayerBlendingSelector = ({
+ layerBlending,
+ updateLayerBlending,
+ intl
+}: LayerBlendingSelectorProps) => {
const labeledLayerBlendings = Object.keys(LAYER_BLENDINGS).reduce(
(acc, current) => ({
...acc,
@@ -86,32 +117,20 @@ LayerManagerFactory.deps = [
];
function LayerManagerFactory(
- LayerList,
- DatasetLayerGroup,
- PanelViewListToggle,
- PanelTitle,
- DatasetSection,
- AddLayerButton
+ LayerList: ReturnType<typeof LayerListFactory>,
+ DatasetLayerGroup: ReturnType<typeof DatasetLayerGroupFactory>,
+ PanelViewListToggle: ReturnType<typeof PanelViewListToggleFactory>,
+ PanelTitle: ReturnType<typeof PanelTitleFactory>,
+ DatasetSection: ReturnType<typeof DatasetSectionFactory>,
+ AddLayerButton: ReturnType<typeof AddLayerButtonFactory>
) {
- class LayerManager extends Component {
- static propTypes = {
- datasets: PropTypes.object.isRequired,
- layerBlending: PropTypes.string.isRequired,
- layerClasses: PropTypes.object.isRequired,
- layers: PropTypes.arrayOf(PropTypes.any).isRequired,
- visStateActions: PropTypes.object.isRequired,
- // functions
- removeDataset: PropTypes.func.isRequired,
- showDatasetTable: PropTypes.func.isRequired,
- updateTableColor: PropTypes.func.isRequired
- };
-
- _addEmptyNewLayer = dataset => {
+ class LayerManager extends Component<LayerManagerProps> {
+ _addEmptyNewLayer = (dataset: string) => {
const {visStateActions} = this.props;
visStateActions.addLayer(undefined, dataset);
};
- _toggleLayerPanelListView = listView => {
+ _toggleLayerPanelListView = (listView: string) => {
const {uiStateActions} = this.props;
uiStateActions.toggleLayerPanelListView(listView);
};
@@ -160,6 +179,8 @@ function LayerManagerFactory(
<FormattedMessage id={panelMetadata.label} />
</PanelTitle>
{defaultDataset ? (
+ // TODO replace ignore
+ // @ts-ignore
<AddLayerButton
datasets={datasets}
typeaheadPlaceholder="Search datasets"
@@ -184,6 +205,8 @@ function LayerManagerFactory(
showDeleteDataset
/>
) : (
+ // TODO replace ignore
+ // @ts-ignore
<LayerList
layers={layers}
datasets={datasets}
diff --git a/src/components/side-panel/map-manager.js b/src/components/side-panel/map-manager.tsx
similarity index 83%
rename from src/components/side-panel/map-manager.js
rename to src/components/side-panel/map-manager.tsx
index eb1c2a247..3a6115030 100644
--- a/src/components/side-panel/map-manager.js
+++ b/src/components/side-panel/map-manager.tsx
@@ -19,7 +19,6 @@
// THE SOFTWARE.
import React, {Component} from 'react';
-import PropTypes from 'prop-types';
import {Button, SidePanelSection} from 'components/common/styled-components';
import MapStyleSelectorFactory from 'components/side-panel/map-style-panel/map-style-selector';
@@ -28,31 +27,36 @@ import LayerGroupSelectorFactory from 'components/side-panel/map-style-panel/map
import {Add} from 'components/common/icons';
import ColorSelector from './layer-panel/color-selector';
import {createSelector} from 'reselect';
-import {injectIntl} from 'react-intl';
+import {injectIntl, WrappedComponentProps} from 'react-intl';
import {FormattedMessage} from 'localization';
+import {MapStyle} from 'reducers';
+import * as MapStyleActions from 'actions/map-style-actions';
-MapManagerFactory.deps = [MapStyleSelectorFactory, LayerGroupSelectorFactory];
+type MapManagerProps = {
+ mapStyle: MapStyle;
+ mapStyleActions: typeof MapStyleActions;
+ showAddMapStyleModal: () => void;
+} & WrappedComponentProps;
-function MapManagerFactory(MapStyleSelector, LayerGroupSelector) {
- class MapManager extends Component {
- static propTypes = {
- mapStyle: PropTypes.object.isRequired,
- mapStyleActions: PropTypes.object.isRequired,
- showAddMapStyleModal: PropTypes.func.isRequired
- };
+MapManagerFactory.deps = [MapStyleSelectorFactory, LayerGroupSelectorFactory];
+function MapManagerFactory(
+ MapStyleSelector: ReturnType<typeof MapStyleSelectorFactory>,
+ LayerGroupSelector: ReturnType<typeof LayerGroupSelectorFactory>
+) {
+ class MapManager extends Component<MapManagerProps> {
state = {
isSelecting: false
};
- buildingColorSelector = props => props.mapStyle.threeDBuildingColor;
- setColorSelector = props => props.mapStyleActions.set3dBuildingColor;
+ buildingColorSelector = (props: MapManagerProps) => props.mapStyle.threeDBuildingColor;
+ setColorSelector = (props: MapManagerProps) => props.mapStyleActions.set3dBuildingColor;
_toggleSelecting = () => {
this.setState({isSelecting: !this.state.isSelecting});
};
- _selectStyle = val => {
+ _selectStyle = (val: string) => {
const {mapStyleActions} = this.props;
const {mapStyleChange} = mapStyleActions;
mapStyleChange(val);
diff --git a/src/components/side-panel/map-style-panel/map-layer-selector.tsx b/src/components/side-panel/map-style-panel/map-layer-selector.tsx
index 369d5e0d0..88bb80020 100644
--- a/src/components/side-panel/map-style-panel/map-layer-selector.tsx
+++ b/src/components/side-panel/map-style-panel/map-layer-selector.tsx
@@ -18,7 +18,7 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
-import React from 'react';
+import React, {ComponentType} from 'react';
import styled from 'styled-components';
import PanelHeaderActionFactory from 'components/side-panel/panel-header-action';
import {EyeSeen, EyeUnseen, Upload} from 'components/common/icons';
@@ -33,6 +33,7 @@ import {
import {FormattedMessage} from 'localization';
import {camelize} from 'utils/utils';
import {VisibleLayerGroups} from 'reducers';
+import {BaseProps} from 'components/common/icons/base';
const StyledInteractionPanel = styled.div`
padding-bottom: 12px;
@@ -68,10 +69,7 @@ type LayerGroupSelectorProps = {
topLayerGroups?: VisibleLayerGroups;
}) => void;
topLayers: VisibleLayerGroups;
- actionIcons: {
- visible?: typeof EyeSeen;
- hidden?: typeof EyeUnseen;
- };
+ actionIcons?: Record<string, ComponentType<Partial<BaseProps>>>;
};
LayerGroupSelectorFactory.deps = [PanelHeaderActionFactory];
diff --git a/src/components/side-panel/map-style-panel/map-style-selector.tsx b/src/components/side-panel/map-style-panel/map-style-selector.tsx
index 53d378241..f68abe4ae 100644
--- a/src/components/side-panel/map-style-panel/map-style-selector.tsx
+++ b/src/components/side-panel/map-style-panel/map-style-selector.tsx
@@ -18,7 +18,7 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
-import React from 'react';
+import React, {ComponentType} from 'react';
import styled from 'styled-components';
import classnames from 'classnames';
import {ArrowDown} from 'components/common/icons';
@@ -32,6 +32,7 @@ import {
} from 'components/common/styled-components';
import {FormattedMessage} from 'localization';
import {MapStyle} from 'reducers';
+import {BaseProps} from 'components/common/icons/base';
const StyledMapDropdown = styled(StyledPanelHeader)`
height: 48px;
@@ -67,9 +68,7 @@ type MapStyleSelectorProps = {
onChange: (payload: string) => void;
toggleActive: () => void;
isSelecting: boolean;
- actionIcons: {
- arrowDown?: typeof ArrowDown;
- };
+ actionIcons?: Record<string, ComponentType<Partial<BaseProps>>>;
};
MapStyleSelectorFactory.deps = [PanelHeaderActionFactory];
diff --git a/src/components/side-panel/panel-dropdown.js b/src/components/side-panel/panel-dropdown.tsx
similarity index 86%
rename from src/components/side-panel/panel-dropdown.js
rename to src/components/side-panel/panel-dropdown.tsx
index e6b5cc87a..d1b948387 100644
--- a/src/components/side-panel/panel-dropdown.js
+++ b/src/components/side-panel/panel-dropdown.tsx
@@ -19,24 +19,23 @@
// THE SOFTWARE.
import React, {Component} from 'react';
-import PropTypes from 'prop-types';
import {StyledPanelDropdown} from 'components/common/styled-components';
import listensToClickOutside from 'react-onclickoutside';
-class ClickOutsideCloseDropdown extends Component {
- static propTypes = {
- onClose: PropTypes.func,
- show: PropTypes.bool,
- type: PropTypes.string,
- className: PropTypes.string
- };
+type ClickOutsideCloseDropdownProps = {
+ show: boolean;
+ type: string;
+ className: string;
+ onClose: (e: Event) => void;
+};
+class ClickOutsideCloseDropdown extends Component<ClickOutsideCloseDropdownProps> {
static defaultProps = {
show: true,
type: 'dark'
};
- handleClickOutside = e => {
+ handleClickOutside = (e: Event) => {
if (typeof this.props.onClose === 'function' && this.props.show) {
this.props.onClose(e);
}
diff --git a/src/components/side-panel/panel-header-action.tsx b/src/components/side-panel/panel-header-action.tsx
index cc4ecffdb..c2aadcfd6 100644
--- a/src/components/side-panel/panel-header-action.tsx
+++ b/src/components/side-panel/panel-header-action.tsx
@@ -18,18 +18,31 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
-import React, {Component, ComponentType} from 'react';
+import React, {Component, ComponentType, MouseEventHandler} from 'react';
import classnames from 'classnames';
import styled from 'styled-components';
import {FormattedMessage} from 'localization';
import {Tooltip} from 'components/common/styled-components';
+import {BaseProps} from 'components/common/icons/base';
-interface HeaderActionWrapperProps {
+type PanelHeaderActionProps = {
+ id: string;
+ tooltip?: string;
+ hoverColor?: string;
+ tooltipType?: string;
+ className?: string;
+ active?: boolean;
+ flush?: boolean;
+ disabled?: boolean;
+ onClick: MouseEventHandler;
+ IconComponent: ComponentType<Partial<BaseProps>>;
+};
+
+type HeaderActionWrapperProps = {
flush?: boolean;
active?: boolean;
hoverColor?: boolean;
-}
-
+};
const HeaderActionWrapper = styled.div<HeaderActionWrapperProps>`
margin-left: ${props => (props.flush ? 0 : 8)}px;
@@ -50,26 +63,12 @@ const HeaderActionWrapper = styled.div<HeaderActionWrapperProps>`
}
`;
-interface PanelHeaderActionProps {
- id?: string;
- flush?: boolean;
- tooltip?: string;
- onClick?: Function;
- active?: boolean;
- disabled?: boolean;
- hoverColor?: string | null;
- className?: string;
- tooltipType?: string;
- IconComponent: any;
-}
-
-PanelHeaderActionFactory.deps = [];
// Need to use react class to access props.component
-export default function PanelHeaderActionFactory(): ComponentType<PanelHeaderActionProps> {
+export default function PanelHeaderActionFactory(): React.ComponentType<PanelHeaderActionProps> {
class PanelHeaderAction extends Component<PanelHeaderActionProps> {
static defaultProps = {
onClick: () => {},
- hoverColor: null,
+ hoverColor: '',
active: false
};
diff --git a/src/components/side-panel/panel-header.js b/src/components/side-panel/panel-header.tsx
similarity index 73%
rename from src/components/side-panel/panel-header.js
rename to src/components/side-panel/panel-header.tsx
index 32db4161f..ae226e231 100644
--- a/src/components/side-panel/panel-header.js
+++ b/src/components/side-panel/panel-header.tsx
@@ -20,15 +20,83 @@
import React, {Component} from 'react';
import styled from 'styled-components';
-import PropTypes from 'prop-types';
import {createSelector} from 'reselect';
import {Tooltip} from 'components/common/styled-components';
import KeplerGlLogo from 'components/common/logo';
import {Save, DataTable, Save2, Picture, Db, Map as MapIcon, Share} from 'components/common/icons';
import ClickOutsideCloseDropdown from 'components/side-panel/panel-dropdown';
import Toolbar from 'components/common/toolbar';
-import ToolbarItem from 'components/common/toolbar-item';
+import ToolbarItem, {ToolbarItemProps} from 'components/common/toolbar-item';
import {FormattedMessage} from 'localization';
+import {UiState} from 'reducers';
+import {BaseProps} from 'components/common/icons/base';
+
+type StyledPanelActionProps = {
+ active?: boolean;
+};
+
+type ActionItem = {
+ id: string;
+ label?: string;
+ blank?: boolean;
+ href?: string;
+ tooltip?: string;
+ iconComponent: React.ComponentType<Partial<BaseProps>>;
+ iconComponentProps?: BaseProps;
+ dropdownComponent?: React.ComponentType<DropdownComponentProps>;
+ onClick?: (p: PanelHeaderProps) => void;
+};
+
+type PanelActionProps = {
+ item: ActionItem;
+ onClick: () => void;
+};
+
+type PanelHeaderDropdownProps = {
+ id: string;
+ items: ToolbarItemProps[];
+ show?: boolean;
+ onClose: () => void;
+};
+
+type DropdownCallbacks = {
+ logoComponent?: React.ComponentType<{
+ appName: string;
+ appWebsite: string;
+ version: string;
+ }>;
+ onExportImage: () => void;
+ onExportData: () => void;
+ onExportConfig?: () => void;
+ onExportMap: () => void;
+ onSaveToStorage: (() => void) | null;
+ onSaveAsToStorage: (() => void) | null;
+ onSaveMap?: () => void;
+ onShareMap: (() => void) | null;
+};
+
+type Item = {
+ label: string;
+ icon: React.ComponentType<Partial<BaseProps>>;
+ key: string;
+ onClick: (p: DropdownComponentProps) => (() => void) | null;
+};
+
+type DropdownComponentProps = {
+ show: boolean;
+ onClose: () => void;
+ items?: Item[];
+} & DropdownCallbacks;
+
+type PanelHeaderProps = {
+ appName: string;
+ appWebsite: string;
+ version: string;
+ visibleDropdown: UiState['visibleDropdown'];
+ actionItems?: ActionItem[];
+ showExportDropdown: (i: string) => void;
+ hideExportDropdown: () => void;
+} & DropdownCallbacks;
const StyledPanelHeader = styled.div.attrs({
className: 'side-side-panel__header'
@@ -54,7 +122,7 @@ const StyledPanelTopActions = styled.div.attrs({
const StyledPanelAction = styled.div.attrs({
className: 'side-panel__panel-header__action'
-})`
+})<StyledPanelActionProps>`
align-items: center;
border-radius: 2px;
color: ${props => (props.active ? props.theme.textColorHl : props.theme.subtextColor)};
@@ -86,7 +154,7 @@ const StyledToolbar = styled(Toolbar)`
position: absolute;
`;
-export const PanelAction = ({item, onClick}) => (
+export const PanelAction: React.FC<PanelActionProps> = ({item, onClick}) => (
<StyledPanelAction data-tip data-for={`${item.id}-action`} onClick={onClick}>
{item.label ? <p>{item.label}</p> : null}
<a target={item.blank ? '_blank' : ''} href={item.href} rel="noreferrer">
@@ -101,7 +169,7 @@ export const PanelAction = ({item, onClick}) => (
);
export const PanelHeaderDropdownFactory = () => {
- const PanelHeaderDropdown = ({items, show, onClose, id}) => {
+ const PanelHeaderDropdown: React.FC<PanelHeaderDropdownProps> = ({items, show, onClose, id}) => {
return (
<StyledToolbar show={show} className={`${id}-dropdown`}>
<ClickOutsideCloseDropdown
@@ -129,9 +197,9 @@ export const PanelHeaderDropdownFactory = () => {
const getDropdownItemsSelector = () =>
createSelector(
- props => props,
+ (props: DropdownComponentProps) => props,
props =>
- props.items
+ (props.items || [])
.map(t => ({
...t,
onClick: t.onClick && t.onClick(props) ? t.onClick(props) : null
@@ -139,10 +207,12 @@ const getDropdownItemsSelector = () =>
.filter(l => l.onClick)
);
-export const SaveExportDropdownFactory = PanelHeaderDropdown => {
+export const SaveExportDropdownFactory = (
+ PanelHeaderDropdown: ReturnType<typeof PanelHeaderDropdownFactory>
+) => {
const dropdownItemsSelector = getDropdownItemsSelector();
- const SaveExportDropdown = props => (
+ const SaveExportDropdown: React.FC<DropdownComponentProps> = props => (
<PanelHeaderDropdown
items={dropdownItemsSelector(props)}
show={props.show}
@@ -175,7 +245,7 @@ export const SaveExportDropdownFactory = PanelHeaderDropdown => {
label: 'toolbar.saveMap',
icon: Save2,
key: 'save',
- onClick: props => props.onSaveMap
+ onClick: props => props.onSaveMap!
},
{
label: 'toolbar.shareMapURL',
@@ -190,10 +260,12 @@ export const SaveExportDropdownFactory = PanelHeaderDropdown => {
};
SaveExportDropdownFactory.deps = [PanelHeaderDropdownFactory];
-export const CloudStorageDropdownFactory = PanelHeaderDropdown => {
+export const CloudStorageDropdownFactory = (
+ PanelHeaderDropdown: ReturnType<typeof PanelHeaderDropdownFactory>
+) => {
const dropdownItemsSelector = getDropdownItemsSelector();
- const CloudStorageDropdown = props => (
+ const CloudStorageDropdown: React.FC<DropdownComponentProps> = props => (
<PanelHeaderDropdown
items={dropdownItemsSelector(props)}
show={props.show}
@@ -223,25 +295,11 @@ CloudStorageDropdownFactory.deps = [PanelHeaderDropdownFactory];
PanelHeaderFactory.deps = [SaveExportDropdownFactory, CloudStorageDropdownFactory];
-function PanelHeaderFactory(SaveExportDropdown, CloudStorageDropdown) {
- return class PanelHeader extends Component {
- static propTypes = {
- appName: PropTypes.string,
- appWebsite: PropTypes.string,
- version: PropTypes.string,
- visibleDropdown: PropTypes.string,
- logoComponent: PropTypes.oneOfType([PropTypes.element, PropTypes.func]),
- actionItems: PropTypes.arrayOf(PropTypes.any),
- onExportImage: PropTypes.func,
- onExportData: PropTypes.func,
- onExportConfig: PropTypes.func,
- onExportMap: PropTypes.func,
- onSaveToStorage: PropTypes.func,
- onSaveAsToStorage: PropTypes.func,
- onSaveMap: PropTypes.func,
- onShareMap: PropTypes.func
- };
-
+function PanelHeaderFactory(
+ SaveExportDropdown: ReturnType<typeof SaveExportDropdownFactory>,
+ CloudStorageDropdown: ReturnType<typeof CloudStorageDropdownFactory>
+): React.ComponentType<PanelHeaderProps> {
+ return class PanelHeader extends Component<PanelHeaderProps> {
static defaultProps = {
logoComponent: KeplerGlLogo,
actionItems: [
@@ -277,13 +335,19 @@ function PanelHeaderFactory(SaveExportDropdown, CloudStorageDropdown) {
// don't render cloud storage icon if onSaveToStorage is not provided
if (typeof this.props.onSaveToStorage !== 'function') {
- items = actionItems.filter(ai => ai.id !== 'storage');
+ items = items.filter(ai => ai.id !== 'storage');
}
return (
<StyledPanelHeader className="side-panel__panel-header">
<StyledPanelHeaderTop className="side-panel__panel-header__top">
- <this.props.logoComponent appName={appName} version={version} appWebsite={appWebsite} />
+ {this.props.logoComponent && (
+ <this.props.logoComponent
+ appName={appName}
+ version={version}
+ appWebsite={appWebsite}
+ />
+ )}
<StyledPanelTopActions>
{items.map(item => (
<div
diff --git a/src/components/side-panel/panel-tab.js b/src/components/side-panel/panel-tab.tsx
similarity index 85%
rename from src/components/side-panel/panel-tab.js
rename to src/components/side-panel/panel-tab.tsx
index 14d9743a2..403788884 100644
--- a/src/components/side-panel/panel-tab.js
+++ b/src/components/side-panel/panel-tab.tsx
@@ -22,10 +22,27 @@ import React from 'react';
import styled from 'styled-components';
import {Tooltip} from 'components/common/styled-components';
import {FormattedMessage} from 'localization';
+import {BaseProps} from 'components/common/icons/base';
+
+type StyledPanelTabProps = {
+ active?: boolean;
+};
+
+export type PanelItem = {
+ id: string;
+ label: string;
+ iconComponent: React.ComponentType<Partial<BaseProps>>;
+};
+
+type PanelTabProps = {
+ isActive: boolean;
+ panel: PanelItem;
+ onClick: () => void;
+};
export const StyledPanelTab = styled.div.attrs({
className: 'side-panel__tab'
-})`
+})<StyledPanelTabProps>`
align-items: flex-end;
border-bottom-style: solid;
border-bottom-width: 2px;
@@ -45,7 +62,7 @@ export const StyledPanelTab = styled.div.attrs({
`;
export function PanelTabFactory() {
- const PanelTab = ({isActive, onClick, panel}) => (
+ const PanelTab: React.FC<PanelTabProps> = ({isActive, onClick, panel}) => (
<StyledPanelTab data-tip data-for={`${panel.id}-nav`} active={isActive} onClick={onClick}>
<panel.iconComponent height="20px" />
<Tooltip id={`${panel.id}-nav`} effect="solid" delayShow={500} place="bottom">
diff --git a/src/components/side-panel/panel-title.js b/src/components/side-panel/panel-title.tsx
similarity index 100%
rename from src/components/side-panel/panel-title.js
rename to src/components/side-panel/panel-title.tsx
diff --git a/src/components/side-panel/panel-toggle.js b/src/components/side-panel/panel-toggle.tsx
similarity index 82%
rename from src/components/side-panel/panel-toggle.js
rename to src/components/side-panel/panel-toggle.tsx
index 25e1d269f..79768ec78 100644
--- a/src/components/side-panel/panel-toggle.js
+++ b/src/components/side-panel/panel-toggle.tsx
@@ -19,14 +19,15 @@
// THE SOFTWARE.
import React, {useCallback} from 'react';
-import PropTypes from 'prop-types';
import styled from 'styled-components';
-import PanelTabFactory from './panel-tab';
+import PanelTabFactory, {PanelItem} from './panel-tab';
+import {toggleSidePanel} from 'actions/ui-state-actions';
+import {ActionHandler} from 'actions';
-const propTypes = {
- panels: PropTypes.arrayOf(PropTypes.object),
- activePanel: PropTypes.string,
- togglePanel: PropTypes.func
+type PanelToggleProps = {
+ panels: PanelItem[];
+ activePanel: string;
+ togglePanel: ActionHandler<typeof toggleSidePanel>;
};
const PanelHeaderBottom = styled.div.attrs({
@@ -40,8 +41,9 @@ const PanelHeaderBottom = styled.div.attrs({
`;
PanelToggleFactory.deps = [PanelTabFactory];
-function PanelToggleFactory(PanelTab) {
- const PanelToggle = ({activePanel, panels, togglePanel}) => {
+
+function PanelToggleFactory(PanelTab: ReturnType<typeof PanelTabFactory>) {
+ const PanelToggle: React.FC<PanelToggleProps> = ({activePanel, panels, togglePanel}) => {
const onClick = useCallback(
panel => {
const callback = panel.onClick || togglePanel;
@@ -49,6 +51,7 @@ function PanelToggleFactory(PanelTab) {
},
[togglePanel]
);
+
return (
<PanelHeaderBottom>
{panels.map(panel => (
@@ -63,7 +66,6 @@ function PanelToggleFactory(PanelTab) {
);
};
- PanelToggle.propTypes = propTypes;
return PanelToggle;
}
diff --git a/src/components/side-panel/side-bar.js b/src/components/side-panel/side-bar.tsx
similarity index 90%
rename from src/components/side-panel/side-bar.js
rename to src/components/side-panel/side-bar.tsx
index 373058419..5fe9f48cf 100644
--- a/src/components/side-panel/side-bar.js
+++ b/src/components/side-panel/side-bar.tsx
@@ -19,10 +19,21 @@
// THE SOFTWARE.
import React, {Component} from 'react';
-import PropTypes from 'prop-types';
import styled from 'styled-components';
import {ArrowRight} from 'components/common/icons';
+type CollapseButtonProps = {
+ isOpen: boolean;
+ onClick: () => void;
+};
+
+type SideBarProps = {
+ width: number;
+ isOpen: boolean;
+ minifiedWidth: number;
+ onOpenOrClose: (v: {isOpen: boolean}) => void;
+};
+
const StyledSidePanelContainer = styled.div`
z-index: 99;
height: 100%;
@@ -81,7 +92,7 @@ const StyledCollapseButton = styled.div`
`;
export const CollapseButtonFactory = () => {
- const CollapseButton = ({onClick, isOpen}) => (
+ const CollapseButton = ({onClick, isOpen}: CollapseButtonProps) => (
<StyledCollapseButton className="side-bar__close" onClick={onClick}>
<ArrowRight height="12px" style={{transform: `rotate(${isOpen ? 180 : 0}deg)`}} />
</StyledCollapseButton>
@@ -91,15 +102,8 @@ export const CollapseButtonFactory = () => {
SidebarFactory.deps = [CollapseButtonFactory];
-function SidebarFactory(CollapseButton) {
- return class SideBar extends Component {
- static propTypes = {
- width: PropTypes.number,
- isOpen: PropTypes.bool,
- minifiedWidth: PropTypes.number,
- onOpenOrClose: PropTypes.func
- };
-
+function SidebarFactory(CollapseButton: ReturnType<typeof CollapseButtonFactory>) {
+ return class SideBar extends Component<SideBarProps> {
static defaultProps = {
width: 300,
minifiedWidth: 0,
diff --git a/src/components/types.ts b/src/components/types.ts
new file mode 100644
index 000000000..e7fc1ad16
--- /dev/null
+++ b/src/components/types.ts
@@ -0,0 +1,41 @@
+import {ComponentType} from 'react';
+import {Datasets, Filter, InteractionConfig, MapStyle} from '../reducers';
+import {Layer, LayerClassesType} from '../layers';
+import {UiState} from 'reducers/ui-state-updaters';
+
+import * as MapStyleActions from 'actions/map-style-actions';
+import * as VisStateActions from 'actions/vis-state-actions';
+import * as MapStateActions from 'actions/map-state-actions';
+import * as UIStateActions from 'actions/ui-state-actions';
+
+export type SidePanelItem = {
+ id: string;
+ label: string;
+ iconComponent: ComponentType<any>;
+ component?: ComponentType<any>;
+};
+
+export type SidePanelProps = {
+ appName: string;
+ appWebsite: string;
+ filters: Filter[];
+ interactionConfig: InteractionConfig;
+ layerBlending: string;
+ layers: Layer[];
+ layerClasses: LayerClassesType;
+ layerOrder: number[];
+ mapStyle: MapStyle;
+ onSaveMap?: () => void;
+ width: number;
+ mapInfo: {title: string; description: string};
+ datasets: Datasets;
+ uiStateActions: typeof UIStateActions;
+ visStateActions: typeof VisStateActions;
+ mapStateActions: typeof MapStateActions;
+ mapStyleActions: typeof MapStyleActions;
+ uiState: UiState;
+ availableProviders: {hasShare: boolean; hasStorage: boolean};
+ mapSaved?: string | null;
+ panels: SidePanelItem[];
+ version: string;
+};
diff --git a/src/layers/aggregation-layer.ts b/src/layers/aggregation-layer.ts
index 8c446c916..3c6bc5046 100644
--- a/src/layers/aggregation-layer.ts
+++ b/src/layers/aggregation-layer.ts
@@ -239,8 +239,12 @@ export default class AggregationLayer extends Layer {
getScaleOptions(channel: string): string[] {
const visualChannel = this.visualChannels[channel];
const {field, aggregation, channelScaleType} = visualChannel;
- // @ts-expect-error
- const aggregationType = this.config.visConfig[aggregation];
+ const aggregationType = aggregation ? this.config.visConfig[aggregation] : null;
+
+ if (!aggregationType) {
+ return [];
+ }
+
return this.config[field]
? // scale options based on aggregation
FIELD_OPTS[this.config[field].type].scale[channelScaleType][aggregationType]