Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

UXW-3641 Remove emotion from EntityItem (#79848)

Denis Berezin461830362b20
diff --git a/frontend/src/metabase/browse/metrics/MetricsTable.tsx b/frontend/src/metabase/browse/metrics/MetricsTable.tsx
index 5aa313ecbb2..42147454e2f 100644
--- a/frontend/src/metabase/browse/metrics/MetricsTable.tsx
+++ b/frontend/src/metabase/browse/metrics/MetricsTable.tsx
@@ -9,7 +9,7 @@ import {
import { useSetArchive } from "metabase/archive/hooks";
import { getCollectionName } from "metabase/common/collections/utils";
import { EllipsifiedCollectionPath } from "metabase/common/components/EllipsifiedPath/EllipsifiedCollectionPath";
-import { EntityItem } from "metabase/common/components/EntityItem";
+import { EntityItemName } from "metabase/common/components/EntityItemName";
import { SortableColumnHeader } from "metabase/common/components/ItemsTable/BaseItemsTable";
import {
ColumnHeader,
@@ -245,7 +245,7 @@ function NameCell({ metric }: { metric?: MetricResult }) {
})}
onClick={preventDefault}
>
- <EntityItem.Name name={metric.name} variant="list" id={headingId} />
+ <EntityItemName name={metric.name} id={headingId} />
</Link>
) : (
<SkeletonText />
diff --git a/frontend/src/metabase/browse/models/ModelsTable.tsx b/frontend/src/metabase/browse/models/ModelsTable.tsx
index 55665b6519a..95726dab679 100644
--- a/frontend/src/metabase/browse/models/ModelsTable.tsx
+++ b/frontend/src/metabase/browse/models/ModelsTable.tsx
@@ -5,7 +5,7 @@ import { t } from "ttag";
import { getCollectionName } from "metabase/common/collections/utils";
import { EllipsifiedCollectionPath } from "metabase/common/components/EllipsifiedPath/EllipsifiedCollectionPath";
import { EntityIcon } from "metabase/common/components/EntityIcon";
-import { EntityItem } from "metabase/common/components/EntityItem";
+import { EntityItemName } from "metabase/common/components/EntityItemName";
import { SortableColumnHeader } from "metabase/common/components/ItemsTable/BaseItemsTable";
import {
ItemNameCell,
@@ -208,7 +208,7 @@ function NameCell({ model }: { model?: ModelResult }) {
const getIcon = useGetIcon();
const headingId = `model-${model?.id || "dummy"}-heading`;
const icon = getIcon(model ?? { model: "dataset" }) ?? { name: "folder" };
- const name = <EntityItem.Name name={model?.name || ""} variant="list" />;
+ const name = <EntityItemName name={model?.name || ""} />;
return (
<ItemNameCell data-testid="model-name" aria-labelledby={headingId}>
<Flex id={headingId} align="center" gap="0.5rem" ps="1.4rem" pe="0.5rem">
diff --git a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx
index 55dda1ab1d6..333c74cf093 100644
--- a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx
+++ b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx
@@ -27,7 +27,6 @@ import {
isItemPinned,
} from "metabase/common/collections/utils";
import { ConfirmModal } from "metabase/common/components/ConfirmModal";
-import { EntityItem } from "metabase/common/components/EntityItem";
import { canSelectItems } from "metabase/common/components/ItemsTable/utils";
import {
canMoveItem,
@@ -46,6 +45,7 @@ import type {
} from "metabase-types/api";
import S from "./ActionMenu.module.css";
+import { EntityItemMenu } from "./EntityItemMenu";
export interface ActionMenuProps {
className?: string;
@@ -151,7 +151,7 @@ function ActionMenuInner({
return (
<>
- <EntityItem.Menu
+ <EntityItemMenu
className={`${S.EntityItemMenu} ${className || ""}`}
item={item}
isBookmarked={isBookmarked}
diff --git a/frontend/src/metabase/common/components/EntityItem/EntityItem.module.css b/frontend/src/metabase/common/collections/components/ActionMenu/EntityItemMenu.module.css
similarity index 100%
rename from frontend/src/metabase/common/components/EntityItem/EntityItem.module.css
rename to frontend/src/metabase/common/collections/components/ActionMenu/EntityItemMenu.module.css
diff --git a/frontend/src/metabase/common/components/EntityItem/EntityItem.tsx b/frontend/src/metabase/common/collections/components/ActionMenu/EntityItemMenu.tsx
similarity index 57%
rename from frontend/src/metabase/common/components/EntityItem/EntityItem.tsx
rename to frontend/src/metabase/common/collections/components/ActionMenu/EntityItemMenu.tsx
index 83b318b0ddf..1e78c39cd3b 100644
--- a/frontend/src/metabase/common/components/EntityItem/EntityItem.tsx
+++ b/frontend/src/metabase/common/collections/components/ActionMenu/EntityItemMenu.tsx
@@ -1,6 +1,5 @@
import cx from "classnames";
-import type { ReactElement, ReactNode } from "react";
-import { useMemo } from "react";
+import { type ReactElement, type ReactNode, useMemo } from "react";
import { c, t } from "ttag";
import { archiveAndTrack } from "metabase/archive/analytics";
@@ -12,117 +11,15 @@ import type {
OnPin,
OnRestore,
OnToggleBookmark,
- OnToggleSelected,
} from "metabase/common/collections/types";
import { isItemModel, isItemPinned } from "metabase/common/collections/utils";
-import { EntityIcon } from "metabase/common/components/EntityIcon";
import { Link } from "metabase/common/components/Link";
-import { Swapper } from "metabase/common/components/Swapper";
-import type { IconData } from "metabase/common/utils/icon";
-import CS from "metabase/css/core/index.css";
-import type { IconProps } from "metabase/ui";
-import {
- ActionIcon,
- Checkbox,
- Ellipsified,
- Icon,
- Menu,
- Tooltip,
-} from "metabase/ui";
-import type { ColorName } from "metabase/ui/colors/types";
+import { ActionIcon, Flex, Icon, Menu, Tooltip } from "metabase/ui";
+import type { ColorName } from "metabase/ui/colors";
import * as Urls from "metabase/urls";
import type { CollectionItem, IconName } from "metabase-types/api";
-import S from "./EntityItem.module.css";
-import {
- EntityIconWrapper,
- EntityItemActions,
- EntityItemWrapper,
- EntityMenuContainer,
-} from "./EntityItem.styled";
-
-type EntityIconCheckBoxProps = {
- variant?: string;
- icon: IconProps | IconData;
- pinned?: boolean;
- selectable?: boolean;
- selected?: boolean;
- showCheckbox?: boolean;
- disabled?: boolean;
- onToggleSelected?: () => void;
-};
-
-const EntityIconCheckBox = ({
- variant,
- icon,
- pinned,
- selectable,
- selected,
- showCheckbox,
- disabled,
- onToggleSelected,
- ...props
-}: EntityIconCheckBoxProps) => {
- const iconSize = variant === "small" ? 12 : 16;
- const handleClick: React.MouseEventHandler<HTMLButtonElement> = (e) => {
- e.preventDefault();
- onToggleSelected?.();
- // helps keyboard shortcuts work for collection items
- e.currentTarget.focus();
- };
-
- return (
- <EntityIconWrapper
- isPinned={pinned}
- onClick={selectable ? handleClick : () => {}}
- disabled={disabled}
- {...props}
- >
- {selectable ? (
- <Swapper
- defaultElement={
- <EntityIcon
- {...icon}
- color={icon.color ?? "inherit"}
- size={iconSize}
- />
- }
- swappedElement={
- <Checkbox
- checked={selected}
- size={iconSize === 12 ? "xs" : "sm"}
- // Visual-only; clicks are handled by the wrapping button.
- style={{ pointerEvents: "none" }}
- />
- }
- isSwapped={selected || showCheckbox}
- />
- ) : (
- <EntityIcon {...icon} color={icon.color ?? "inherit"} size={iconSize} />
- )}
- </EntityIconWrapper>
- );
-};
-
-function EntityItemName({
- name,
- variant,
- ...props
-}: {
- name: string;
- variant?: string;
-} & React.HTMLAttributes<HTMLHeadingElement>) {
- return (
- <h3
- className={cx(CS.overflowHidden, {
- [CS.textList]: variant === "list",
- })}
- {...props}
- >
- <Ellipsified>{name}</Ellipsified>
- </h3>
- );
-}
+import S from "./EntityItemMenu.module.css";
type EntityItemMenuAction = {
title: string;
@@ -152,7 +49,7 @@ function MenuItemTooltip({
);
}
-function EntityItemMenu({
+export function EntityItemMenu({
item,
isBookmarked,
isSelected,
@@ -287,7 +184,7 @@ function EntityItemMenu({
return null;
}
return (
- <EntityMenuContainer style={{ textAlign: "center" }}>
+ <Flex align="center" ta="center" c="text-secondary">
<Menu position="bottom-end">
<Menu.Target>
<ActionIcon
@@ -356,82 +253,6 @@ function EntityItemMenu({
})}
</Menu.Dropdown>
</Menu>
- </EntityMenuContainer>
+ </Flex>
);
}
-
-export const EntityItem = ({
- name,
- iconName,
- onPin,
- onMove,
- onCopy,
- onArchive,
- selected,
- onToggleSelected,
- selectable = false,
- variant,
- item,
- buttons,
- extraInfo,
- pinned,
- disabled,
-}: {
- name: string;
- iconName: IconName;
- onPin?: OnPin;
- onMove?: OnMove;
- onCopy?: OnCopy;
- onArchive?: OnArchive;
- selected?: boolean;
- onToggleSelected?: OnToggleSelected;
- selectable?: boolean;
- variant?: string;
- item: CollectionItem;
- buttons?: ReactNode;
- extraInfo?: ReactNode;
- pinned?: boolean;
- disabled?: boolean;
-}) => {
- const icon = useMemo(() => ({ name: iconName }), [iconName]);
-
- return (
- <EntityItemWrapper
- className={cx(CS.hoverParent, CS.hoverVisibility, {
- [CS.bgLightHover]: variant === "list",
- })}
- variant={variant}
- disabled={disabled}
- >
- <EntityIconCheckBox
- variant={variant}
- icon={icon}
- pinned={pinned}
- selectable={selectable}
- selected={selected}
- disabled={disabled}
- onToggleSelected={onToggleSelected}
- />
-
- <div className={CS.overflowHidden}>
- <EntityItemName name={name} />
- <div>{extraInfo && extraInfo}</div>
- </div>
-
- <EntityItemActions onClick={(e) => e.preventDefault()}>
- {buttons}
- <EntityItemMenu
- item={item}
- onPin={onPin}
- onMove={onMove}
- onCopy={onCopy}
- onArchive={onArchive}
- />
- </EntityItemActions>
- </EntityItemWrapper>
- );
-};
-
-EntityItem.IconCheckBox = EntityIconCheckBox;
-EntityItem.Name = EntityItemName;
-EntityItem.Menu = EntityItemMenu;
diff --git a/frontend/src/metabase/common/components/EntityItem/EntityItem.styled.tsx b/frontend/src/metabase/common/components/EntityItem/EntityItem.styled.tsx
deleted file mode 100644
index bb9cae3ae6b..00000000000
--- a/frontend/src/metabase/common/components/EntityItem/EntityItem.styled.tsx
+++ /dev/null
@@ -1,73 +0,0 @@
-// eslint-disable-next-line no-restricted-imports
-import styled from "@emotion/styled";
-
-import { IconButtonWrapper } from "metabase/common/components/IconButtonWrapper";
-import { darken } from "metabase/ui/colors";
-import { color } from "metabase/ui/utils/colors";
-
-function getPinnedForeground(disabled: boolean) {
- return disabled ? darken("border-neutral", 0.38) : color("accent4");
-}
-
-function getForeground(model: string, disabled: boolean) {
- return disabled
- ? darken("border-neutral", 0.38)
- : model === "dataset"
- ? color("accent2")
- : color("core-brand");
-}
-
-const getItemPadding = (variant?: string) => {
- switch (variant) {
- case "list":
- return "1rem";
- case "small":
- return "0.5rem 1rem";
- default:
- return "1rem 0";
- }
-};
-
-export const EntityIconWrapper = styled(IconButtonWrapper, {
- shouldForwardProp: (prop) => prop !== "isPinned",
-})<{
- isPinned?: boolean;
- disabled?: boolean;
-}>`
- background-color: transparent;
- padding: 12px;
- cursor: ${(props) => (props.disabled ? "default" : "pointer")};
- color: ${(props) =>
- props.isPinned
- ? getPinnedForeground(!!props.disabled)
- : getForeground("", !!props.disabled)};
-`;
-
-export const EntityItemWrapper = styled.div<{
- variant?: string;
- disabled?: boolean;
-}>`
- display: flex;
- align-items: center;
- padding: ${(props) => getItemPadding(props.variant)};
- color: ${(props) =>
- props.disabled ? color("text-secondary") : color("text-primary")};
-
- &:hover {
- color: ${(props) =>
- props.disabled ? color("text-secondary") : color("core-brand")};
- }
-`;
-
-export const EntityMenuContainer = styled.div`
- display: flex;
- align-items: center;
- color: var(--mb-color-text-secondary);
-`;
-
-export const EntityItemActions = styled.div`
- display: flex;
- align-items: center;
- margin-left: auto;
- padding-right: 0.5rem;
-`;
diff --git a/frontend/src/metabase/common/components/EntityItem/index.tsx b/frontend/src/metabase/common/components/EntityItem/index.tsx
deleted file mode 100644
index 7f3dc03d3fb..00000000000
--- a/frontend/src/metabase/common/components/EntityItem/index.tsx
+++ /dev/null
@@ -1 +0,0 @@
-export { EntityItem } from "./EntityItem";
diff --git a/frontend/src/metabase/common/components/EntityItemName.tsx b/frontend/src/metabase/common/components/EntityItemName.tsx
new file mode 100644
index 00000000000..a6729de59da
--- /dev/null
+++ b/frontend/src/metabase/common/components/EntityItemName.tsx
@@ -0,0 +1,17 @@
+import CS from "metabase/css/core/index.css";
+import { Ellipsified, Text } from "metabase/ui";
+
+export function EntityItemName({ name, id }: { name: string; id?: string }) {
+ return (
+ <Text
+ component="h3"
+ fw="bold"
+ fz="inherit"
+ c="inherit"
+ className={CS.overflowHidden}
+ id={id}
+ >
+ <Ellipsified>{name}</Ellipsified>
+ </Text>
+ );
+}
diff --git a/frontend/src/metabase/common/components/ItemsTable/BaseItemsTable.styled.tsx b/frontend/src/metabase/common/components/ItemsTable/BaseItemsTable.styled.tsx
index 77a2d53a7a9..b6e606ff8d5 100644
--- a/frontend/src/metabase/common/components/ItemsTable/BaseItemsTable.styled.tsx
+++ b/frontend/src/metabase/common/components/ItemsTable/BaseItemsTable.styled.tsx
@@ -9,7 +9,6 @@ import {
forwardRef,
} from "react";
-import { EntityItem } from "metabase/common/components/EntityItem";
import { IconButtonWrapper } from "metabase/common/components/IconButtonWrapper";
import { Link } from "metabase/common/components/Link";
import AdminS from "metabase/css/admin.module.css";
@@ -79,11 +78,6 @@ export const TableColumn = styled.col<ResponsiveProps>`
${hideResponsively}
`;
-export const EntityIconCheckBox = styled(EntityItem.IconCheckBox)`
- width: 3em;
- height: 3em;
-`;
-
const itemLinkStyle = css`
display: flex;
grid-gap: 0.5rem;
diff --git a/frontend/src/metabase/common/components/ItemsTable/Columns.tsx b/frontend/src/metabase/common/components/ItemsTable/Columns.tsx
index 15353268609..41e18c32731 100644
--- a/frontend/src/metabase/common/components/ItemsTable/Columns.tsx
+++ b/frontend/src/metabase/common/components/ItemsTable/Columns.tsx
@@ -4,7 +4,7 @@ import { c, t } from "ttag";
import type { ActionMenuProps } from "metabase/common/collections/components/ActionMenu";
import { ActionMenu } from "metabase/common/collections/components/ActionMenu";
import { DateTime } from "metabase/common/components/DateTime";
-import { EntityItem } from "metabase/common/components/EntityItem";
+import { EntityItemName } from "metabase/common/components/EntityItemName";
import { Markdown } from "metabase/common/components/Markdown";
import { useTranslateContent } from "metabase/content-translation/hooks";
import { ArchiveButton } from "metabase/embedding/components/ArchiveButton";
@@ -27,7 +27,6 @@ import {
BulkSelectWrapper,
ColumnHeader,
DescriptionIcon,
- EntityIconCheckBox,
ItemButton,
ItemCell,
ItemLink,
@@ -35,6 +34,7 @@ import {
RowActionsContainer,
TableColumn,
} from "./BaseItemsTable.styled";
+import { EntityIconCheckBox } from "./EntityIconCheckBox";
type HeaderProps = Omit<
SortableColumnHeaderProps<ListCollectionItemsSortColumn>,
@@ -183,7 +183,7 @@ export const Columns = {
return (
<ItemNameCell data-testid={`${testIdPrefix}-name`}>
<ItemLinkComponent onClick={onClick} item={item}>
- <EntityItem.Name name={tc(item.name)} variant="list" />
+ <EntityItemName name={tc(item.name)} />
<PLUGIN_MODERATION.ModerationStatusIcon
size={16}
status={item.moderated_status}
diff --git a/frontend/src/metabase/common/components/ItemsTable/EntityIconCheckBox.module.css b/frontend/src/metabase/common/components/ItemsTable/EntityIconCheckBox.module.css
new file mode 100644
index 00000000000..da58b4b5d8b
--- /dev/null
+++ b/frontend/src/metabase/common/components/ItemsTable/EntityIconCheckBox.module.css
@@ -0,0 +1,17 @@
+.iconWrapper {
+ padding: 0.75rem;
+ background-color: transparent;
+ cursor: pointer;
+ color: var(--mb-color-core-brand);
+ width: 3em;
+ height: 3em;
+
+ &.pinned {
+ color: var(--mb-color-accent4);
+ }
+
+ &.disabled {
+ cursor: default;
+ color: var(--mb-color-text-disabled);
+ }
+}
diff --git a/frontend/src/metabase/common/components/ItemsTable/EntityIconCheckBox.tsx b/frontend/src/metabase/common/components/ItemsTable/EntityIconCheckBox.tsx
new file mode 100644
index 00000000000..069c52415a3
--- /dev/null
+++ b/frontend/src/metabase/common/components/ItemsTable/EntityIconCheckBox.tsx
@@ -0,0 +1,74 @@
+import cx from "classnames";
+
+import { EntityIcon } from "metabase/common/components/EntityIcon";
+import { IconButtonWrapper } from "metabase/common/components/IconButtonWrapper";
+import { Swapper } from "metabase/common/components/Swapper";
+import type { IconData } from "metabase/common/utils/icon";
+import CS from "metabase/css/core/index.css";
+import { Checkbox, type IconProps } from "metabase/ui";
+
+import S from "./EntityIconCheckBox.module.css";
+
+type EntityIconCheckBoxProps = {
+ variant?: "list" | "small";
+ icon: IconProps | IconData;
+ pinned?: boolean;
+ selectable?: boolean;
+ selected?: boolean;
+ showCheckbox?: boolean;
+ disabled?: boolean;
+ onToggleSelected?: () => void;
+};
+export const EntityIconCheckBox = ({
+ variant = "list",
+ icon,
+ pinned,
+ selectable,
+ selected,
+ showCheckbox,
+ disabled,
+ onToggleSelected,
+}: EntityIconCheckBoxProps) => {
+ const isSmall = variant === "small";
+ const iconSize = isSmall ? 12 : 16;
+ const handleClick: React.MouseEventHandler<HTMLButtonElement> = (e) => {
+ e.preventDefault();
+ onToggleSelected?.();
+ // helps keyboard shortcuts work for collection items
+ e.currentTarget.focus();
+ };
+
+ return (
+ <IconButtonWrapper
+ className={cx(S.iconWrapper, {
+ [S.pinned]: pinned,
+ [S.disabled]: disabled,
+ })}
+ onClick={selectable ? handleClick : () => {}}
+ disabled={disabled}
+ >
+ {selectable ? (
+ <Swapper
+ defaultElement={
+ <EntityIcon
+ {...icon}
+ color={icon.color ?? "inherit"}
+ size={iconSize}
+ />
+ }
+ swappedElement={
+ <Checkbox
+ checked={selected}
+ size={isSmall ? "xs" : "sm"}
+ // Visual-only; clicks are handled by the wrapping button.
+ className={CS.pointerEventsNone}
+ />
+ }
+ isSwapped={selected || showCheckbox}
+ />
+ ) : (
+ <EntityIcon {...icon} color={icon.color ?? "inherit"} size={iconSize} />
+ )}
+ </IconButtonWrapper>
+ );
+};