Skip to content

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

fix(ui): move refresh settings to dataset context menu (#3808)

Igor Dykhtadf483b7f8ef1
diff --git a/src/components/src/side-panel/common/dataset-title.tsx b/src/components/src/side-panel/common/dataset-title.tsx
index 0bab0c8d5..932a6c2de 100644
--- a/src/components/src/side-panel/common/dataset-title.tsx
+++ b/src/components/src/side-panel/common/dataset-title.tsx
@@ -3,13 +3,11 @@
import React, {useCallback, useRef, useState} from 'react';
import styled from 'styled-components';
-import {useIntl} from 'react-intl';
import {FormattedMessage} from '@kepler.gl/localization';
import {Table} from '@kepler.gl/layers';
import {Tooltip} from '../../common/styled-components';
-import {Clock, WarningSign} from '../../common/icons';
-import {DatasetType} from '@kepler.gl/constants';
+import {WarningSign} from '../../common/icons';
import DatasetTagFactory from './dataset-tag';
import CustomPicker from '../layer-panel/custom-picker';
import {Portaled} from '../..';
@@ -82,27 +80,6 @@ const DataTagAction = styled.div<{$alwaysVisible?: boolean}>`
opacity: ${props => (props.$alwaysVisible ? 1 : 0)};
`;
-const DataTagActionButton = styled.button`
- display: inline-flex;
- align-items: center;
- justify-content: center;
- margin-left: 12px;
- width: 16px;
- height: 16px;
- padding: 0;
- border: 0;
- background: transparent;
- color: inherit;
- cursor: pointer;
- opacity: 0;
-
- &:focus-visible {
- opacity: 1;
- outline: 1px solid ${props => props.theme.textColorHl};
- outline-offset: 1px;
- }
-`;
-
const StyledRefreshError = styled.div`
display: inline-flex;
align-items: center;
@@ -131,6 +108,7 @@ export type DatasetTitleProps = {
updateTableColor: ActionHandler<typeof VisStateActions.updateTableColor>;
removeDataset?: ActionHandler<typeof openDeleteModal>;
onToggleRefreshSettings?: () => void;
+ refreshSettingsOpen?: boolean;
addGroupBy?: ActionHandler<typeof VisStateActions.addGroupBy>;
addJoin?: ActionHandler<typeof VisStateActions.addJoin>;
addSpatialJoin?: ActionHandler<typeof VisStateActions.addSpatialJoin>;
@@ -160,30 +138,6 @@ const ShowDataTable = ({id, showDatasetTable}: ShowDataTableProps) => (
</DataTagAction>
);
-const RefreshDatasetSettings = ({id, onToggle}: {id: string; onToggle?: () => void}) => {
- const intl = useIntl();
- return (
- <DataTagActionButton
- type="button"
- className="dataset-action refresh-dataset-settings"
- data-tip
- data-for={`refresh-settings-${id}`}
- aria-label={intl.formatMessage({id: 'datasetTitle.refreshSettings'})}
- onClick={e => {
- e.stopPropagation();
- onToggle?.();
- }}
- >
- <Clock height="16px" />
- <Tooltip id={`refresh-settings-${id}`} effect="solid">
- <span>
- <FormattedMessage id={'datasetTitle.refreshSettings'} />
- </span>
- </Tooltip>
- </DataTagActionButton>
- );
-};
-
const RefreshErrorIcon = ({id, message}: {id: string; message: string}) => (
<StyledRefreshError
className="dataset-refresh-error"
@@ -222,6 +176,7 @@ export default function DatasetTitleFactory(
dataset,
updateTableColor,
onToggleRefreshSettings,
+ refreshSettingsOpen,
addGroupBy,
addJoin,
addSpatialJoin,
@@ -262,7 +217,6 @@ export default function DatasetTitleFactory(
[onTitleClick, showDatasetTable, datasetId, dataset.disableDataOperation]
);
- const isRemote = dataset.type === DatasetType.EXTERNALLY_HOSTED;
const refreshError = dataset.metadata?.refreshError;
return (
@@ -304,10 +258,9 @@ export default function DatasetTitleFactory(
replaceDataset={replaceDataset}
showDeleteDataset={showDeleteDataset}
removeDataset={removeDataset}
+ onToggleRefreshSettings={onToggleRefreshSettings}
+ refreshSettingsOpen={refreshSettingsOpen}
/>
- {onToggleRefreshSettings && isRemote ? (
- <RefreshDatasetSettings id={datasetId} onToggle={onToggleRefreshSettings} />
- ) : null}
</DatasetAction>
</StyledDatasetTitle>
</DatasetTitleRoot>
diff --git a/src/components/src/side-panel/common/source-data-catalog.tsx b/src/components/src/side-panel/common/source-data-catalog.tsx
index 7ef492de4..d7a740eb7 100644
--- a/src/components/src/side-panel/common/source-data-catalog.tsx
+++ b/src/components/src/side-panel/common/source-data-catalog.tsx
@@ -101,6 +101,7 @@ function SourceDataCatalogFactory(
addSpatialJoin={addSpatialJoin}
addSuitability={addSuitability}
replaceDataset={replaceDataset}
+ refreshSettingsOpen={showRefreshSettings}
onToggleRefreshSettings={
(refreshDataset || updateDatasetProps) &&
dataset.type === DatasetType.EXTERNALLY_HOSTED
diff --git a/src/components/src/side-panel/dataset-ops/dataset-ops-menu.spec.tsx b/src/components/src/side-panel/dataset-ops/dataset-ops-menu.spec.tsx
index 6ca521aeb..3c4e09e42 100644
--- a/src/components/src/side-panel/dataset-ops/dataset-ops-menu.spec.tsx
+++ b/src/components/src/side-panel/dataset-ops/dataset-ops-menu.spec.tsx
@@ -184,7 +184,7 @@ describe('DatasetOpsMenu', () => {
expect(removeDataset).toHaveBeenCalledWith('tiles');
});
- test('hides menu for vector tiles and when ops are disabled', () => {
+ test('hides menu when a dataset has no actions', () => {
const {container: tiles} = renderWithTheme(
<DatasetOpsMenu
datasetId="tiles"
@@ -207,9 +207,12 @@ describe('DatasetOpsMenu', () => {
/>
);
expect(disabled.querySelector('.dataset-ops-menu__toggle')).toBeNull();
+ });
+ test('keeps remove inside the overflow menu when dataset ops are disabled', () => {
+ initApplicationConfig({enableDatasetOps: false});
const removeDataset = jest.fn();
- const {container: deleteOnly} = renderWithTheme(
+ const {container} = renderWithTheme(
<DatasetOpsMenu
datasetId="cities"
dataset={{type: 'local'}}
@@ -220,11 +223,51 @@ describe('DatasetOpsMenu', () => {
removeDataset={removeDataset}
/>
);
- expect(deleteOnly.querySelector('.dataset-ops-menu__toggle')).toBeNull();
+
+ expect(container.querySelector('.dataset-ops-menu__remove')).toBeNull();
+ fireEvent.click(container.querySelector('.dataset-ops-menu__toggle') as HTMLElement);
expect(document.querySelector('.dataset-ops-menu__group-by')).toBeNull();
- fireEvent.click(deleteOnly.querySelector('.dataset-ops-menu__remove') as HTMLElement);
+ fireEvent.click(document.querySelector('.dataset-ops-menu__remove') as HTMLButtonElement);
expect(removeDataset).toHaveBeenCalledWith('cities');
});
+
+ test('opens refresh settings from the menu for remote datasets', () => {
+ const onToggleRefreshSettings = jest.fn();
+ const {container} = renderWithTheme(
+ <DatasetOpsMenu
+ datasetId="live"
+ dataset={{type: 'externally-hosted'}}
+ onToggleRefreshSettings={onToggleRefreshSettings}
+ refreshSettingsOpen
+ showDeleteDataset
+ removeDataset={jest.fn()}
+ />
+ );
+
+ fireEvent.click(container.querySelector('.dataset-ops-menu__toggle') as HTMLElement);
+ const refresh = document.querySelector(
+ '.dataset-ops-menu__refresh-settings'
+ ) as HTMLButtonElement;
+ expect(refresh).toBeTruthy();
+ expect(document.querySelector('.dataset-ops-menu__replace')).toBeNull();
+ fireEvent.click(refresh);
+ expect(onToggleRefreshSettings).toHaveBeenCalled();
+ });
+
+ test('hides refresh settings for local datasets', () => {
+ const {container} = renderWithTheme(
+ <DatasetOpsMenu
+ datasetId="cities"
+ dataset={{type: 'local'}}
+ addGroupBy={jest.fn()}
+ onToggleRefreshSettings={jest.fn()}
+ />
+ );
+
+ fireEvent.click(container.querySelector('.dataset-ops-menu__toggle') as HTMLElement);
+ expect(document.querySelector('.dataset-ops-menu__refresh-settings')).toBeNull();
+ expect(document.querySelector('.dataset-ops-menu__group-by')).toBeTruthy();
+ });
});
describe('GroupByPanel field selection', () => {
diff --git a/src/components/src/side-panel/dataset-ops/dataset-ops-menu.tsx b/src/components/src/side-panel/dataset-ops/dataset-ops-menu.tsx
index bf97f3b52..69754bb7c 100644
--- a/src/components/src/side-panel/dataset-ops/dataset-ops-menu.tsx
+++ b/src/components/src/side-panel/dataset-ops/dataset-ops-menu.tsx
@@ -4,6 +4,7 @@
import React, {useCallback, useState} from 'react';
import {useIntl} from 'react-intl';
import {FormattedMessage} from '@kepler.gl/localization';
+import {DatasetType} from '@kepler.gl/constants';
import {getApplicationConfig} from '@kepler.gl/utils';
import {isTabularDatasetForOps} from '@kepler.gl/table';
import {
@@ -14,6 +15,7 @@ import {
} from '@kepler.gl/actions';
import {
+ Clock,
Grouping,
Join,
Overflow,
@@ -45,6 +47,8 @@ export type DatasetOpsMenuProps = {
replaceDataset?: ActionHandler<typeof openReplaceDatasetModal>;
showDeleteDataset?: boolean;
removeDataset?: ActionHandler<typeof openDeleteModal>;
+ onToggleRefreshSettings?: () => void;
+ refreshSettingsOpen?: boolean;
};
export function DatasetOpsMenu({
@@ -56,7 +60,9 @@ export function DatasetOpsMenu({
addSuitability,
replaceDataset,
showDeleteDataset,
- removeDataset
+ removeDataset,
+ onToggleRefreshSettings,
+ refreshSettingsOpen
}: DatasetOpsMenuProps) {
const intl = useIntl();
const [open, setOpen] = useState(false);
@@ -67,6 +73,8 @@ export function DatasetOpsMenu({
const showOps =
opsEnabled && tabular && Boolean(addGroupBy || addJoin || addSpatialJoin || addSuitability);
const showRemove = Boolean(showDeleteDataset && removeDataset);
+ const showRefresh =
+ dataset.type === DatasetType.EXTERNALLY_HOSTED && Boolean(onToggleRefreshSettings);
const tooltipId = `dataset-ops-${datasetId}`;
const tooltipLabel = intl.formatMessage({id: 'datasetTitle.moreSettings'});
@@ -78,36 +86,24 @@ export function DatasetOpsMenu({
[datasetId]
);
- if (!showOps && !showReplace && !showRemove) {
+ if (!showOps && !showReplace && !showRemove && !showRefresh) {
return null;
}
- if (!opsEnabled && showRemove) {
- const removeTooltipId = `remove-dataset-${datasetId}`;
- const removeLabel = intl.formatMessage({id: 'datasetTitle.removeDataset'});
- return (
- <ContextMenuToggle
- className="dataset-action dataset-ops-menu__remove"
- data-tip
- data-for={removeTooltipId}
- role="button"
- aria-label={removeLabel}
- onClick={e => {
- e.stopPropagation();
- removeDataset?.(datasetId);
- }}
- >
- <Trash height="16px" />
- <Tooltip id={removeTooltipId} effect="solid">
- <span>
- <FormattedMessage id="datasetTitle.removeDataset" />
- </span>
- </Tooltip>
- </ContextMenuToggle>
- );
- }
-
const opItems: ContextMenuAction[] = [];
+ if (showRefresh && onToggleRefreshSettings) {
+ opItems.push({
+ className: 'dataset-ops-menu__refresh-settings',
+ labelId: 'datasetTitle.refreshSettings',
+ Icon: Clock,
+ iconHeight: '16px',
+ active: refreshSettingsOpen,
+ onClick: () => {
+ onToggleRefreshSettings();
+ setOpen(false);
+ }
+ });
+ }
if (showReplace && replaceDataset) {
opItems.push({
className: 'dataset-ops-menu__replace',