Skip to content

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

[feat] reorder tooltips (#2378)

Igor Dykhta2500a2777bf6
diff --git a/src/components/src/common/field-selector.tsx b/src/components/src/common/field-selector.tsx
index 7f01a55f3..c6b436554 100644
--- a/src/components/src/common/field-selector.tsx
+++ b/src/components/src/common/field-selector.tsx
@@ -113,6 +113,7 @@ interface FieldSelectorFactoryProps {
suggested?: ReadonlyArray<string | number | boolean | object> | null;
CustomChickletComponent?: ComponentType<any>;
size?: string;
+ reorderItems?: (newOrder: any) => void;
}
function FieldSelectorFactory(
@@ -124,6 +125,7 @@ function FieldSelectorFactory(
error: false,
fields: [],
onSelect: () => {},
+ reorderItems: () => {},
placement: 'bottom',
value: null,
multiSelect: false,
@@ -194,6 +196,7 @@ function FieldSelectorFactory(
placeholder={this.props.placeholder}
placement={this.props.placement}
onChange={this.props.onSelect}
+ reorderItems={this.props.reorderItems}
DropDownLineItemRenderComponent={this.fieldListItemSelector(this.props)}
DropdownHeaderComponent={this.props.suggested ? SuggestedFieldHeader : null}
CustomChickletComponent={this.props.CustomChickletComponent}
diff --git a/src/components/src/common/item-selector/chickleted-input.tsx b/src/components/src/common/item-selector/chickleted-input.tsx
index 34526ec65..0ecd5f572 100644
--- a/src/components/src/common/item-selector/chickleted-input.tsx
+++ b/src/components/src/common/item-selector/chickleted-input.tsx
@@ -18,9 +18,13 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
-import React, {ElementType, MouseEventHandler, ReactNode} from 'react';
+import React, {ElementType, MouseEventHandler, ReactNode, useMemo, useCallback} from 'react';
import styled from 'styled-components';
+import {DndContext, DragOverlay, pointerWithin} from '@dnd-kit/core';
+import {SortableContext, useSortable, arrayMove} from '@dnd-kit/sortable';
+import {restrictToParentElement} from '@dnd-kit/modifiers';
+
import Delete from '../icons/delete';
import {FormattedMessage} from '@kepler.gl/localization';
@@ -39,6 +43,7 @@ interface ChickletedInputProps {
inputTheme?: string;
CustomChickletComponent?: ElementType;
className?: string;
+ reorderItems?: (newOrder: any) => void;
}
interface ChickletButtonProps {
@@ -65,6 +70,7 @@ export const ChickletButton = styled.div<ChickletButtonProps>`
}
`;
+const DND_MODIFIERS = [restrictToParentElement];
export const ChickletTag = styled.span`
margin-right: 10px;
text-overflow: ellipsis;
@@ -108,6 +114,56 @@ const ChickletedInputContainer = styled.div<ChickletedInputContainerProps>`
overflow: hidden;
`;
+const ChickletedItem = ({
+ item,
+ removeItem,
+ displayOption,
+ CustomChickletComponent,
+ inputTheme,
+ disabled,
+ itemId
+}) => {
+ const {attributes, listeners, setNodeRef, transform, transition, isDragging} = useSortable({
+ id: itemId
+ });
+ const chickletProps = useMemo(
+ () => ({
+ inputTheme,
+ disabled,
+ name: displayOption(item),
+ displayOption,
+ item,
+ attributes,
+ listeners,
+ setNodeRef,
+ transform,
+ transition,
+ isDragging,
+ remove: e => removeItem(item, e)
+ }),
+ [
+ item,
+ removeItem,
+ displayOption,
+ CustomChickletComponent,
+ inputTheme,
+ disabled,
+ itemId,
+ attributes,
+ listeners,
+ setNodeRef,
+ transform,
+ transition,
+ isDragging
+ ]
+ );
+ return CustomChickletComponent ? (
+ <CustomChickletComponent {...chickletProps} />
+ ) : (
+ <Chicklet {...chickletProps} />
+ );
+};
+
const ChickletedInput: React.FC<ChickletedInputProps> = ({
disabled,
onClick,
@@ -115,39 +171,64 @@ const ChickletedInput: React.FC<ChickletedInputProps> = ({
selectedItems = [],
placeholder = '',
removeItem,
+ reorderItems = d => d,
displayOption = d => d,
inputTheme,
CustomChickletComponent
-}) => (
- <ChickletedInputContainer
- className={`${className} chickleted-input`}
- onClick={onClick}
- inputTheme={inputTheme}
- hasPlaceholder={!selectedItems || !selectedItems.length}
- >
- {selectedItems.length > 0 ? (
- selectedItems.map((item, i) => {
- const chickletProps = {
- inputTheme,
- disabled,
- key: `${displayOption(item)}_${i}`,
- name: displayOption(item),
- displayOption,
- item,
- remove: e => removeItem(item, e)
- };
- return CustomChickletComponent ? (
- <CustomChickletComponent {...chickletProps} />
- ) : (
- <Chicklet {...chickletProps} />
- );
- })
- ) : (
- <span className={`${className} chickleted-input__placeholder`}>
- <FormattedMessage id={placeholder || 'placeholder.enterValue'} />
- </span>
- )}
- </ChickletedInputContainer>
-);
+}) => {
+ const selectedItemIds = useMemo(() => selectedItems.map(item => displayOption(item)), [
+ displayOption,
+ selectedItems
+ ]);
+ const handleDragEnd = useCallback(
+ ({active, over}) => {
+ if (!over) return;
+ if (active.id !== over.id) {
+ const oldIndex = selectedItemIds.findIndex(itemId => itemId === active.id);
+ const newIndex = selectedItemIds.findIndex(itemId => itemId === over.id);
+ reorderItems(arrayMove(selectedItems, oldIndex, newIndex));
+ }
+ },
+ [selectedItems, displayOption, reorderItems]
+ );
+
+ return (
+ <ChickletedInputContainer
+ className={`${className} chickleted-input`}
+ onClick={onClick}
+ inputTheme={inputTheme}
+ hasPlaceholder={!selectedItems || !selectedItems.length}
+ >
+ <DndContext
+ onDragEnd={handleDragEnd}
+ modifiers={DND_MODIFIERS}
+ collisionDetection={pointerWithin}
+ autoScroll={false}
+ >
+ <SortableContext items={selectedItemIds}>
+ {selectedItems.length > 0 ? (
+ selectedItems.map((item, index) => (
+ <ChickletedItem
+ item={item}
+ itemId={displayOption(item)}
+ removeItem={removeItem}
+ displayOption={displayOption}
+ CustomChickletComponent={CustomChickletComponent}
+ disabled={disabled}
+ inputTheme={inputTheme}
+ key={`${displayOption(item)}_${index}`}
+ />
+ ))
+ ) : (
+ <span className={`${className} chickleted-input__placeholder`}>
+ <FormattedMessage id={placeholder || 'placeholder.enterValue'} />
+ </span>
+ )}
+ </SortableContext>
+ <DragOverlay dropAnimation={null} />
+ </DndContext>
+ </ChickletedInputContainer>
+ );
+};
export default ChickletedInput;
diff --git a/src/components/src/common/item-selector/item-selector.tsx b/src/components/src/common/item-selector/item-selector.tsx
index 32642c87c..f290a87e6 100644
--- a/src/components/src/common/item-selector/item-selector.tsx
+++ b/src/components/src/common/item-selector/item-selector.tsx
@@ -154,6 +154,7 @@ export type ItemSelectorProps = {
CustomChickletComponent?: ComponentType<any>;
intl: IntlShape;
className?: string;
+ reorderItems?: (newOrder: any) => void;
showDropdownOnMount?: boolean;
};
@@ -164,7 +165,8 @@ class ItemSelectorUnmemoized extends Component<ItemSelectorProps> {
closeOnSelect: true,
searchable: true,
DropDownRenderComponent: DropdownList,
- DropDownLineItemRenderComponent: ListItem
+ DropDownLineItemRenderComponent: ListItem,
+ reorderItems: undefined
};
state = {
@@ -342,6 +344,7 @@ class ItemSelectorUnmemoized extends Component<ItemSelectorProps> {
selectedItems={toArray(this.props.selectedItems)}
placeholder={this.props.placeholder}
removeItem={this._removeItem}
+ reorderItems={this.props.reorderItems}
CustomChickletComponent={this.props.CustomChickletComponent}
inputTheme={inputTheme}
/>
diff --git a/src/components/src/side-panel/interaction-panel/tooltip-config.tsx b/src/components/src/side-panel/interaction-panel/tooltip-config.tsx
index 5d10e971c..8fa748f0e 100644
--- a/src/components/src/side-panel/interaction-panel/tooltip-config.tsx
+++ b/src/components/src/side-panel/interaction-panel/tooltip-config.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, {useCallback} from 'react';
import styled from 'styled-components';
import {injectIntl, IntlShape} from 'react-intl';
import {FormattedMessage} from '@kepler.gl/localization';
@@ -119,27 +119,62 @@ function TooltipConfigFactory(
onDisplayFormatChange
}: DatasetTooltipConfigProps) => {
const dataId = dataset.id;
+
+ const handleClick = useCallback(
+ () =>
+ onChange({
+ ...config,
+ fieldsToShow: {
+ ...config.fieldsToShow,
+ [dataId]: []
+ }
+ }),
+ [config, dataId, onChange]
+ );
+
+ const findSelectedHelper = useCallback((selected, tooltipFields) => {
+ return selected.map(
+ f =>
+ tooltipFields.find(tooltipField => tooltipField.name === f.name) || {
+ name: f.name,
+ // default initial tooltip is null
+ format: null
+ }
+ );
+ }, []);
+
+ const handleSelect = useCallback(
+ selected => {
+ const newConfig: DatasetTooltipConfigProps['config'] = {
+ ...config,
+ fieldsToShow: {
+ ...config.fieldsToShow,
+ [dataId]: findSelectedHelper(selected, config.fieldsToShow[dataId])
+ }
+ };
+ onChange(newConfig);
+ },
+ [config, dataId, onChange]
+ );
+
+ const handleReorderItems = useCallback(
+ newOrder =>
+ onChange({
+ ...config,
+ fieldsToShow: {
+ ...config.fieldsToShow,
+ [dataId]: newOrder
+ }
+ }),
+ [config, dataId, onChange]
+ );
return (
<SidePanelSection key={dataId}>
<SBFlexboxNoMargin>
<DatasetTag dataset={dataset} />
{Boolean(config.fieldsToShow[dataId].length) && (
<ButtonWrapper>
- <Button
- className="clear-all"
- onClick={() => {
- const newConfig = {
- ...config,
- fieldsToShow: {
- ...config.fieldsToShow,
- [dataId]: []
- }
- };
- onChange(newConfig);
- }}
- width="54px"
- secondary
- >
+ <Button className="clear-all" onClick={handleClick} width="54px" secondary>
<FormattedMessage id="fieldSelector.clearAll" />
</Button>
</ButtonWrapper>
@@ -148,26 +183,8 @@ function TooltipConfigFactory(
<FieldSelector
fields={dataset.fields}
value={config.fieldsToShow[dataId]}
- onSelect={selected => {
- const newConfig: DatasetTooltipConfigProps['config'] = {
- ...config,
- fieldsToShow: {
- ...config.fieldsToShow,
- // @ts-expect-error
- [dataId]: selected.map(
- f =>
- config.fieldsToShow[dataId].find(
- tooltipField => tooltipField.name === f.name
- ) || {
- name: f.name,
- // default initial tooltip is null
- format: null
- }
- )
- }
- };
- onChange(newConfig);
- }}
+ onSelect={handleSelect}
+ reorderItems={handleReorderItems}
closeOnSelect={false}
multiSelect
inputTheme="secondary"
@@ -190,6 +207,15 @@ function TooltipConfigFactory(
onDisplayFormatChange,
intl
}: TooltipConfigProps) => {
+ const handleChange = useCallback(
+ (option: string | number | boolean | object | null) =>
+ onChange({
+ ...config,
+ compareType: option as string | null
+ }),
+ [config, onChange]
+ );
+
return (
<TooltipConfigWrapper>
{Object.keys(config.fieldsToShow).map(dataId =>
@@ -235,14 +261,7 @@ function TooltipConfigFactory(
searchable={false}
inputTheme={'secondary'}
getOptionValue={d => d}
- onChange={option => {
- const newConfig: TooltipConfigProps['config'] = {
- ...config,
- // @ts-expect-error
- compareType: option
- };
- onChange(newConfig);
- }}
+ onChange={handleChange}
/>
</SidePanelSection>
</TooltipConfigWrapper>
diff --git a/src/components/src/side-panel/interaction-panel/tooltip-config/tooltip-chicklet.tsx b/src/components/src/side-panel/interaction-panel/tooltip-config/tooltip-chicklet.tsx
index 5972127a3..a9e4bba2e 100644
--- a/src/components/src/side-panel/interaction-panel/tooltip-config/tooltip-chicklet.tsx
+++ b/src/components/src/side-panel/interaction-panel/tooltip-config/tooltip-chicklet.tsx
@@ -20,8 +20,11 @@
import React, {Component, ComponentType} from 'react';
import styled from 'styled-components';
+import classnames from 'classnames';
+import {DraggableAttributes} from '@dnd-kit/core';
+import {CSS, Transform} from '@dnd-kit/utilities';
import {ChickletButton, ChickletTag} from '../../../common/item-selector/chickleted-input';
-import {Hash, Delete} from '../../../common/icons';
+import {Hash, Delete, VertDots} from '../../../common/icons';
import DropdownList from '../../../common/item-selector/dropdown-list';
import {FormattedMessage} from '@kepler.gl/localization';
import {TimeLabelFormat, TooltipFields} from '@kepler.gl/types';
@@ -34,6 +37,13 @@ interface TooltipChickletProps {
item: {name: string};
displayOption: Function;
remove: any;
+
+ attributes: DraggableAttributes;
+ listeners: any;
+ setNodeRef: (node: HTMLElement | null) => void;
+ transform: Transform | null;
+ transition?: string;
+ isDragging: boolean;
}
type TooltipConfig = {
@@ -80,6 +90,38 @@ const IconDiv = styled.div.attrs({
: props.theme.textColor};
`;
+type SortableStyledItemProps = {
+ transition?: string;
+ transform?: string;
+};
+const SortableStyledItem = styled.div<SortableStyledItemProps>`
+ transition: ${props => props.transition};
+ transform: ${props => props.transform};
+ &.sorting {
+ opacity: 0.3;
+ pointer-events: none;
+ }
+ :hover {
+ .tooltip-chicklet__drag-handler {
+ opacity: 1;
+ }
+ }
+`;
+
+const StyledDragHandle = styled.div.attrs({
+ className: 'tooltip-chicklet__drag-handler'
+})`
+ display: flex;
+ align-items: center;
+ z-index: 1000;
+ opacity: 0;
+ margin-left: -5px;
+ :hover {
+ cursor: move;
+ color: ${props => props.theme.tooltipVerticalLineColor};
+ }
+`;
+
function getFormatTooltip(formatLabels: TimeLabelFormat[], format: string | null) {
if (!format) {
return null;
@@ -102,7 +144,7 @@ function TooltipChickletFactory(
state = {
show: false
};
- private node!: HTMLDivElement;
+ private node!: HTMLDivElement | null;
componentDidMount() {
document.addEventListener('mousedown', this.handleClickOutside, false);
@@ -113,13 +155,25 @@ function TooltipChickletFactory(
}
handleClickOutside = (e: any) => {
- if (this.node.contains(e.target)) {
+ if (this.node?.contains(e.target)) {
return;
}
};
render() {
- const {disabled, item, displayOption, remove} = this.props;
+ const {
+ disabled,
+ item,
+ displayOption,
+ remove,
+ attributes,
+ listeners,
+ setNodeRef,
+ transform,
+ transition,
+ isDragging
+ } = this.props;
+
const {show} = this.state;
const tooltipField = config.fieldsToShow[dataId].find(
fieldToShow => fieldToShow.name === item.name
@@ -139,73 +193,84 @@ function TooltipChickletFactory(
const hashStyle = show ? hashStyles.SHOW : hasFormat ? hashStyles.ACTIVE : null;
return (
- <ChickletButton ref={(node: HTMLDivElement) => (this.node = node)}>
- <ChickletTag>{displayOption(item)}</ChickletTag>
- {formatLabels.length > 1 && (
- <ChickletAddonWrapper>
- <TippyTooltip
- placement="top"
- render={() => (
- <span>
- {hasFormat ? (
- getFormatTooltip(formatLabels, field.displayName)
- ) : (
- <FormattedMessage id={'fieldSelector.formatting'} />
- )}
- </span>
- )}
- >
- <ChickletAddon>
- <IconDiv status={hashStyle}>
- <Hash
- height="8px"
- onClick={e => {
+ <SortableStyledItem
+ ref={setNodeRef}
+ className={classnames('sortable-layer-items', {sorting: isDragging})}
+ transform={CSS.Translate.toString(transform)}
+ transition={transition || ''}
+ {...attributes}
+ >
+ <ChickletButton ref={node => (this.node = node)}>
+ <StyledDragHandle {...listeners}>
+ <VertDots height="12px" />
+ </StyledDragHandle>
+ <ChickletTag>{displayOption(item)}</ChickletTag>
+ {formatLabels.length > 1 && (
+ <ChickletAddonWrapper>
+ <TippyTooltip
+ placement="top"
+ render={() => (
+ <span>
+ {hasFormat ? (
+ getFormatTooltip(formatLabels, field.displayName)
+ ) : (
+ <FormattedMessage id={'fieldSelector.formatting'} />
+ )}
+ </span>
+ )}
+ >
+ <ChickletAddon>
+ <IconDiv status={hashStyle}>
+ <Hash
+ height="8px"
+ onClick={e => {
+ e.stopPropagation();
+ this.setState({show: Boolean(!show)});
+ }}
+ />
+ </IconDiv>
+ </ChickletAddon>
+ </TippyTooltip>
+ {show && (
+ <StyledPopover>
+ <DropdownList
+ options={formatLabels}
+ selectionIndex={selectionIndex}
+ displayOption={({label}) => label}
+ onOptionSelected={(result, e) => {
e.stopPropagation();
- this.setState({show: Boolean(!show)});
+ this.setState({
+ show: false
+ });
+
+ const displayFormat = getFormatValue(result);
+ const oldFieldsToShow = config.fieldsToShow[dataId];
+ const fieldsToShow = oldFieldsToShow.map(fieldToShow => {
+ return fieldToShow.name === tooltipField.name
+ ? {
+ name: tooltipField.name,
+ format: displayFormat
+ }
+ : fieldToShow;
+ });
+ const newConfig = {
+ ...config,
+ fieldsToShow: {
+ ...config.fieldsToShow,
+ [dataId]: fieldsToShow
+ }
+ };
+ onChange(newConfig);
+ onDisplayFormatChange(dataId, field.name, displayFormat);
}}
/>
- </IconDiv>
- </ChickletAddon>
- </TippyTooltip>
- {show && (
- <StyledPopover>
- <DropdownList
- options={formatLabels}
- selectionIndex={selectionIndex}
- displayOption={({label}) => label}
- onOptionSelected={(result, e) => {
- e.stopPropagation();
- this.setState({
- show: false
- });
-
- const displayFormat = getFormatValue(result);
- const oldFieldsToShow = config.fieldsToShow[dataId];
- const fieldsToShow = oldFieldsToShow.map(fieldToShow => {
- return fieldToShow.name === tooltipField.name
- ? {
- name: tooltipField.name,
- format: displayFormat
- }
- : fieldToShow;
- });
- const newConfig = {
- ...config,
- fieldsToShow: {
- ...config.fieldsToShow,
- [dataId]: fieldsToShow
- }
- };
- onChange(newConfig);
- onDisplayFormatChange(dataId, field.name, displayFormat);
- }}
- />
- </StyledPopover>
- )}
- </ChickletAddonWrapper>
- )}
- <Delete onClick={disabled ? null : remove} />
- </ChickletButton>
+ </StyledPopover>
+ )}
+ </ChickletAddonWrapper>
+ )}
+ <Delete onClick={disabled ? null : remove} />
+ </ChickletButton>
+ </SortableStyledItem>
);
}
}