The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Convert Legend components to TypeScript (DEV-1502) (#69427)
Fraserea43ff281605
diff --git a/frontend/src/metabase/visualizations/components/legend/Legend.jsx b/frontend/src/metabase/visualizations/components/legend/Legend.tsxsimilarity index 73%rename from frontend/src/metabase/visualizations/components/legend/Legend.jsxrename to frontend/src/metabase/visualizations/components/legend/Legend.tsxindex 33919911742..a33de09f48e 100644--- a/frontend/src/metabase/visualizations/components/legend/Legend.jsx+++ b/frontend/src/metabase/visualizations/components/legend/Legend.tsx@@ -1,8 +1,8 @@-import PropTypes from "prop-types";import { t } from "ttag";import _ from "underscore";import { Popover } from "metabase/ui";+import type { HoveredObject } from "metabase/visualizations/types";import {LegendLink,@@ -10,26 +10,31 @@ import {LegendPopoverContainer,LegendRoot,} from "./Legend.styled";+import type { LegendItemData } from "./LegendItem";import { LegendItem } from "./LegendItem";const POPOVER_BORDER = 1;const POPOVER_PADDING = 8;const POPOVER_OFFSET = POPOVER_BORDER + POPOVER_PADDING;-const propTypes = {- className: PropTypes.string,- items: PropTypes.array.isRequired,- hovered: PropTypes.object,- visibleIndex: PropTypes.number,- visibleLength: PropTypes.number,- isVertical: PropTypes.bool,- isInsidePopover: PropTypes.bool,- isQueryBuilder: PropTypes.bool,- onHoverChange: PropTypes.func,- onSelectSeries: PropTypes.func,- onToggleSeriesVisibility: PropTypes.func,- isReversed: PropTypes.bool,-};+interface LegendProps {+ className?: string;+ items: LegendItemData[];+ hovered?: HoveredObject | null;+ visibleIndex?: number;+ visibleLength?: number;+ isVertical?: boolean;+ isInsidePopover?: boolean;+ isQueryBuilder?: boolean;+ onHoverChange?: (data?: HoveredObject | null) => void;+ onSelectSeries?: (+ event: React.MouseEvent,+ index: number,+ isReversed?: boolean,+ ) => void;+ onToggleSeriesVisibility?: (event: React.MouseEvent, index: number) => void;+ isReversed?: boolean;+}export const Legend = ({className,@@ -44,7 +49,7 @@ export const Legend = ({onToggleSeriesVisibility,isReversed,isQueryBuilder,-}) => {+}: LegendProps) => {const items = isReversed ? _.clone(originalItems).reverse() : originalItems;const overflowIndex = visibleIndex + visibleLength;@@ -55,7 +60,7 @@ export const Legend = ({<LegendRootclassName={className}aria-label={t`Legend`}- isVertical={isVertical}+ isVertical={!!isVertical}>{visibleItems.map((item, index) => {const localIndex = index + visibleIndex;@@ -68,7 +73,7 @@ export const Legend = ({key={item.key}item={item}index={itemIndex}- isMuted={hovered && itemIndex !== hovered.index}+ isMuted={hovered != null && itemIndex !== hovered.index}dotSize={isQueryBuilder ? "12px" : "8px"}isVertical={isVertical}isInsidePopover={isInsidePopover}@@ -80,9 +85,9 @@ export const Legend = ({);})}{overflowLength > 0 && (- <Popover width="target" offset={POPOVER_OFFSET} placement="top-start">+ <Popover width="target" offset={POPOVER_OFFSET} position="top-start"><Popover.Target>- <LegendLinkContainer isVertical={isVertical}>+ <LegendLinkContainer isVertical={!!isVertical}><LegendLink>{t`And ${overflowLength} more`}</LegendLink></LegendLinkContainer></Popover.Target>@@ -91,7 +96,6 @@ export const Legend = ({<Legenditems={originalItems}hovered={hovered}- dotSize={isQueryBuilder ? "12px" : "8px"}visibleIndex={overflowIndex}visibleLength={overflowLength}isVertical={isVertical}@@ -108,5 +112,3 @@ export const Legend = ({</LegendRoot>);};--Legend.propTypes = propTypes;diff --git a/frontend/src/metabase/visualizations/components/legend/LegendItem.jsx b/frontend/src/metabase/visualizations/components/legend/LegendItem.tsxsimilarity index 57%rename from frontend/src/metabase/visualizations/components/legend/LegendItem.jsxrename to frontend/src/metabase/visualizations/components/legend/LegendItem.tsxindex 6237b79d3d0..6f2ca7003a5 100644--- a/frontend/src/metabase/visualizations/components/legend/LegendItem.jsx+++ b/frontend/src/metabase/visualizations/components/legend/LegendItem.tsx@@ -1,5 +1,4 @@import cx from "classnames";-import PropTypes from "prop-types";import { memo } from "react";import { Ellipsified } from "metabase/common/components/Ellipsified";@@ -12,18 +11,29 @@ import {} from "./LegendItem.styled";import { LegendItemDot } from "./LegendItemDot";-const propTypes = {- item: PropTypes.object,- dotSize: PropTypes.string,- index: PropTypes.number,- isMuted: PropTypes.bool,- isVertical: PropTypes.bool,- isInsidePopover: PropTypes.bool,- isReversed: PropTypes.bool,- onHoverChange: PropTypes.func,- onSelectSeries: PropTypes.func,- onToggleSeriesVisibility: PropTypes.func,-};+export interface LegendItemData {+ key: string;+ color: string;+ name: string;+ visible?: boolean;+}++interface LegendItemProps {+ item: LegendItemData;+ dotSize?: string;+ index: number;+ isMuted?: boolean;+ isVertical?: boolean;+ isInsidePopover?: boolean;+ isReversed?: boolean;+ onHoverChange?: (data?: { index: number; element: Element }) => void;+ onSelectSeries?: (+ event: React.MouseEvent,+ index: number,+ isReversed?: boolean,+ ) => void;+ onToggleSeriesVisibility?: (event: React.MouseEvent, index: number) => void;+}const LegendItemInner = ({item,@@ -36,34 +46,34 @@ const LegendItemInner = ({onHoverChange,onSelectSeries,onToggleSeriesVisibility,-}) => {- const handleDotClick = (event) => {+}: LegendItemProps) => {+ const handleDotClick = (event: React.MouseEvent) => {onToggleSeriesVisibility?.(event, index);};- const handleItemClick = (event) => {- onSelectSeries && onSelectSeries(event, index, isReversed);+ const handleItemClick = (event: React.MouseEvent) => {+ onSelectSeries?.(event, index, isReversed);};- const handleItemMouseEnter = (event) => {- onHoverChange && onHoverChange({ index, element: event.currentTarget });+ const handleItemMouseEnter = (event: React.MouseEvent) => {+ onHoverChange?.({ index: index, element: event.currentTarget });};const handleItemMouseLeave = () => {- onHoverChange && onHoverChange();+ onHoverChange?.();};return (- <LegendItemRoot isVertical={isVertical} data-testid="legend-item">+ <LegendItemRoot isVertical={!!isVertical} data-testid="legend-item"><LegendItemLabel- isMuted={isMuted}+ isMuted={!!isMuted}onMouseEnter={onHoverChange && handleItemMouseEnter}onMouseLeave={onHoverChange && handleItemMouseLeave}><LegendItemDotcolor={item.color}size={dotSize}- isVisible={item.visible}+ isVisible={item.visible ?? true}onClick={onToggleSeriesVisibility && handleDotClick}/><LegendItemTitle@@ -82,6 +92,4 @@ const LegendItemInner = ({);};-LegendItemInner.propTypes = propTypes;-export const LegendItem = memo(LegendItemInner);diff --git a/frontend/src/metabase/visualizations/components/legend/LegendItemDot.tsx b/frontend/src/metabase/visualizations/components/legend/LegendItemDot.tsxindex b337e15f184..237f2b1d661 100644--- a/frontend/src/metabase/visualizations/components/legend/LegendItemDot.tsx+++ b/frontend/src/metabase/visualizations/components/legend/LegendItemDot.tsx@@ -12,7 +12,7 @@ interface LegendItemDotProps {isVisible: boolean;color: string;size?: string; // px- onClick?: () => void;+ onClick?: (event: React.MouseEvent) => void;}export const LegendItemDot = forwardRef<diff --git a/frontend/src/metabase/visualizations/components/legend/LegendLayout.jsx b/frontend/src/metabase/visualizations/components/legend/LegendLayout.tsxsimilarity index 68%rename from frontend/src/metabase/visualizations/components/legend/LegendLayout.jsxrename to frontend/src/metabase/visualizations/components/legend/LegendLayout.tsxindex d5a2744a525..b8826fe1177 100644--- a/frontend/src/metabase/visualizations/components/legend/LegendLayout.jsx+++ b/frontend/src/metabase/visualizations/components/legend/LegendLayout.tsx@@ -1,7 +1,11 @@-import PropTypes from "prop-types";+import type { ReactNode } from "react";++import { isNotNull } from "metabase/lib/types";+import type { HoveredObject } from "metabase/visualizations/types";import { Legend } from "./Legend";import { LegendActions } from "./LegendActions";+import type { LegendItemData } from "./LegendItem";import {ChartContainer,LegendContainer,@@ -14,22 +18,26 @@ const MIN_ITEM_HEIGHT = 25;const MIN_ITEM_HEIGHT_LARGE = 31;const MIN_LEGEND_WIDTH = 400;-const propTypes = {- className: PropTypes.string,- items: PropTypes.array.isRequired,- hovered: PropTypes.object,- width: PropTypes.number,- height: PropTypes.number,- hasLegend: PropTypes.bool,- actionButtons: PropTypes.node,- isFullscreen: PropTypes.bool,- isQueryBuilder: PropTypes.bool,- children: PropTypes.node,- onHoverChange: PropTypes.func,- onSelectSeries: PropTypes.func,- onToggleSeriesVisibility: PropTypes.func,- isReversed: PropTypes.bool,-};+interface LegendLayoutProps {+ className?: string;+ items: LegendItemData[];+ hovered?: HoveredObject | null;+ width?: number;+ height?: number;+ hasLegend?: boolean;+ actionButtons?: ReactNode;+ isFullscreen?: boolean;+ isQueryBuilder?: boolean;+ children?: ReactNode;+ onHoverChange?: (data?: HoveredObject | null) => void;+ onSelectSeries?: (+ event: React.MouseEvent,+ index: number,+ isReversed?: boolean,+ ) => void;+ onToggleSeriesVisibility?: (event: React.MouseEvent, index: number) => void;+ isReversed?: boolean;+}export const LegendLayout = ({className,@@ -46,8 +54,8 @@ export const LegendLayout = ({onSelectSeries,onToggleSeriesVisibility,isReversed,-}) => {- const hasDimensions = width != null && height != null;+}: LegendLayoutProps) => {+ const hasDimensions = isNotNull(width) && isNotNull(height);const itemHeight = !isFullscreen ? MIN_ITEM_HEIGHT : MIN_ITEM_HEIGHT_LARGE;const maxXItems = Math.floor(width / MIN_ITEM_WIDTH);const maxYItems = Math.floor(height / itemHeight);@@ -63,7 +71,10 @@ export const LegendLayout = ({const visibleLength = isVertical ? minYLabels : items.length;const legend = (- <LegendContainer isVertical={isVertical} isQueryBuilder={isQueryBuilder}>+ <LegendContainer+ isVertical={!!isVertical}+ isQueryBuilder={!!isQueryBuilder}+ ><Legenditems={items}hovered={hovered}@@ -94,5 +105,3 @@ export const LegendLayout = ({</LegendLayoutRoot>);};--LegendLayout.propTypes = propTypes;