Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
feat(ui): show layer actions in a context menu (#3793)
Igor Dykhta7f30a3fac39b
diff --git a/src/components/src/common/context-menu.tsx b/src/components/src/common/context-menu.tsxnew file mode 100644index 000000000..dc65be721--- /dev/null+++ b/src/components/src/common/context-menu.tsx@@ -0,0 +1,142 @@+// SPDX-License-Identifier: MIT+// Copyright contributors to the kepler.gl project++import React from 'react';+import styled, {css} from 'styled-components';+import {FormattedMessage} from '@kepler.gl/localization';++import {BaseProps} from './icons';++export const ContextMenuToggle = styled.div`+ margin-left: 8px;+ width: 16px;+ height: 16px;+ flex-shrink: 0;+ color: ${props => props.theme.panelHeaderIcon};+ cursor: pointer;++ &:hover {+ color: ${props => props.theme.panelHeaderIconHover};+ }+`;++export const ContextMenuAnchor = styled.div`+ position: absolute;+ top: 0;+ right: 0;+ width: 0;+ height: 16px;+ pointer-events: none;+`;++export const ContextMenu = styled.div`+ min-width: 160px;+ width: max-content;+ background: ${props => props.theme.dropdownListBgd};+ box-shadow: ${props => props.theme.tooltipBoxShadow};+ border-radius: 4px;+ overflow: hidden;+`;++const ContextMenuItemIcon = styled.span`+ display: flex;+ align-items: center;+ justify-content: center;+ width: 18px;+ height: 18px;+ margin-right: 6px;+ flex-shrink: 0;+ color: ${props => props.theme.subtextColor};+`;++const ContextMenuItem = styled.button<{$active?: boolean; $destructive?: boolean}>`+ display: flex;+ align-items: center;+ width: 100%;+ height: 32px;+ padding: 0 8px;+ border: 0;+ background: transparent;+ color: ${props => (props.$active ? props.theme.textColorHl : props.theme.textColor)};+ text-align: left;+ cursor: pointer;+ font-size: 12px;+ line-height: 18px;+ white-space: nowrap;++ &:hover {+ background: ${props => props.theme.dropdownListHighlightBg};+ ${props =>+ props.$destructive+ ? css`+ color: ${props.theme.errorColor};++ ${ContextMenuItemIcon} {+ color: ${props.theme.errorColor};+ }+ `+ : ''}+ }++ &:disabled {+ opacity: 0.3;+ cursor: default;+ pointer-events: none;+ }+`;++export const ContextMenuSeparator = styled.div`+ border-top: 1px solid ${props => props.theme.dropdownListHighlightBg};+`;++export type ContextMenuAction = {+ className: string;+ labelId: string;+ Icon: React.ComponentType<Partial<BaseProps>>;+ iconHeight: string;+ onClick: (event: React.MouseEvent<HTMLButtonElement>) => void;+ disabled?: boolean;+ active?: boolean;+ destructive?: boolean;+};++export function ContextMenuActionButton({action}: {action: ContextMenuAction}) {+ return (+ <ContextMenuItem+ className={action.className}+ type="button"+ disabled={action.disabled}+ $active={action.active}+ $destructive={action.destructive}+ onClick={event => {+ event.stopPropagation();+ action.onClick(event);+ }}+ >+ <ContextMenuItemIcon>+ <action.Icon height={action.iconHeight} />+ </ContextMenuItemIcon>+ <FormattedMessage id={action.labelId} />+ </ContextMenuItem>+ );+}++export function ContextMenuList({+ items,+ footer,+ className+}: {+ items: ContextMenuAction[];+ footer?: ContextMenuAction | null;+ className?: string;+}) {+ return (+ <ContextMenu className={className}>+ {items.map(item => (+ <ContextMenuActionButton key={item.className} action={item} />+ ))}+ {items.length > 0 && footer ? <ContextMenuSeparator /> : null}+ {footer ? <ContextMenuActionButton action={footer} /> : null}+ </ContextMenu>+ );+}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.tsxindex 2058d60b4..e733d1986 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@@ -2,7 +2,6 @@// Copyright contributors to the kepler.gl projectimport React, {useCallback, useState} from 'react';-import styled from 'styled-components';import {useIntl} from 'react-intl';import {FormattedMessage} from '@kepler.gl/localization';import {getApplicationConfig} from '@kepler.gl/utils';@@ -14,83 +13,15 @@ import {openReplaceDatasetModal} from '@kepler.gl/actions';-import {BaseProps, Grouping, Join, Overflow, Replace, SpatialJoin, Trash} from '../../common/icons';+import {Grouping, Join, Overflow, Replace, SpatialJoin, Trash} from '../../common/icons';import {Tooltip} from '../../common/styled-components';import Portaled from '../../common/portaled';--const MenuToggle = styled.div`- margin-left: 8px;- width: 16px;- height: 16px;- flex-shrink: 0;- color: ${props => props.theme.panelHeaderIcon};- cursor: pointer;-- &:hover {- color: ${props => props.theme.panelHeaderIconHover};- }-`;--const PortalAnchor = styled.div`- position: absolute;- top: 0;- right: 0;- width: 0;- height: 16px;- pointer-events: none;-`;--const Menu = styled.div`- min-width: 160px;- width: max-content;- background: ${props => props.theme.dropdownListBgd};- box-shadow: ${props => props.theme.tooltipBoxShadow};- border-radius: 4px;- overflow: hidden;-`;--const MenuItem = styled.button`- display: flex;- align-items: center;- width: 100%;- height: 32px;- padding: 0 8px;- border: 0;- background: transparent;- color: ${props => props.theme.textColor};- text-align: left;- cursor: pointer;- font-size: 12px;- line-height: 18px;- white-space: nowrap;-- &:hover {- background: ${props => props.theme.dropdownListHighlightBg};- }-`;--const MenuItemIcon = styled.span`- display: flex;- align-items: center;- justify-content: center;- width: 18px;- height: 18px;- margin-right: 6px;- flex-shrink: 0;- color: ${props => props.theme.subtextColor};-`;--const MenuSeparator = styled.div`- border-top: 1px solid ${props => props.theme.dropdownListHighlightBg};-`;--type MenuAction = {- className: string;- labelId: string;- Icon: React.ComponentType<Partial<BaseProps>>;- iconHeight: string;- onClick: () => void;-};+import {+ ContextMenuAction,+ ContextMenuAnchor,+ ContextMenuList,+ ContextMenuToggle+} from '../../common/context-menu';export type DatasetOpsMenuProps = {datasetId: string;@@ -144,7 +75,7 @@ export function DatasetOpsMenu({const removeTooltipId = `remove-dataset-${datasetId}`;const removeLabel = intl.formatMessage({id: 'datasetTitle.removeDataset'});return (- <MenuToggle+ <ContextMenuToggleclassName="dataset-action dataset-ops-menu__remove"data-tipdata-for={removeTooltipId}@@ -161,11 +92,11 @@ export function DatasetOpsMenu({<FormattedMessage id="datasetTitle.removeDataset" /></span></Tooltip>- </MenuToggle>+ </ContextMenuToggle>);}- const opItems: MenuAction[] = [];+ const opItems: ContextMenuAction[] = [];if (showReplace && replaceDataset) {opItems.push({className: 'dataset-ops-menu__replace',@@ -205,7 +136,7 @@ export function DatasetOpsMenu({return (<>- <MenuToggle+ <ContextMenuToggleclassName="dataset-action dataset-ops-menu dataset-ops-menu__toggle"data-tipdata-for={tooltipId}@@ -222,42 +153,28 @@ export function DatasetOpsMenu({<FormattedMessage id="datasetTitle.moreSettings" /></span></Tooltip>- </MenuToggle>+ </ContextMenuToggle><Portaled- component={PortalAnchor}+ component={ContextMenuAnchor}isOpened={open}left={0}top={0}onClose={() => setOpen(false)}>- <Menu>- {opItems.map(item => (- <MenuItem- key={item.className}- className={item.className}- type="button"- onClick={item.onClick}- >- <MenuItemIcon>- <item.Icon height={item.iconHeight} />- </MenuItemIcon>- <FormattedMessage id={item.labelId} />- </MenuItem>- ))}- {opItems.length > 0 && showRemove ? <MenuSeparator /> : null}- {showRemove ? (- <MenuItem- className="dataset-ops-menu__remove"- type="button"- onClick={() => onSelect(removeDataset)}- >- <MenuItemIcon>- <Trash height="16px" />- </MenuItemIcon>- <FormattedMessage id="datasetTitle.removeDataset" />- </MenuItem>- ) : null}- </Menu>+ <ContextMenuList+ items={opItems}+ footer={+ showRemove+ ? {+ className: 'dataset-ops-menu__remove',+ labelId: 'datasetTitle.removeDataset',+ Icon: Trash,+ iconHeight: '16px',+ onClick: () => onSelect(removeDataset)+ }+ : null+ }+ /></Portaled></>);diff --git a/src/components/src/side-panel/layer-panel/layer-panel-header.spec.tsx b/src/components/src/side-panel/layer-panel/layer-panel-header.spec.tsxnew file mode 100644index 000000000..cbefdf0bb--- /dev/null+++ b/src/components/src/side-panel/layer-panel/layer-panel-header.spec.tsx@@ -0,0 +1,124 @@+// SPDX-License-Identifier: MIT+// Copyright contributors to the kepler.gl project++import React from 'react';+import {fireEvent} from '@testing-library/react';++import {renderWithTheme} from 'test/helpers/component-jest-utils';+import PanelHeaderActionFactory from '../panel-header-action';+import LayerPanelHeaderFactory, {+ LayerPanelHeaderActionSectionFactory,+ LayerPanelHeaderProps,+ LayerTitleSectionFactory+} from './layer-panel-header';++const LayerPanelHeader = LayerPanelHeaderFactory(+ LayerTitleSectionFactory(),+ LayerPanelHeaderActionSectionFactory(PanelHeaderActionFactory())+);++const noop = jest.fn();++function renderHeader(+ overrides: Partial<+ Pick<LayerPanelHeaderProps, 'allowDuplicate' | 'showJsonEditor' | 'showRemoveLayer'>+ > = {}+) {+ const onToggleEnableConfig = jest.fn();+ const onRemoveLayer = jest.fn();+ const onDuplicateLayer = jest.fn();+ const onZoomToLayer = jest.fn();+ const onToggleJsonEditor = jest.fn();+ const view = renderWithTheme(+ <LayerPanelHeader+ layerId="taro"+ isVisible={true}+ isValid={true}+ isConfigActive={false}+ label="Taro"+ allowDuplicate={true}+ onToggleVisibility={noop}+ onUpdateLayerLabel={noop}+ onResetIsValid={noop}+ onToggleEnableConfig={onToggleEnableConfig}+ onRemoveLayer={onRemoveLayer}+ onDuplicateLayer={onDuplicateLayer}+ onZoomToLayer={onZoomToLayer}+ onToggleJsonEditor={onToggleJsonEditor}+ {...overrides}+ />+ );++ return {+ ...view,+ onToggleEnableConfig,+ onRemoveLayer,+ onDuplicateLayer,+ onZoomToLayer,+ onToggleJsonEditor+ };+}++function openOptions(container: HTMLElement) {+ fireEvent.click(container.querySelector('.layer__options-toggle svg') as SVGElement);+}++describe('LayerPanelHeader options menu', () => {+ test('keeps visibility and settings visible and moves other actions into the menu', () => {+ const {container, onZoomToLayer, onDuplicateLayer, onRemoveLayer, onToggleJsonEditor} =+ renderHeader({showJsonEditor: true});++ expect(container.querySelector('.layer__visibility-toggle')).not.toBeNull();+ expect(container.querySelector('.layer__enable-config')).not.toBeNull();+ expect(container.querySelector('.layer__options-toggle')).not.toBeNull();+ expect(document.querySelector('.layer__zoom-to-layer')).toBeNull();+ expect(document.querySelector('.layer__duplicate')).toBeNull();+ expect(document.querySelector('.layer__remove-layer')).toBeNull();+ expect(document.querySelector('.layer__json-editor')).toBeNull();++ openOptions(container);++ fireEvent.click(document.querySelector('.layer__zoom-to-layer') as HTMLButtonElement);+ expect(onZoomToLayer).toHaveBeenCalledTimes(1);+ expect(document.querySelector('.layer-options-menu')).toBeNull();++ openOptions(container);+ fireEvent.click(document.querySelector('.layer__duplicate') as HTMLButtonElement);+ expect(onDuplicateLayer).toHaveBeenCalledTimes(1);++ openOptions(container);+ fireEvent.click(document.querySelector('.layer__json-editor') as HTMLButtonElement);+ expect(onToggleJsonEditor).toHaveBeenCalledTimes(1);++ openOptions(container);+ fireEvent.click(document.querySelector('.layer__remove-layer') as HTMLButtonElement);+ expect(onRemoveLayer).toHaveBeenCalledTimes(1);+ });++ test('does not toggle the layer configurator when opening the menu', () => {+ const {container, onToggleEnableConfig} = renderHeader();++ openOptions(container);+ expect(onToggleEnableConfig).not.toHaveBeenCalled();+ expect(document.querySelector('.layer__zoom-to-layer')).not.toBeNull();++ fireEvent.click(container.querySelector('.layer__title') as HTMLElement);+ expect(onToggleEnableConfig).toHaveBeenCalledTimes(1);+ });++ test('disables duplicate and hides optional actions', () => {+ const {container, onDuplicateLayer} = renderHeader({+ allowDuplicate: false,+ showJsonEditor: false,+ showRemoveLayer: false+ });++ openOptions(container);+ const duplicate = document.querySelector('.layer__duplicate') as HTMLButtonElement;+ expect(duplicate.disabled).toBe(true);+ fireEvent.click(duplicate);+ expect(onDuplicateLayer).not.toHaveBeenCalled();+ expect(document.querySelector('.layer__json-editor')).toBeNull();+ expect(document.querySelector('.layer__remove-layer')).toBeNull();+ });+});diff --git a/src/components/src/side-panel/layer-panel/layer-panel-header.tsx b/src/components/src/side-panel/layer-panel/layer-panel-header.tsxindex d24c064db..3844c7741 100644--- a/src/components/src/side-panel/layer-panel/layer-panel-header.tsx+++ b/src/components/src/side-panel/layer-panel/layer-panel-header.tsx@@ -22,8 +22,11 @@ import {WarningSign,Reset,ZoomIn,- CodeAlt+ CodeAlt,+ Overflow} from '../../common/icons';+import Portaled from '../../common/portaled';+import {ContextMenuAction, ContextMenuList} from '../../common/context-menu';import {InlineInput, StyledPanelHeader} from '../../common/styled-components';import {FormattedMessage} from '@kepler.gl/localization';@@ -80,6 +83,7 @@ export type LayerPanelHeaderProps = {duplicate: ComponentType<Partial<BaseProps>>;crosshairs: ComponentType<Partial<BaseProps>>;json?: ComponentType<Partial<BaseProps>>;+ more?: ComponentType<Partial<BaseProps>>;};listeners?: React.ElementType;};@@ -101,10 +105,6 @@ const StyledLayerPanelHeader = styled(StyledPanelHeader)`position: relative;align-items: stretch;- .layer__remove-layer {- opacity: 0;- }-.layer__drag-handle__placeholder {height: 20px;padding: 10px;@@ -119,10 +119,6 @@ const StyledLayerPanelHeader = styled(StyledPanelHeader)`.layer__drag-handle {opacity: 1;}-- .layer__remove-layer {- opacity: 1;- }}`;@@ -131,8 +127,8 @@ const HeaderLabelSection = styled.div`color: ${props => props.theme.textColor};flex-grow: 1;align-items: stretch;- // leave space for eye and collapse icons- padding-right: 50px;+ // leave space for options, eye, and collapse icons+ padding-right: 74px;`;const HeaderActionSection = styled.div.withConfig({shouldForwardProp})<HeaderActionSectionProps>`@@ -142,34 +138,6 @@ const HeaderActionSection = styled.div.withConfig({shouldForwardProp})<HeaderActalign-items: stretch;right: 10px;pointer-events: ${props => (props.isEditingLabel ? 'none' : 'all')};- &:hover {- .layer-panel__header__actions__hidden {- opacity: 1;- background-color: ${props => props.theme.panelBackgroundHover};- }- }-`;--type StyledPanelHeaderHiddenActionsProps = {- isConfigActive: LayerPanelHeaderProps['isConfigActive'];-};--// Hiden actions only show up on hover-const StyledPanelHeaderHiddenActions = styled.div.withConfig({shouldForwardProp}).attrs({- className: 'layer-panel__header__actions__hidden'-})<StyledPanelHeaderHiddenActionsProps>`- opacity: 0;- display: flex;- align-items: center;- background-color: ${props =>- props.isConfigActive ? props.theme.panelBackgroundHover : props.theme.panelBackground};- transition:- opacity 0.4s ease,- background-color 0.4s ease;-- &:hover {- opacity: 1;- }`;const StyledDragHandle = styled.div`@@ -291,48 +259,71 @@ export function LayerPanelHeaderActionSectionFactory(isEditingLabel,actionIcons: customActionIcons} = props;+ const [isOptionsOpen, setIsOptionsOpen] = useState(false);// Merge custom actionIcons with defaults to avoid breaking changesconst actionIcons = {...defaultActionIcons, ...customActionIcons};+ const selectAction =+ (handler?: MouseEventHandler) => (event: MouseEvent<HTMLButtonElement>) => {+ handler?.(event);+ setIsOptionsOpen(false);+ };+ const optionItems: ContextMenuAction[] = [+ {+ className: 'layer__zoom-to-layer',+ labelId: 'tooltip.zoomToLayer',+ Icon: actionIcons.crosshairs,+ iconHeight: '14px',+ onClick: selectAction(onZoomToLayer)+ },+ {+ className: 'layer__duplicate',+ labelId: 'tooltip.duplicateLayer',+ Icon: actionIcons.duplicate,+ iconHeight: '14px',+ disabled: !allowDuplicate,+ onClick: selectAction(onDuplicateLayer)+ }+ ];+ if (showJsonEditor && onToggleJsonEditor) {+ optionItems.push({+ className: 'layer__json-editor',+ labelId: 'tooltip.editLayerJson',+ Icon: actionIcons.json || CodeAlt,+ iconHeight: '14px',+ active: Boolean(isJsonEditorActive),+ onClick: selectAction(onToggleJsonEditor)+ });+ }+ const removeAction: ContextMenuAction | null = showRemoveLayer+ ? {+ className: 'layer__remove-layer',+ labelId: 'tooltip.removeLayer',+ Icon: actionIcons.remove,+ iconHeight: '16px',+ destructive: true,+ onClick: selectAction(onRemoveLayer)+ }+ : null;return (<HeaderActionSection className="layer-panel__header__actions" isEditingLabel={isEditingLabel}>- <StyledPanelHeaderHiddenActions isConfigActive={isConfigActive}>- {showRemoveLayer ? (- <PanelHeaderAction- className="layer__remove-layer"- testId="remove-layer-action"- id={layerId}- tooltip={'tooltip.removeLayer'}- onClick={onRemoveLayer}- tooltipType="error"- IconComponent={actionIcons.remove}- />- ) : null}- <PanelHeaderAction- className="layer__duplicate"- id={layerId}- tooltip={'tooltip.duplicateLayer'}- onClick={onDuplicateLayer}- IconComponent={actionIcons.duplicate}- disabled={!allowDuplicate}- />- <PanelHeaderAction- className="layer__zoom-to-layer"- id={layerId}- tooltip={'tooltip.zoomToLayer'}- onClick={onZoomToLayer}- IconComponent={actionIcons.crosshairs}+ <PanelHeaderAction+ className="layer__options-toggle"+ testId="layer-options-toggle"+ id={layerId}+ tooltip="tooltip.moreOptions"+ onClick={event => {+ event.stopPropagation();+ setIsOptionsOpen(open => !open);+ }}+ IconComponent={actionIcons.more || Overflow}+ />+ <Portaled isOpened={isOptionsOpen} left={0} top={0} onClose={() => setIsOptionsOpen(false)}>+ <ContextMenuList+ className="layer-options-menu"+ items={optionItems}+ footer={removeAction}/>- {showJsonEditor && onToggleJsonEditor ? (- <PanelHeaderAction- className="layer__json-editor"- id={layerId}- tooltip={'tooltip.editLayerJson'}- onClick={onToggleJsonEditor}- IconComponent={actionIcons.json || CodeAlt}- active={isJsonEditorActive}- />- ) : null}- </StyledPanelHeaderHiddenActions>+ </Portaled>{isValid ? (<PanelHeaderActionclassName="layer__visibility-toggle"@@ -405,7 +396,8 @@ const defaultActionIcons = {duplicate: props => <Copy {...props} height="14px" />,resetIsValid: Reset,crosshairs: props => <ZoomIn {...props} height="14px" />,- json: props => <CodeAlt {...props} height="14px" />+ json: props => <CodeAlt {...props} height="14px" />,+ more: props => <Overflow {...props} height="16px" />};LayerPanelHeaderFactory.deps = [LayerTitleSectionFactory, LayerPanelHeaderActionSectionFactory];diff --git a/src/constants/src/default-settings.ts b/src/constants/src/default-settings.tsindex 00dc61e2f..19fcbcfd3 100644--- a/src/constants/src/default-settings.ts+++ b/src/constants/src/default-settings.ts@@ -1521,7 +1521,6 @@ export const dataTestIds: Record<string, string> = {sortableLayerItem: 'sortable-layer-item',staticLayerItem: 'static-layer-item',layerTitleEditor: 'layer__title__editor',- removeLayerAction: 'remove-layer-action',layerPanel: 'layer-panel',sortableEffectItem: 'sortable-effect-item',staticEffectItem: 'static-effect-item',diff --git a/src/localization/src/translations/en.ts b/src/localization/src/translations/en.tsindex 2083ad12a..ab8b39c17 100644--- a/src/localization/src/translations/en.ts+++ b/src/localization/src/translations/en.ts@@ -534,6 +534,7 @@ export default {zoomToLayer: 'Zoom to layer',resetAfterError: 'Try to enable the layer after an error',layerSettings: 'Layer settings',+ moreOptions: 'More options',interactionSettings: 'Interaction settings',closePanel: 'Close current panel',switchToDualView: 'Switch to dual map view',diff --git a/test/browser/components/side-panel/layer-list.spec.js b/test/browser/components/side-panel/layer-list.spec.jsindex 25dbad27f..4bad462ea 100644--- a/test/browser/components/side-panel/layer-list.spec.js+++ b/test/browser/components/side-panel/layer-list.spec.js@@ -138,8 +138,9 @@ describe('Components -> SidePanel -> LayerPanel -> LayerList', () => {expect(screen.getAllByTestId(dataTestIds.layerPanel)).toHaveLength(defaultProps.layers.length - 1);- expect(screen.getByTestId(dataTestIds.removeLayerAction)).toBeInTheDocument();- const removeLayerButton = screen.getByTestId(dataTestIds.removeLayerAction);+ fireEvent.click(screen.getByTestId('layer-options-toggle'));+ const removeLayerButton = document.querySelector('.layer__remove-layer');+ expect(removeLayerButton).not.toBeNull();fireEvent.click(removeLayerButton);expect(removeLayer).toHaveBeenCalled();diff --git a/test/browser/components/side-panel/layer-panel-header-test.js b/test/browser/components/side-panel/layer-panel-header-test.jsindex 23b5073df..6ac3a6399 100644--- a/test/browser/components/side-panel/layer-panel-header-test.js+++ b/test/browser/components/side-panel/layer-panel-header-test.js@@ -39,8 +39,14 @@ test('Components -> LayerPanelHeader.mount -> no prop', t => {t.ok(wrapper.find('.layer-panel__header').length, 'should render layer-panel__header');t.ok(wrapper.find(DragHandle).length, 'should render drag handle');t.ok(wrapper.find('.layer__title__editor').length, 'should render title eidtor');+ t.ok(wrapper.find('.layer__options-toggle').length, 'should render options menu toggle');t.ok(wrapper.find('.layer__visibility-toggle').length, 'should render visibility toggle');t.ok(wrapper.find('.layer__enable-config').length, 'should render enable config toggle');+ t.equal(+ wrapper.find('.layer-panel__header__actions__hidden').length,+ 0,+ 'should not render hover-only header actions'+ );// mountconst layerAfterErrorProps = {...defaultProps, ...{isValid: false}};