Skip to content

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

Migrate remaining ModalContent Emotion styles to Mantine and fix dead EmbedModal header overrides (#77324)

Andrei Chernykh09e0cf1718f9
diff --git a/frontend/src/metabase/common/components/ModalContent/ModalContent.styled.ts b/frontend/src/metabase/common/components/ModalContent/ModalContent.styled.ts
deleted file mode 100644
index dc470f8c0a2..00000000000
--- a/frontend/src/metabase/common/components/ModalContent/ModalContent.styled.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// eslint-disable-next-line no-restricted-imports
-import styled from "@emotion/styled";
-
-import { Icon } from "metabase/ui";
-
-export const ActionsWrapper = styled.div`
- display: flex;
- flex-direction: row;
- gap: 0.5rem;
-`;
-
-export const ModalContentActionIcon = styled(Icon)`
- color: var(--mb-color-text-disabled);
- cursor: pointer;
-
- &:hover {
- color: var(--mb-color-text-secondary);
- }
-`;
-
-export const ModalHeaderBackIcon = styled(ModalContentActionIcon)`
- flex-shrink: 0;
-
- :hover {
- color: var(--mb-color-core-brand);
- }
-`;
diff --git a/frontend/src/metabase/common/components/ModalContent/ModalContent.unit.spec.tsx b/frontend/src/metabase/common/components/ModalContent/ModalContent.unit.spec.tsx
index f416e5273af..7b5858494b5 100644
--- a/frontend/src/metabase/common/components/ModalContent/ModalContent.unit.spec.tsx
+++ b/frontend/src/metabase/common/components/ModalContent/ModalContent.unit.spec.tsx
@@ -4,7 +4,7 @@ import { getIcon, render, screen } from "__support__/ui";
import type { ModalContentProps } from "./ModalContent";
import { ModalContent } from "./ModalContent";
-import { ModalContentActionIcon } from "./ModalContent.styled";
+import { ModalContentActionIcon } from "./ModalHeader";
describe("ModalContent", () => {
it("should render header action buttons", async () => {
@@ -44,12 +44,35 @@ describe("ModalContent", () => {
setup({ onBack });
- const backButton = screen.getByLabelText("chevronleft icon");
+ const backButton = screen.getByRole("button", { name: "Back" });
expect(backButton).toBeInTheDocument();
await userEvent.click(backButton);
expect(onBack).toHaveBeenCalledTimes(1);
});
+
+ it("should activate the back button with the keyboard", async () => {
+ const onBack = jest.fn();
+
+ setup({ onBack });
+
+ screen.getByRole("button", { name: "Back" }).focus();
+
+ await userEvent.keyboard("{Enter}");
+ expect(onBack).toHaveBeenCalledTimes(1);
+
+ await userEvent.keyboard(" ");
+ expect(onBack).toHaveBeenCalledTimes(2);
+ });
+
+ it("should go back when the title is clicked", async () => {
+ const onBack = jest.fn();
+
+ setup({ onBack });
+
+ await userEvent.click(screen.getByText(/Long Modal title/));
+ expect(onBack).toHaveBeenCalledTimes(1);
+ });
});
function setup({
diff --git a/frontend/src/metabase/common/components/ModalContent/ModalHeader.module.css b/frontend/src/metabase/common/components/ModalContent/ModalHeader.module.css
index ce0ea118c7e..53a905a212f 100644
--- a/frontend/src/metabase/common/components/ModalContent/ModalHeader.module.css
+++ b/frontend/src/metabase/common/components/ModalContent/ModalHeader.module.css
@@ -1,9 +1,9 @@
.HeaderText {
- font-weight: 700;
- flex-grow: 1;
display: flex;
align-items: center;
- color: var(--mb-color-text-primary);
+
+ /* kept in CSS so .clickable:hover can override it (style props render inline) */
+ color: var(--modal-header-text-color, var(--mb-color-text-primary));
&.HeaderTextCentered {
justify-content: center;
@@ -16,7 +16,6 @@
}
.HeaderTextContainer {
- flex-grow: 1;
overflow: hidden;
&.clickable:hover > * {
@@ -25,6 +24,19 @@
}
}
-.HeaderContainer {
- flex-shrink: 0;
+.actionIcon {
+ color: var(--mb-color-text-disabled);
+ cursor: pointer;
+
+ &:hover {
+ color: var(--mb-color-text-secondary);
+ }
+}
+
+.backButton {
+ color: var(--mb-color-text-disabled);
+
+ &:hover {
+ color: var(--mb-color-core-brand);
+ }
}
diff --git a/frontend/src/metabase/common/components/ModalContent/ModalHeader.tsx b/frontend/src/metabase/common/components/ModalContent/ModalHeader.tsx
index b58680c8ce4..1f67f6e13ad 100644
--- a/frontend/src/metabase/common/components/ModalContent/ModalHeader.tsx
+++ b/frontend/src/metabase/common/components/ModalContent/ModalHeader.tsx
@@ -1,25 +1,28 @@
import cx from "classnames";
import type { ReactNode } from "react";
+import { t } from "ttag";
-import { Flex, Title } from "metabase/ui";
+import type { IconProps, MantineStyleProps } from "metabase/ui";
+import { Flex, Icon, Title, UnstyledButton } from "metabase/ui";
-import {
- ActionsWrapper,
- ModalContentActionIcon,
- ModalHeaderBackIcon,
-} from "./ModalContent.styled";
import S from "./ModalHeader.module.css";
import type { CommonModalProps } from "./types";
+export const ModalContentActionIcon = ({ className, ...props }: IconProps) => (
+ <Icon {...props} className={cx(S.actionIcon, className)} />
+);
+
export interface ModalHeaderProps extends CommonModalProps {
children: ReactNode;
className?: string;
+ py?: MantineStyleProps["py"];
}
export const ModalHeader = ({
children,
className,
+ py = "xl",
fullPageModal,
centeredTitle,
headerActions,
@@ -33,23 +36,41 @@ export const ModalHeader = ({
<Flex
gap="sm"
align="center"
- p="xl"
- className={cx(S.HeaderContainer, className)}
+ px="xl"
+ py={py}
+ flex="0 0 auto"
+ className={className}
data-testid="modal-header"
>
<Flex
align="center"
gap="sm"
+ flex="1 1 auto"
className={cx(S.HeaderTextContainer, {
[S.clickable]: !!onBack,
})}
onClick={onBack}
>
- {onBack && <ModalHeaderBackIcon name="chevronleft" />}
+ {onBack && (
+ <UnstyledButton
+ display="flex"
+ flex="0 0 auto"
+ className={S.backButton}
+ aria-label={t`Back`}
+ onClick={(event) => {
+ // the container's onClick also calls onBack; don't fire it twice
+ event.stopPropagation();
+ onBack();
+ }}
+ >
+ <Icon name="chevronleft" />
+ </UnstyledButton>
+ )}
<Title
order={3}
w="100%"
+ flex="1 1 auto"
className={cx(S.HeaderText, {
[S.HeaderTextCentered]: fullPageModal || centeredTitle,
})}
@@ -59,7 +80,7 @@ export const ModalHeader = ({
</Flex>
{hasActions && (
- <ActionsWrapper>
+ <Flex gap="sm">
{headerActions}
{onClose && (
<ModalContentActionIcon
@@ -68,7 +89,7 @@ export const ModalHeader = ({
onClick={onClose}
/>
)}
- </ActionsWrapper>
+ </Flex>
)}
</Flex>
);
diff --git a/frontend/src/metabase/common/components/ModalContent/index.ts b/frontend/src/metabase/common/components/ModalContent/index.ts
index 8b593d3e21d..8c02cfefacc 100644
--- a/frontend/src/metabase/common/components/ModalContent/index.ts
+++ b/frontend/src/metabase/common/components/ModalContent/index.ts
@@ -1,5 +1,5 @@
export * from "./ModalContent";
-export { ModalContentActionIcon } from "./ModalContent.styled";
+export { ModalContentActionIcon } from "./ModalHeader";
export type { CommonModalProps } from "./types";
export { ModalHeader } from "./ModalHeader";
export type { ModalHeaderProps } from "./ModalHeader";
diff --git a/frontend/src/metabase/embedding/components/EmbedModal/EmbedModal.module.css b/frontend/src/metabase/embedding/components/EmbedModal/EmbedModal.module.css
new file mode 100644
index 00000000000..37ef14252f8
--- /dev/null
+++ b/frontend/src/metabase/embedding/components/EmbedModal/EmbedModal.module.css
@@ -0,0 +1,5 @@
+.embedModalHeader {
+ --modal-header-text-color: var(--mb-color-text-secondary);
+
+ border-bottom: 1px solid var(--mb-color-border-neutral);
+}
diff --git a/frontend/src/metabase/embedding/components/EmbedModal/EmbedModal.styled.tsx b/frontend/src/metabase/embedding/components/EmbedModal/EmbedModal.styled.tsx
deleted file mode 100644
index de91c5652a6..00000000000
--- a/frontend/src/metabase/embedding/components/EmbedModal/EmbedModal.styled.tsx
+++ /dev/null
@@ -1,10 +0,0 @@
-// eslint-disable-next-line no-restricted-imports
-import styled from "@emotion/styled";
-
-import { ModalHeader } from "metabase/common/components/ModalContent";
-
-export const EmbedModalHeader = styled(ModalHeader)`
- padding: 1.5rem 2rem;
- color: var(--mb-color-text-secondary);
- border-bottom: 1px solid var(--mb-color-border-neutral);
-`;
diff --git a/frontend/src/metabase/embedding/components/EmbedModal/EmbedModal.tsx b/frontend/src/metabase/embedding/components/EmbedModal/EmbedModal.tsx
index 8437d72136f..6d2a998e5c3 100644
--- a/frontend/src/metabase/embedding/components/EmbedModal/EmbedModal.tsx
+++ b/frontend/src/metabase/embedding/components/EmbedModal/EmbedModal.tsx
@@ -1,5 +1,6 @@
import { t } from "ttag";
+import { ModalHeader } from "metabase/common/components/ModalContent";
import { StaticEmbedSetupPane } from "metabase/embedding/components/EmbedModal/StaticEmbedSetupPane";
import type {
EmbedResource,
@@ -9,7 +10,7 @@ import type {
import { Modal } from "metabase/ui";
import type { EmbeddingParameters } from "metabase-types/api";
-import { EmbedModalHeader } from "./EmbedModal.styled";
+import S from "./EmbedModal.module.css";
interface EmbedModalProps {
opened: boolean;
@@ -40,9 +41,14 @@ export const EmbedModal = ({
withCloseButton={false}
padding={0}
>
- <EmbedModalHeader onClose={onClose} onBack={onBack}>
+ <ModalHeader
+ py="lg"
+ className={S.embedModalHeader}
+ onClose={onClose}
+ onBack={onBack}
+ >
{t`Static embedding`}
- </EmbedModalHeader>
+ </ModalHeader>
<StaticEmbedSetupPane
resource={resource}