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
Typescript common components (#72288)
Nick Fitzpatrick50e490de81fe
diff --git a/frontend/src/metabase/common/components/DebouncedFrame/DebouncedFrame.jsx b/frontend/src/metabase/common/components/DebouncedFrame/DebouncedFrame.tsxsimilarity index 68%rename from frontend/src/metabase/common/components/DebouncedFrame/DebouncedFrame.jsxrename to frontend/src/metabase/common/components/DebouncedFrame/DebouncedFrame.tsxindex 4c32e003a19..bb1f7db5ca5 100644--- a/frontend/src/metabase/common/components/DebouncedFrame/DebouncedFrame.jsx+++ b/frontend/src/metabase/common/components/DebouncedFrame/DebouncedFrame.tsx@@ -1,5 +1,5 @@-/* eslint-disable react/prop-types */import cx from "classnames";+import type { ReactNode, Ref } from "react";import { Component, forwardRef } from "react";import _ from "underscore";@@ -14,7 +14,26 @@ const DEBOUNCE_PERIOD = 300;* We also fade the component out and block mouse events while it's transitioning*/-class DebouncedFrameInner extends Component {+interface DebouncedFrameInnerProps {+ width?: number;+ height?: number;+ enabled?: boolean;+ resetKey?: string | number | boolean;+ className?: string;+ style?: React.CSSProperties;+ children?: ReactNode;+ forwardedRef?: Ref<HTMLDivElement>;+}++interface DebouncedFrameInnerState {+ width?: number;+ height?: number;+}++class DebouncedFrameInner extends Component<+ DebouncedFrameInnerProps,+ DebouncedFrameInnerState+> {// NOTE: don't keep `_transition` in component state because we don't want to trigger a rerender when we update it// Instead manually modify the style in _updateTransitionStyle// There's probably a better way to block renders of children though@@ -25,11 +44,13 @@ class DebouncedFrameInner extends Component {// Will be set to true whenever `props.resetKey` changes._queueImmediateResize = false;+ _container: HTMLDivElement | null = null;+static defaultProps = {enabled: true,};- constructor(props) {+ constructor(props: DebouncedFrameInnerProps) {super(props);this.state = {width: props.width,@@ -50,7 +71,7 @@ class DebouncedFrameInner extends Component {updateSizeDebounced = _.debounce(this.updateSize, DEBOUNCE_PERIOD);- UNSAFE_componentWillReceiveProps(nextProps) {+ UNSAFE_componentWillReceiveProps(nextProps: DebouncedFrameInnerProps) {if (!nextProps.enabled) {this._updateTransitionStyle();return;@@ -73,7 +94,7 @@ class DebouncedFrameInner extends Component {this._updateTransitionStyle();}- componentDidUpdate(prevProps) {+ componentDidUpdate(prevProps: DebouncedFrameInnerProps) {if (prevProps.resetKey !== this.props.resetKey) {this._queueImmediateResize = true;}@@ -92,8 +113,8 @@ class DebouncedFrameInner extends Component {_updateTransitionStyle = () => {if (this._container) {const transition = this._transition && this.props.enabled;- this._container.style.opacity = transition ? "0.5" : null;- this._container.style.pointerEvents = transition ? "none" : null;+ this._container.style.opacity = transition ? "0.5" : "";+ this._container.style.pointerEvents = transition ? "none" : "";}};@@ -108,14 +129,17 @@ class DebouncedFrameInner extends Component {<divdata-testid="debounced-frame-root"ref={(r) => {- if (this.props.forwardedRef) {- if (typeof this.props.forwardedRef === "function") {- this.props.forwardedRef(r);+ const { forwardedRef } = this.props;+ if (forwardedRef) {+ if (typeof forwardedRef === "function") {+ forwardedRef(r);} else {- this.props.forwardedRef = r;+ (+ forwardedRef as React.MutableRefObject<HTMLDivElement | null>+ ).current = r;}}- return (this._container = r);+ this._container = r;}}className={cx(className, CS.relative)}style={{@@ -124,7 +148,7 @@ class DebouncedFrameInner extends Component {...style,}}>- {width > 0 ? (+ {width != null && width > 0 ? (<div className={CS.absolute} style={{ width, height }}>{children}</div>@@ -134,13 +158,17 @@ class DebouncedFrameInner extends Component {}}-const DebouncedFrameForwardRef = forwardRef(- function _DebouncedFrameRefWrapper(props, ref) {- return <DebouncedFrameInner {...props} forwardedRef={ref} />;- },-);--export const DebouncedFrame = ExplicitSize({+const DebouncedFrameForwardRef = forwardRef<+ HTMLDivElement,+ Omit<DebouncedFrameInnerProps, "forwardedRef">+>(function _DebouncedFrameRefWrapper(props, ref) {+ return <DebouncedFrameInner {...props} forwardedRef={ref} />;+});++// `as any` cast needed because ExplicitSize's HOC types inject width/height as+// number | null, which is incompatible with our props' number | undefined.+// Can be removed if ExplicitSize is replaced with a hook-based alternative.+export const DebouncedFrame = ExplicitSize<DebouncedFrameInnerProps>({// Disable ExplicitSize's debounce/throttle since DebouncedFrame has a built-in debouncerefreshMode: "none",-})(DebouncedFrameForwardRef);+})(DebouncedFrameForwardRef as any);diff --git a/frontend/src/metabase/common/components/EntityItem/EntityItem.tsx b/frontend/src/metabase/common/components/EntityItem/EntityItem.tsxindex 4ed70cdaca3..742962a7ed6 100644--- a/frontend/src/metabase/common/components/EntityItem/EntityItem.tsx+++ b/frontend/src/metabase/common/components/EntityItem/EntityItem.tsx@@ -231,9 +231,9 @@ function EntityItemMenu({title: t`Delete permanently`,icon: "trash",action: onDeletePermanently,- color: "danger",- hoverColor: "danger",- hoverBgColor: "background-error",+ color: "danger" as const,+ hoverColor: "danger" as const,+ hoverBgColor: "background-error" as const,});}@@ -262,10 +262,9 @@ function EntityItemMenu({<EntityMenuContainer style={{ textAlign: "center" }}><EntityMenutriggerAriaLabel={t`Actions`}- className={className}- closedClassNames={cx(CS.hoverChild, CS.hoverChildSmooth)}triggerIcon="ellipsis"items={actions}+ className={className}/></EntityMenuContainer>);@@ -340,7 +339,6 @@ export const EntityItem = ({onMove={onMove}onCopy={onCopy}onArchive={onArchive}- className={CS.ml1}/></EntityItemActions></EntityItemWrapper>diff --git a/frontend/src/metabase/common/components/EntityMenu/EntityMenu.jsx b/frontend/src/metabase/common/components/EntityMenu/EntityMenu.jsxdeleted file mode 100644index 3d234fc4e64..00000000000--- a/frontend/src/metabase/common/components/EntityMenu/EntityMenu.jsx+++ /dev/null@@ -1,182 +0,0 @@-/* eslint-disable react/prop-types */-import cx from "classnames";-import { Component, createRef } from "react";--import { EntityMenuItem } from "metabase/common/components/EntityMenuItem";-import { EntityMenuTrigger } from "metabase/common/components/EntityMenuTrigger";-import CS from "metabase/css/core/index.css";-import { Divider, Popover } from "metabase/ui";--/**- * @deprecated: use Menu from "metabase/ui"- */-export class EntityMenu extends Component {- state = {- open: false,- freezeMenu: false,- menuItemContent: null,- };-- static defaultProps = {- horizontalAttachments: ["left", "right"],- };-- constructor(props, context) {- super(props, context);-- this.rootRef = createRef();- }-- toggleMenu = () => {- if (this.state.freezeMenu) {- return;- }-- const open = !this.state.open;- this.setState({ open, menuItemContent: null });- };-- setFreezeMenu = (freezeMenu) => {- this.setState({ freezeMenu });- };-- replaceMenuWithItemContent = (menuItemContent) => {- this.setState({ menuItemContent });- };-- render() {- const {- items,- triggerIcon,- triggerProps,- className,- openClassNames,- closedClassNames,- minWidth,- tooltip,- trigger,- renderTrigger,- triggerAriaLabel,- tooltipPlacement,- transitionDuration = 150,- } = this.props;- const { open, menuItemContent } = this.state;-- return (- <Popover- opened={open}- className={cx(className, open ? openClassNames : closedClassNames)}- transitionProps={{ duration: transitionDuration }}- onChange={() => this.toggleMenu()}- position="bottom-end"- >- <Popover.Target>- <div>- {renderTrigger ? (- renderTrigger({ open, onClick: this.toggleMenu })- ) : (- <EntityMenuTrigger- ariaLabel={triggerAriaLabel}- trigger={trigger}- icon={triggerIcon}- onClick={this.toggleMenu}- open={open}- tooltip={tooltip}- tooltipPlacement={tooltipPlacement}- triggerProps={triggerProps}- />- )}- </div>- </Popover.Target>- <Popover.Dropdown>- {menuItemContent || (- <ol className={CS.p1} style={{ minWidth: minWidth ?? 184 }}>- {items.map((item) => {- if (!item) {- return null;- }-- const key = item.key ?? item.title;- const itemId = `entity-menu-item-${encodeURIComponent(key)}`;-- if (item.separator) {- return (- <li key={key}>- <Divider m="sm" />- </li>- );- }-- if (item.content) {- return (- <li- key={key}- data-testid={item.testId}- aria-labelledby={itemId}- >- <EntityMenuItem- htmlId={itemId}- icon={item.icon}- title={item.title}- action={() =>- this.replaceMenuWithItemContent(- item.content(this.toggleMenu, this.setFreezeMenu),- )- }- tooltip={item.tooltip}- color={item.color}- hoverColor={item.hoverColor}- hoverBgColor={item.hoverBgColor}- />- </li>- );- }-- if (item.component) {- return (- <li key={key} data-testid={item.testId}>- {item.component}- </li>- );- }-- return (- <li- key={key}- data-testid={item.testId}- aria-labelledby={itemId}- >- <EntityMenuItem- htmlId={itemId}- icon={item.icon}- title={item.title}- externalLink={item.externalLink}- action={- item.action &&- ((e) => {- item.action(e);- this.toggleMenu();- })- }- event={item.event}- link={item.link}- tooltip={item.tooltip}- disabled={item.disabled}- onClose={() => {- this.toggleMenu();- item?.onClose?.();- }}- color={item.color}- hoverColor={item.hoverColor}- hoverBgColor={item.hoverBgColor}- />- </li>- );- })}- </ol>- )}- </Popover.Dropdown>- </Popover>- );- }-}diff --git a/frontend/src/metabase/common/components/EntityMenu/EntityMenu.tsx b/frontend/src/metabase/common/components/EntityMenu/EntityMenu.tsxnew file mode 100644index 00000000000..7b3a9a13959--- /dev/null+++ b/frontend/src/metabase/common/components/EntityMenu/EntityMenu.tsx@@ -0,0 +1,245 @@+import type { ReactNode } from "react";+import { Component, createRef } from "react";++import { EntityMenuItem } from "metabase/common/components/EntityMenuItem";+import { EntityMenuTrigger } from "metabase/common/components/EntityMenuTrigger";+import type { EntityMenuIconButtonProps } from "metabase/common/components/EntityMenuTrigger/EntityMenuTrigger.styled";+import CS from "metabase/css/core/index.css";+import type { IconName } from "metabase/ui";+import { Divider, Popover } from "metabase/ui";+import type { ColorName } from "metabase/ui/colors/types";++interface EntityMenuBaseItem {+ key?: string;+ testId?: string;+}++interface EntityMenuStyledItem extends EntityMenuBaseItem {+ title: string;+ icon?: string;+ tooltip?: ReactNode;+ color?: ColorName;+ hoverColor?: ColorName;+ hoverBgColor?: ColorName;+}++interface EntityMenuSeparatorItem extends EntityMenuBaseItem {+ separator: true;+}++interface EntityMenuContentItem extends EntityMenuStyledItem {+ content: (+ toggleMenu: () => void,+ setFreezeMenu: (freeze: boolean) => void,+ ) => ReactNode;+}++interface EntityMenuComponentItem extends EntityMenuBaseItem {+ component: ReactNode;+}++interface EntityMenuActionItem extends EntityMenuStyledItem {+ action?: (...args: any[]) => void;+ link?: string;+ externalLink?: boolean;+ event?: string;+ disabled?: boolean;+ onClose?: () => void;+}++type EntityMenuItemType =+ | EntityMenuSeparatorItem+ | EntityMenuContentItem+ | EntityMenuComponentItem+ | EntityMenuActionItem+ | null+ | undefined;++interface EntityMenuProps {+ items: EntityMenuItemType[];+ triggerIcon?: string;+ triggerProps?: EntityMenuIconButtonProps;+ minWidth?: number;+ tooltip?: string;+ trigger?: React.ReactElement;+ renderTrigger?: (props: { open: boolean; onClick: () => void }) => ReactNode;+ triggerAriaLabel?: string;+ tooltipPlacement?: "top" | "bottom";+ transitionDuration?: number;+ className?: string;+}++interface EntityMenuState {+ open: boolean;+ freezeMenu: boolean;+ menuItemContent: ReactNode;+}++/**+ * @deprecated: use Menu from "metabase/ui"+ */+export class EntityMenu extends Component<EntityMenuProps, EntityMenuState> {+ state: EntityMenuState = {+ open: false,+ freezeMenu: false,+ menuItemContent: null,+ };++ rootRef = createRef<HTMLDivElement>();++ toggleMenu = () => {+ if (this.state.freezeMenu) {+ return;+ }++ const open = !this.state.open;+ this.setState({ open, menuItemContent: null });+ };++ setFreezeMenu = (freezeMenu: boolean) => {+ this.setState({ freezeMenu });+ };++ replaceMenuWithItemContent = (menuItemContent: ReactNode) => {+ this.setState({ menuItemContent });+ };++ render() {+ const {+ items,+ triggerIcon = "ellipsis",+ triggerProps,+ minWidth,+ tooltip,+ trigger,+ renderTrigger,+ triggerAriaLabel,+ tooltipPlacement,+ transitionDuration = 150,+ className,+ } = this.props;+ const { open, menuItemContent } = this.state;++ return (+ <Popover+ opened={open}+ transitionProps={{ duration: transitionDuration }}+ onChange={() => this.toggleMenu()}+ position="bottom-end"+ >+ <Popover.Target>+ <div className={className}>+ {renderTrigger ? (+ renderTrigger({ open, onClick: this.toggleMenu })+ ) : (+ <EntityMenuTrigger+ ariaLabel={triggerAriaLabel}+ trigger={trigger}+ icon={triggerIcon}+ onClick={this.toggleMenu}+ open={open}+ tooltip={tooltip}+ tooltipPlacement={tooltipPlacement}+ triggerProps={triggerProps}+ />+ )}+ </div>+ </Popover.Target>+ <Popover.Dropdown>+ {menuItemContent || (+ <ol className={CS.p1} style={{ minWidth: minWidth ?? 184 }}>+ {items.map((item) => {+ if (!item) {+ return null;+ }++ const key =+ item.key ?? ("title" in item ? item.title : undefined);+ const itemId = key+ ? `entity-menu-item-${encodeURIComponent(key)}`+ : undefined;++ if ("separator" in item && item.separator) {+ return (+ <li key={key}>+ <Divider m="sm" />+ </li>+ );+ }++ if ("content" in item && item.content) {+ return (+ <li+ key={key}+ data-testid={item.testId}+ aria-labelledby={itemId}+ >+ <EntityMenuItem+ htmlId={itemId}+ icon={item.icon as IconName}+ title={item.title}+ action={() =>+ this.replaceMenuWithItemContent(+ item.content(this.toggleMenu, this.setFreezeMenu),+ )+ }+ tooltip={item.tooltip}+ color={item.color}+ hoverColor={item.hoverColor}+ hoverBgColor={item.hoverBgColor}+ />+ </li>+ );+ }++ if ("component" in item && item.component) {+ return (+ <li key={key} data-testid={item.testId}>+ {item.component}+ </li>+ );+ }++ if ("action" in item || "link" in item) {+ return (+ <li+ key={key}+ data-testid={item.testId}+ aria-labelledby={itemId}+ >+ <EntityMenuItem+ htmlId={itemId}+ icon={item.icon as IconName}+ title={item.title}+ externalLink={item.externalLink}+ action={+ item.action &&+ ((e) => {+ item.action?.(e);+ this.toggleMenu();+ })+ }+ link={item.link}+ tooltip={item.tooltip}+ disabled={item.disabled}+ onClose={() => {+ this.toggleMenu();+ item.onClose?.();+ }}+ color={item.color}+ hoverColor={item.hoverColor}+ hoverBgColor={item.hoverBgColor}+ />+ </li>+ );+ }++ return null;+ })}+ </ol>+ )}+ </Popover.Dropdown>+ </Popover>+ );+ }+}diff --git a/frontend/src/metabase/common/components/EntityMenuItem/EntityMenuItem.unit.spec.js b/frontend/src/metabase/common/components/EntityMenuItem/EntityMenuItem.unit.spec.tsxsimilarity index 100%rename from frontend/src/metabase/common/components/EntityMenuItem/EntityMenuItem.unit.spec.jsrename to frontend/src/metabase/common/components/EntityMenuItem/EntityMenuItem.unit.spec.tsxdiff --git a/frontend/src/metabase/common/components/EntityMenuTrigger/EntityMenuTrigger.unit.spec.js b/frontend/src/metabase/common/components/EntityMenuTrigger/EntityMenuTrigger.unit.spec.tsxsimilarity index 100%rename from frontend/src/metabase/common/components/EntityMenuTrigger/EntityMenuTrigger.unit.spec.jsrename to frontend/src/metabase/common/components/EntityMenuTrigger/EntityMenuTrigger.unit.spec.tsxdiff --git a/frontend/src/metabase/common/components/ExpandingContent/ExpandingContent.jsx b/frontend/src/metabase/common/components/ExpandingContent/ExpandingContent.tsxsimilarity index 56%rename from frontend/src/metabase/common/components/ExpandingContent/ExpandingContent.jsxrename to frontend/src/metabase/common/components/ExpandingContent/ExpandingContent.tsxindex 6762c7501ba..23f22bbe71e 100644--- a/frontend/src/metabase/common/components/ExpandingContent/ExpandingContent.jsx+++ b/frontend/src/metabase/common/components/ExpandingContent/ExpandingContent.tsx@@ -1,28 +1,46 @@-/* eslint-disable react/prop-types */import cx from "classnames";-import { Component } from "react";+import type { ReactNode } from "react";+import { Component, createRef } from "react";import CS from "metabase/css/core/index.css";import { isReducedMotionPreferred } from "metabase/utils/dom";-export class ExpandingContent extends Component {- constructor({ isInitiallyOpen }) {- super();- this.state = {- isOpen: isInitiallyOpen == null ? true : !!isInitiallyOpen,- // keep track of whether we're currently transitioning so we can set maxHeight to "none" when not- isTransitioning: false,- };- }+interface ExpandingContentProps {+ isOpen: boolean;+ isInitiallyOpen?: boolean;+ duration?: number;+ animateHeight?: boolean;+ animateOpacity?: boolean;+ children?: ReactNode;+}++interface ExpandingContentState {+ isOpen: boolean;+ isTransitioning: boolean;+}+export class ExpandingContent extends Component<+ ExpandingContentProps,+ ExpandingContentState+> {static defaultProps = {duration: 300,- opacity: true,animateHeight: true,animateOpacity: true,};- UNSAFE_componentWillReceiveProps(nextProps) {+ private _timer: ReturnType<typeof setTimeout> | null = null;+ private _ref = createRef<HTMLDivElement>();++ constructor(props: ExpandingContentProps) {+ super(props);+ this.state = {+ isOpen: props.isInitiallyOpen == null ? true : !!props.isInitiallyOpen,+ isTransitioning: false,+ };+ }++ UNSAFE_componentWillReceiveProps(nextProps: ExpandingContentProps) {this.setOpen(nextProps.isOpen);}componentDidMount() {@@ -32,11 +50,11 @@ export class ExpandingContent extends Component {this.clearTimer();}- setOpen(isOpen) {- isOpen = !!isOpen;- if (this.state.isOpen !== isOpen) {+ setOpen(isOpen: boolean) {+ const open = isOpen;+ if (this.state.isOpen !== open) {this.clearTimer();- this.setState({ isOpen: isOpen, isTransitioning: true }, () => {+ this.setState({ isOpen: open, isTransitioning: true }, () => {this._timer = setTimeout(() => {this.setState({ isTransitioning: false });}, this.props.duration);@@ -56,13 +74,12 @@ export class ExpandingContent extends Component {? `none`: `all ${duration}ms ease`;const { isOpen, isTransitioning } = this.state;- // get the actual content height (after the first render)const maxHeight = isTransitioning- ? (this._ref && this._ref.scrollHeight) || 0+ ? (this._ref.current && this._ref.current.scrollHeight) || 0: "none";return (<div- ref={(ref) => (this._ref = ref)}+ ref={this._ref}style={{transition,maxHeight: !animateHeight || isOpen ? maxHeight : 0,diff --git a/frontend/src/metabase/common/components/LastEditInfoLabel/LastEditInfoLabel.unit.spec.js b/frontend/src/metabase/common/components/LastEditInfoLabel/LastEditInfoLabel.unit.spec.tsxsimilarity index 96%rename from frontend/src/metabase/common/components/LastEditInfoLabel/LastEditInfoLabel.unit.spec.jsrename to frontend/src/metabase/common/components/LastEditInfoLabel/LastEditInfoLabel.unit.spec.tsxindex b062934d1c8..68d79310005 100644--- a/frontend/src/metabase/common/components/LastEditInfoLabel/LastEditInfoLabel.unit.spec.js+++ b/frontend/src/metabase/common/components/LastEditInfoLabel/LastEditInfoLabel.unit.spec.tsx@@ -23,6 +23,9 @@ describe("LastEditInfoLabel", () => {function setup({isLastEditedByCurrentUser = false,onClick = jest.fn(),+ }: {+ isLastEditedByCurrentUser?: boolean;+ onClick?: jest.Mock | null;} = {}) {const testItem = {"last-edit-info": {@@ -86,7 +89,7 @@ describe("LastEditInfoLabel", () => {it("should display last editor's name", () => {const { first_name, last_name } = TEST_USER;// Example: John Doe —> John D.- const expectedName = `${first_name} ${last_name.charAt(0)}.`;+ const expectedName = `${first_name} ${last_name?.charAt(0)}.`;setup();expect(screen.getByTestId("revision-history-button")).toHaveTextContent(diff --git a/frontend/src/metabase/common/components/ListItem/ListItem.jsx b/frontend/src/metabase/common/components/ListItem/ListItem.tsxsimilarity index 80%rename from frontend/src/metabase/common/components/ListItem/ListItem.jsxrename to frontend/src/metabase/common/components/ListItem/ListItem.tsxindex b28ab45f13b..a899efc115d 100644--- a/frontend/src/metabase/common/components/ListItem/ListItem.jsx+++ b/frontend/src/metabase/common/components/ListItem/ListItem.tsx@@ -1,15 +1,26 @@-/* eslint "react/prop-types": "warn" */import cx from "classnames";-import PropTypes from "prop-types";import { memo } from "react";import { Card } from "metabase/common/components/Card";import S from "metabase/common/components/List/List.module.css";import CS from "metabase/css/core/index.css";+import type { IconName } from "metabase/ui";import { Ellipsified, Icon } from "metabase/ui";import { ListItemLink, Root } from "./ListItem.styled";+interface ListItemBaseProps {+ "data-testid"?: string;+ name: string;+ description?: string;+ placeholder?: string;+ icon?: IconName;+}++export type ListItemProps =+ | (ListItemBaseProps & { url: string; disabled?: false })+ | (ListItemBaseProps & { url?: string; disabled: true });+const ListItemInner = ({"data-testid": dataTestId,name,@@ -18,7 +29,7 @@ const ListItemInner = ({disabled,placeholder,icon,-}) => {+}: ListItemProps) => {const card = (<Cardhoverable@@ -59,14 +70,4 @@ const ListItemInner = ({);};-ListItemInner.propTypes = {- "data-testid": PropTypes.string,- name: PropTypes.string.isRequired,- url: PropTypes.string,- description: PropTypes.string,- disabled: PropTypes.bool,- placeholder: PropTypes.string,- icon: PropTypes.string,-};-export const ListItem = memo(ListItemInner);diff --git a/frontend/src/metabase/common/components/ListItem/ListItem.unit.spec.js b/frontend/src/metabase/common/components/ListItem/ListItem.unit.spec.tsxsimilarity index 87%rename from frontend/src/metabase/common/components/ListItem/ListItem.unit.spec.jsrename to frontend/src/metabase/common/components/ListItem/ListItem.unit.spec.tsxindex eb555df5552..af705d80544 100644--- a/frontend/src/metabase/common/components/ListItem/ListItem.unit.spec.js+++ b/frontend/src/metabase/common/components/ListItem/ListItem.unit.spec.tsx@@ -2,13 +2,13 @@ import { Route } from "react-router";import { getIcon, renderWithProviders, screen } from "__support__/ui";-import { ListItem } from "./ListItem";+import { ListItem, type ListItemProps } from "./ListItem";const ITEM_NAME = "Table Foo";const ITEM_DESCRIPTION = "Nice table description.";const PLACEHOLDER_TEXT = "Placeholder text";-function setup({ name, ...opts }) {+function setup({ name, ...opts }: ListItemProps) {return renderWithProviders(<Route path="/" component={() => <ListItem name={name} {...opts} />} />,{ withRouter: true },@@ -34,12 +34,12 @@ describe("ListItem", () => {});it("should render with just the name", () => {- setup({ name: ITEM_NAME });+ setup({ name: ITEM_NAME, disabled: true });expect(screen.getByText(ITEM_NAME)).toBeInTheDocument();});it("should display the placeholder if there's no description", () => {- setup({ name: ITEM_NAME, placeholder: PLACEHOLDER_TEXT });+ setup({ name: ITEM_NAME, placeholder: PLACEHOLDER_TEXT, disabled: true });expect(screen.getByText(ITEM_NAME)).toBeInTheDocument();expect(screen.getByText(PLACEHOLDER_TEXT)).toBeInTheDocument();@@ -50,6 +50,7 @@ describe("ListItem", () => {name: ITEM_NAME,description: ITEM_DESCRIPTION,placeholder: PLACEHOLDER_TEXT,+ disabled: true,});expect(screen.getByText(ITEM_NAME)).toBeInTheDocument();diff --git a/frontend/src/metabase/common/components/ListSearchField/ListSearchField.unit.spec.js b/frontend/src/metabase/common/components/ListSearchField/ListSearchField.unit.spec.tsxsimilarity index 75%rename from frontend/src/metabase/common/components/ListSearchField/ListSearchField.unit.spec.jsrename to frontend/src/metabase/common/components/ListSearchField/ListSearchField.unit.spec.tsxindex a9565215011..77a1c55e0a6 100644--- a/frontend/src/metabase/common/components/ListSearchField/ListSearchField.unit.spec.js+++ b/frontend/src/metabase/common/components/ListSearchField/ListSearchField.unit.spec.tsx@@ -4,17 +4,17 @@ import { ListSearchField } from "./ListSearchField";describe("ListSearchField", () => {it("should render", async () => {- render(<ListSearchField autoFocus type="number" foo />);+ render(<ListSearchField autoFocus type="number" />);expect(screen.getByTestId("list-search-field")).toBeInTheDocument();});it("should have focused the input field", () => {- render(<ListSearchField autoFocus type="number" foo />);+ render(<ListSearchField autoFocus type="number" />);expect(screen.getByTestId("list-search-field")).toHaveFocus();});it("should pass through any additional input properties", () => {- render(<ListSearchField autoFocus type="number" foo />);+ render(<ListSearchField autoFocus type="number" />);expect(screen.getByTestId("list-search-field")).toHaveAttribute("type","number",diff --git a/frontend/src/metabase/common/components/PasswordReveal/PasswordReveal.unit.spec.js b/frontend/src/metabase/common/components/PasswordReveal/PasswordReveal.unit.spec.tsxsimilarity index 85%rename from frontend/src/metabase/common/components/PasswordReveal/PasswordReveal.unit.spec.jsrename to frontend/src/metabase/common/components/PasswordReveal/PasswordReveal.unit.spec.tsxindex c847ab27931..0f5560825db 100644--- a/frontend/src/metabase/common/components/PasswordReveal/PasswordReveal.unit.spec.js+++ b/frontend/src/metabase/common/components/PasswordReveal/PasswordReveal.unit.spec.tsx@@ -3,7 +3,7 @@ import { PasswordReveal } from "metabase/common/components/PasswordReveal";describe("password reveal", () => {it("should toggle the visibility state when hide / show are clicked", () => {- render(<PasswordReveal />);+ render(<PasswordReveal password="password" />);expect(screen.queryByText("Hide")).not.toBeInTheDocument();fireEvent.click(screen.getByText("Show"));@@ -13,7 +13,7 @@ describe("password reveal", () => {});it("should render a copy button", () => {- render(<PasswordReveal />);+ render(<PasswordReveal password="password" />);expect(screen.getByTestId("copy-button")).toBeInTheDocument();});});diff --git a/frontend/src/metabase/common/components/Popover/TippyPopover.unit.spec.js b/frontend/src/metabase/common/components/Popover/TippyPopover.unit.spec.tsxsimilarity index 89%rename from frontend/src/metabase/common/components/Popover/TippyPopover.unit.spec.jsrename to frontend/src/metabase/common/components/Popover/TippyPopover.unit.spec.tsxindex 43b64648303..af099f1243d 100644--- a/frontend/src/metabase/common/components/Popover/TippyPopover.unit.spec.js+++ b/frontend/src/metabase/common/components/Popover/TippyPopover.unit.spec.tsx@@ -1,10 +1,9 @@-/* eslint-disable react/prop-types */import userEvent from "@testing-library/user-event";-import { useEffect } from "react";+import React, { useEffect } from "react";import { render, screen } from "__support__/ui";-import { TippyPopover } from "./TippyPopover";+import { type ITippyPopoverProps, TippyPopover } from "./TippyPopover";const defaultTarget = (<div id="child-target" style={{ width: 100, height: 100 }}>@@ -12,9 +11,9 @@ const defaultTarget = (</div>);-function Content({ fn }) {+function Content({ fn }: { fn?: jest.Mock }) {useEffect(() => {- fn && fn();+ fn?.();// eslint-disable-next-line react-hooks/exhaustive-deps}, []);@@ -26,7 +25,11 @@ function setup({target = defaultTarget,parentOnClick,...otherProps-} = {}) {+}: {+ contentFn?: jest.Mock;+ target?: JSX.Element;+ parentOnClick?: jest.Mock;+} & ITippyPopoverProps = {}) {return render(<div onClick={parentOnClick}><TippyPopover content={<Content fn={contentFn} />} {...otherProps}>diff --git a/frontend/src/metabase/common/components/Select/Select.unit.spec.js b/frontend/src/metabase/common/components/Select/Select.unit.spec.tsxsimilarity index 100%rename from frontend/src/metabase/common/components/Select/Select.unit.spec.jsrename to frontend/src/metabase/common/components/Select/Select.unit.spec.tsxdiff --git a/frontend/src/metabase/common/components/TokenField/TokenField.unit.spec.js b/frontend/src/metabase/common/components/TokenField/TokenField.unit.spec.tsxsimilarity index 88%rename from frontend/src/metabase/common/components/TokenField/TokenField.unit.spec.jsrename to frontend/src/metabase/common/components/TokenField/TokenField.unit.spec.tsxindex c316f492a6d..d2701bdac74 100644--- a/frontend/src/metabase/common/components/TokenField/TokenField.unit.spec.js+++ b/frontend/src/metabase/common/components/TokenField/TokenField.unit.spec.tsx@@ -1,26 +1,25 @@-/* eslint-disable react/prop-types */-import userEvent from "@testing-library/user-event";import { Component } from "react";import { act, fireEvent, render, screen, within } from "__support__/ui";import { KEYCODE_ENTER } from "metabase/utils/keyboard";+import type { LayoutRendererArgs, TokenFieldProps } from "./TokenField";import { TokenField } from "./TokenField";const DEFAULT_OPTIONS = ["Doohickey", "Gadget", "Gizmo", "Widget"];-const MockValue = ({ value }) => <span>{value}</span>;-const MockOption = ({ option }) => <span>{option}</span>;+const MockValue = ({ value }: { value: string }) => <span>{value}</span>;+const MockOption = ({ option }: { option: string }) => <span>{option}</span>;const DEFAULT_TOKEN_FIELD_PROPS = {options: [],value: [],- valueKey: (option) => option,- labelKey: (option) => option,- valueRenderer: (value) => <MockValue value={value} />,- optionRenderer: (option) => <MockOption option={option} />,- layoutRenderer: ({ valuesList, optionsList }) => (+ valueKey: (option: string) => option,+ labelKey: (option: string) => option,+ valueRenderer: (value: string) => <MockValue value={value} />,+ optionRenderer: (option: string) => <MockOption option={option} />,+ layoutRenderer: ({ valuesList, optionsList }: LayoutRendererArgs) => (<div>{valuesList}{optionsList}@@ -28,8 +27,20 @@ const DEFAULT_TOKEN_FIELD_PROPS = {),};-class TokenFieldWithStateAndDefaults extends Component {- constructor(props) {+type WrapperProps = Partial<TokenFieldProps> & {+ value?: string[];+ onChange?: (value: string[]) => void;+};++interface WrapperState {+ value: string[];+}++class TokenFieldWithStateAndDefaults extends Component<+ WrapperProps,+ WrapperState+> {+ constructor(props: WrapperProps) {super(props);this.state = {value: props.value || [],@@ -37,13 +48,13 @@ class TokenFieldWithStateAndDefaults extends Component {}render() {// allow overriding everything except value and onChange which we provide- const { value, onChange, ...props } = this.props;+ const { value: _value, onChange, ...props } = this.props;return (<TokenField{...DEFAULT_TOKEN_FIELD_PROPS}{...props}value={this.state.value}- onChange={(value) => {+ onChange={(value: string[]) => {this.setState({ value });if (onChange) {onChange(value);@@ -60,8 +71,8 @@ describe("TokenField", () => {// eslint-disable-next-line testing-library/no-node-accessif (!global.Element.prototype.closest) {// eslint-disable-next-line testing-library/no-node-access- global.Element.prototype.closest = function (selector) {- let element = this;+ global.Element.prototype.closest = function (selector: string) {+ let element: Element | null = this;while (element) {if (element.matches(selector)) {return element;@@ -74,7 +85,7 @@ describe("TokenField", () => {});const input = () => {- return screen.getByRole("textbox");+ return screen.getByRole("textbox") as HTMLInputElement;};const values = () => {@@ -85,17 +96,18 @@ describe("TokenField", () => {return screen.queryAllByRole("listbox")[0];};- const type = (str) => fireEvent.change(input(), { target: { value: str } });+ const type = (str: string) =>+ fireEvent.change(input(), { target: { value: str } });- const clickText = (str) => fireEvent.click(screen.getByText(str));+ const clickText = (str: string) => fireEvent.click(screen.getByText(str));- const inputKeydown = (keyCode) =>+ const inputKeydown = (keyCode: number) =>fireEvent.keyDown(input(), { keyCode: keyCode });- const assertWithinValues = (collection) =>+ const assertWithinValues = (collection: string[]) =>expect(values()).toHaveTextContent(collection.join(""));- const assertWithinOptions = (collection) =>+ const assertWithinOptions = (collection: string[]) =>expect(options()).toHaveTextContent(collection.join(""));it("should render with no options or values", () => {@@ -456,17 +468,19 @@ describe("TokenField", () => {});describe("custom layoutRenderer", () => {- let layoutRenderer;+ let layoutRenderer: jest.Mock;beforeEach(() => {layoutRenderer = jest.fn()- .mockImplementation(({ valuesList, optionsList }) => (- <div>- {valuesList}- {optionsList}- </div>- ));+ .mockImplementation(+ ({ valuesList, optionsList }: LayoutRendererArgs) => (+ <div>+ {valuesList}+ {optionsList}+ </div>+ ),+ );});it("should be called with isFiltered=true when filtered", () => {diff --git a/frontend/src/metabase/common/components/Tooltip/Tooltip.unit.spec.js b/frontend/src/metabase/common/components/Tooltip/Tooltip.unit.spec.tsxsimilarity index 91%rename from frontend/src/metabase/common/components/Tooltip/Tooltip.unit.spec.jsrename to frontend/src/metabase/common/components/Tooltip/Tooltip.unit.spec.tsxindex d41b470aa92..627ee49edd9 100644--- a/frontend/src/metabase/common/components/Tooltip/Tooltip.unit.spec.js+++ b/frontend/src/metabase/common/components/Tooltip/Tooltip.unit.spec.tsx@@ -3,7 +3,7 @@ import { forwardRef, useState } from "react";import { render, screen } from "__support__/ui";-import { Tooltip } from "./Tooltip";+import { Tooltip, type TooltipProps } from "./Tooltip";const defaultTooltip = "tooltip content";@@ -17,7 +17,9 @@ function setup({target = defaultTarget,tooltip = defaultTooltip,...otherProps-} = {}) {+}: {+ target?: JSX.Element;+} & TooltipProps = {}) {return render(<div><Tooltip tooltip={tooltip} {...otherProps}>@@ -92,9 +94,11 @@ describe("Tooltip", () => {});it("should not wrap target Components with forwarded refs", () => {- const GoodTarget = forwardRef(function GoodTarget(props, ref) {- return <div ref={ref}>good target</div>;- });+ const GoodTarget = forwardRef<HTMLDivElement>(+ function GoodTarget(props, ref) {+ return <div ref={ref}>good target</div>;+ },+ );setup({ isOpen: true, target: <GoodTarget /> });@@ -131,13 +135,13 @@ describe("Tooltip", () => {it("should support using a reference element instead of a child target element", async () => {function ReferenceTooltipTest() {- const [eventTarget, setEventTarget] = useState();+ const [eventTarget, setEventTarget] = useState<HTMLDivElement>();return (<div><Tooltip reference={eventTarget} tooltip="reference tooltip" isOpen /><divonClick={(event) => {- setEventTarget(event.target);+ setEventTarget(event.target as HTMLDivElement);}}style={{ width: 100, height: 100 }}>diff --git a/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionListItem.tsx b/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionListItem.tsxindex f146412ba73..447af3497f0 100644--- a/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionListItem.tsx+++ b/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionListItem.tsx@@ -87,11 +87,13 @@ function ModelActionListItem({icon: canEdit ? "pencil" : "eye",link: actionUrl,},- canArchive && {- title: t`Archive`,- icon: "archive",- action: handleArchive,- },+ canArchive+ ? {+ title: t`Archive`,+ icon: "archive",+ action: handleArchive,+ }+ : null,],[actionUrl, canEdit, canArchive, handleArchive],);