Skip to content

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

Migrate bubble Radio usages to pills and remove the deprecated Radio (#76668)

Oleh Kaa2e7326e0ad
diff --git a/e2e/test/scenarios/admin-2/tenants.cy.spec.ts b/e2e/test/scenarios/admin-2/tenants.cy.spec.ts
index ac23a26ed22..4a2ef86c58a 100644
--- a/e2e/test/scenarios/admin-2/tenants.cy.spec.ts
+++ b/e2e/test/scenarios/admin-2/tenants.cy.spec.ts
@@ -395,7 +395,7 @@ describe("Tenants - management", () => {
"exist",
]);
- cy.findByRole("radio", { name: "Databases" }).click({ force: true });
+ cy.findByRole("tab", { name: "Databases" }).click({ force: true });
cy.findByRole("menuitem", { name: "Sample Database" }).click();
assertPermissionTableColumnsExist([
@@ -431,7 +431,7 @@ describe("Tenants - management", () => {
cy.visit(`/admin/permissions/data/group/${tenantGroupId}`);
- cy.findByRole("radio", { name: "Groups" }).click({ force: true });
+ cy.findByRole("tab", { name: "Groups" }).click({ force: true });
cy.findByRole("menuitem", { name: "All tenant users" }).click();
diff --git a/e2e/test/scenarios/permissions/admin-permissions.cy.spec.js b/e2e/test/scenarios/permissions/admin-permissions.cy.spec.js
index 75da1683380..b07dd22ce53 100644
--- a/e2e/test/scenarios/permissions/admin-permissions.cy.spec.js
+++ b/e2e/test/scenarios/permissions/admin-permissions.cy.spec.js
@@ -282,7 +282,7 @@ describe("scenarios > admin > permissions", { tags: "@OSS" }, () => {
cy.findByText("You've made changes to permissions.");
// Switching to databases focus should not show any warnings
- cy.get("label").contains("Databases").click();
+ cy.findByRole("tab", { name: "Databases" }).click();
cy.url().should("include", "/admin/permissions/data/database");
H.modal().should("not.exist");
@@ -422,7 +422,7 @@ describe("scenarios > admin > permissions", { tags: "@OSS" }, () => {
groups: {},
revision: data.response.body.revision,
}).then(() => {
- cy.get("label").contains("Databases").click();
+ cy.findByRole("tab", { name: "Databases" }).click();
H.selectSidebarItem("Sample Database");
H.modal().findByText("Someone just changed permissions");
diff --git a/e2e/test/scenarios/permissions/create-queries.cy.spec.js b/e2e/test/scenarios/permissions/create-queries.cy.spec.js
index 8f6dd31da5d..ac9380afacd 100644
--- a/e2e/test/scenarios/permissions/create-queries.cy.spec.js
+++ b/e2e/test/scenarios/permissions/create-queries.cy.spec.js
@@ -225,7 +225,7 @@ describe("scenarios > admin > permissions > create queries > query builder and n
it("should allow setting create queries to 'query builder and native' in database view", () => {
cy.visit("/admin/permissions/");
- cy.get("label").contains("Databases").click();
+ cy.findByRole("tab", { name: "Databases" }).click();
// eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
cy.findByText("Select a database to see group permissions");
@@ -526,7 +526,7 @@ describe("scenarios > admin > permissions > create queries > query builder only"
it("should allow setting create queries to 'query builder only' in database view", () => {
cy.visit("/admin/permissions/");
- cy.get("label").contains("Databases").click();
+ cy.findByRole("tab", { name: "Databases" }).click();
// eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
cy.findByText("Select a database to see group permissions");
diff --git a/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/FormFieldEditor/FormFieldEditor.styled.tsx b/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/FormFieldEditor/FormFieldEditor.styled.tsx
index 90f221817cd..1fa3f6549a5 100644
--- a/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/FormFieldEditor/FormFieldEditor.styled.tsx
+++ b/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/FormFieldEditor/FormFieldEditor.styled.tsx
@@ -2,7 +2,6 @@
import styled from "@emotion/styled";
import { FormField } from "metabase/common/components/FormField";
-import { Radio } from "metabase/common/components/Radio";
import { darken } from "metabase/ui/colors";
export const FormFieldContainer = styled.div`
@@ -21,14 +20,6 @@ export const EditorContainer = styled(ContentContainer)`
display: flex;
padding: 1rem 1rem 0.85rem 0.85rem;
gap: var(--mantine-spacing-sm);
-
- ${Radio.RadioGroupVariants.join(", ")} {
- margin-top: 10px;
- }
-
- ${Radio.RadioContainerVariants.join(", ")} {
- padding: 4px 10px;
- }
`;
export const Column = styled.div<{ full?: boolean }>`
diff --git a/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/FormFieldEditor/FormFieldEditor.tsx b/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/FormFieldEditor/FormFieldEditor.tsx
index 0c07fd19487..4c08247cba1 100644
--- a/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/FormFieldEditor/FormFieldEditor.tsx
+++ b/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/FormFieldEditor/FormFieldEditor.tsx
@@ -7,8 +7,7 @@ import { ActionFormFieldWidget } from "metabase/actions/components/ActionFormFie
import { getFieldTypes, getInputTypes } from "metabase/actions/constants";
import type { ActionFormFieldProps } from "metabase/actions/types";
import { inputTypeHasOptions } from "metabase/actions/utils";
-import { Radio } from "metabase/common/components/Radio";
-import { Checkbox } from "metabase/ui";
+import { Checkbox, Group, Radio } from "metabase/ui";
import { isNotNull } from "metabase/utils/types";
import type {
FieldSettings,
@@ -125,16 +124,21 @@ function FormFieldEditor({
)}
</Header>
{isEditable && fieldSettings && (
- <>
- <Subtitle>{t`Field type`}</Subtitle>
- <Radio
- value={fieldSettings.fieldType}
- options={fieldTypeOptions}
- aria-label={t`Field type`}
- variant="bubble"
- onChange={handleChangeFieldType}
- />
- </>
+ <Radio.Group
+ label={<Subtitle>{t`Field type`}</Subtitle>}
+ value={fieldSettings.fieldType}
+ onChange={(value) => handleChangeFieldType(value as FieldType)}
+ >
+ <Group gap="lg">
+ {fieldTypeOptions.map((option) => (
+ <Radio
+ key={option.value}
+ value={option.value}
+ label={option.name}
+ />
+ ))}
+ </Group>
+ </Radio.Group>
)}
<Subtitle>{t`Appearance`}</Subtitle>
</Column>
diff --git a/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/FormFieldEditor/FormFieldEditor.unit.spec.tsx b/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/FormFieldEditor/FormFieldEditor.unit.spec.tsx
index 54ed2b290b2..2d9e72f600a 100644
--- a/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/FormFieldEditor/FormFieldEditor.unit.spec.tsx
+++ b/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/FormFieldEditor/FormFieldEditor.unit.spec.tsx
@@ -66,6 +66,9 @@ describe("FormFieldEditor", () => {
expect(screen.getByPlaceholderText(field.placeholder)).toBeInTheDocument();
expect(screen.getByLabelText("Field settings")).toBeInTheDocument();
expect(getIcon("grabber")).toBeInTheDocument();
+ expect(
+ screen.getByRole("radiogroup", { name: "Field type" }),
+ ).toBeInTheDocument();
});
it("handles field type change", async () => {
diff --git a/frontend/src/metabase/admin/permissions/components/EntityViewSwitch/EntityViewSwitch.tsx b/frontend/src/metabase/admin/permissions/components/EntityViewSwitch/EntityViewSwitch.tsx
index b26317e5129..4e0b6f9feaa 100644
--- a/frontend/src/metabase/admin/permissions/components/EntityViewSwitch/EntityViewSwitch.tsx
+++ b/frontend/src/metabase/admin/permissions/components/EntityViewSwitch/EntityViewSwitch.tsx
@@ -1,6 +1,6 @@
import { t } from "ttag";
-import { Radio } from "metabase/common/components/Radio";
+import { Tabs } from "metabase/ui";
import S from "./EntityViewSwitch.module.css";
@@ -16,21 +16,15 @@ export const EntityViewSwitch = ({
onChange,
}: EntityViewSwitchProps) => (
<div className={S.EntityViewSwitchRoot}>
- <Radio<string>
- variant="bubble"
- colorScheme="accent7"
- options={[
- {
- name: t`Groups`,
- value: "group",
- },
- {
- name: t`Databases`,
- value: "database",
- },
- ]}
+ <Tabs
+ variant="pills"
value={value}
- onChange={onChange}
- />
+ onChange={(value) => value && onChange(value)}
+ >
+ <Tabs.List>
+ <Tabs.Tab value="group">{t`Groups`}</Tabs.Tab>
+ <Tabs.Tab value="database">{t`Databases`}</Tabs.Tab>
+ </Tabs.List>
+ </Tabs>
</div>
);
diff --git a/frontend/src/metabase/common/components/Radio/Radio.stories.tsx b/frontend/src/metabase/common/components/Radio/Radio.stories.tsx
deleted file mode 100644
index fa77b8ef3b4..00000000000
--- a/frontend/src/metabase/common/components/Radio/Radio.stories.tsx
+++ /dev/null
@@ -1,51 +0,0 @@
-import { useArgs } from "@storybook/preview-api";
-import type { StoryFn } from "@storybook/react";
-
-import { Radio, type RadioProps } from "./Radio";
-
-export default {
- title: "Deprecated/Components/Radio",
- component: Radio,
-};
-
-const Template: StoryFn<RadioProps<any>> = (args) => {
- const [{ value }, updateArgs] = useArgs();
- const handleChange = (value: unknown) => updateArgs({ value });
-
- return <Radio {...args} value={value} onChange={handleChange} />;
-};
-Template.args = {
- value: "L",
- options: [
- { name: "Line", value: "L" },
- { name: "Area", value: "A" },
- { name: "Bar", value: "B" },
- ],
-};
-
-export const Default = {
- render: Template,
-
- args: {
- ...Template.args,
- variant: "normal",
- },
-};
-
-export const Underlined = {
- render: Template,
-
- args: {
- ...Template.args,
- variant: "underlined",
- },
-};
-
-export const Bubble = {
- render: Template,
-
- args: {
- ...Template.args,
- variant: "bubble",
- },
-};
diff --git a/frontend/src/metabase/common/components/Radio/Radio.styled.tsx b/frontend/src/metabase/common/components/Radio/Radio.styled.tsx
deleted file mode 100644
index f6e22c85f69..00000000000
--- a/frontend/src/metabase/common/components/Radio/Radio.styled.tsx
+++ /dev/null
@@ -1,160 +0,0 @@
-// eslint-disable-next-line no-restricted-imports
-import styled from "@emotion/styled";
-
-import { color, isDark, lighten, tint } from "metabase/ui/colors";
-
-import type { RadioColorScheme, RadioVariant } from "./types";
-
-interface RadioGroupProps {
- variant: RadioVariant;
- vertical: boolean;
-}
-
-const RadioGroup = styled.div<RadioGroupProps>`
- display: flex;
- flex-direction: ${(props) => (props.vertical ? "column" : "row")};
-`;
-
-export const RadioGroupNormal = styled(RadioGroup)`
- font-weight: bold;
-`;
-
-export const RadioGroupBubble = styled(RadioGroup)`
- display: flex;
-`;
-
-interface RadioLabelProps {
- variant: RadioVariant;
- vertical: boolean;
-}
-
-const RadioLabel = styled.label<RadioLabelProps>`
- display: block;
-`;
-
-export const RadioLabelNormal = styled(RadioLabel)`
- &:not(:last-child) {
- margin-right: ${(props) => (!props.vertical ? "2rem" : "")};
- margin-bottom: ${(props) => (props.vertical ? "0.5rem" : "")};
- }
-`;
-
-export const RadioLabelBubble = styled(RadioLabel)`
- &:not(:last-child) {
- margin-right: ${(props) => (!props.vertical ? "0.5rem" : "")};
- margin-bottom: ${(props) => (props.vertical ? "0.5rem" : "")};
- }
-`;
-
-export const RadioInput = styled.input`
- appearance: none;
- display: block;
- margin: 0;
- padding: 0;
-`;
-
-interface RadioContainerProps {
- checked: boolean;
- variant: RadioVariant;
- colorScheme: RadioColorScheme;
- disabled: boolean;
- showButtons: boolean;
-}
-
-const RadioContainer = styled.div<RadioContainerProps>`
- display: flex;
- align-items: center;
- cursor: ${(props) => (props.disabled ? "" : "pointer")};
-
- &:hover {
- color: ${(props) =>
- !props.checked && !props.showButtons
- ? getSchemeColor(props.colorScheme)
- : ""};
- }
-
- ${RadioInput}:focus + & {
- outline: 2px solid var(--mb-color-focus);
- }
-
- ${RadioInput}:focus:not(:focus-visible) + & {
- outline: none;
- }
-`;
-
-export const RadioContainerNormal = styled(RadioContainer)`
- color: ${(props) => (props.checked ? getSchemeColor(props.colorScheme) : "")};
-`;
-
-export const RadioContainerUnderlined = styled(RadioContainer)`
- color: ${(props) => (props.checked ? getSchemeColor(props.colorScheme) : "")};
- border-bottom: 3px solid
- ${(props) =>
- props.checked ? getSchemeColor(props.colorScheme) : "transparent"};
- padding: 1rem 0;
-`;
-
-export const RadioContainerBubble = styled(RadioContainer)`
- padding: 0.5rem 1rem;
- border-radius: 10rem;
- font-weight: bold;
- color: ${(props) =>
- props.checked
- ? color("text-primary-inverse")
- : getContrastSchemeColor(props.colorScheme)};
- background-color: ${(props) =>
- props.checked
- ? getSchemeColor(props.colorScheme)
- : lighten(getSchemeColor(props.colorScheme))};
-
- &:hover {
- color: ${(props) =>
- !props.checked && !props.showButtons
- ? getContrastSchemeColor(props.colorScheme)
- : ""};
- background-color: ${(props) =>
- props.checked ? "" : lighten(getSchemeColor(props.colorScheme), 0.38)};
- transition: background-color 300ms linear;
- }
-`;
-
-interface RadioButtonProps {
- checked: boolean;
- colorScheme: RadioColorScheme;
-}
-
-export const RadioButton = styled.span<RadioButtonProps>`
- display: block;
- flex: 0 0 auto;
- width: 0.75rem;
- height: 0.75rem;
- margin-right: 0.5rem;
- border: 2px solid white;
- border-radius: 0.75rem;
- box-shadow: 0 0 0 2px
- ${(props) =>
- props.checked
- ? getSchemeColor(props.colorScheme)
- : color("text-secondary")};
- background-color: ${(props) =>
- props.checked ? getSchemeColor(props.colorScheme) : "transparent"};
-`;
-
-export const RadioLabelText = styled.span`
- flex: 1 1 auto;
- display: block;
-`;
-
-const getSchemeColor = (colorScheme: RadioColorScheme): string => {
- switch (colorScheme) {
- case "default":
- return color("core-brand");
- case "accent7":
- return color("core-filter");
- }
-};
-
-const getContrastSchemeColor = (colorScheme: RadioColorScheme) => {
- const schemeColor = getSchemeColor(colorScheme);
- return isDark(schemeColor) ? tint(schemeColor, 0.5) : schemeColor;
-};
diff --git a/frontend/src/metabase/common/components/Radio/Radio.tsx b/frontend/src/metabase/common/components/Radio/Radio.tsx
deleted file mode 100644
index f2eb0a4c3b6..00000000000
--- a/frontend/src/metabase/common/components/Radio/Radio.tsx
+++ /dev/null
@@ -1,226 +0,0 @@
-import type { HTMLAttributes, Key, ReactNode, Ref } from "react";
-import { forwardRef, useCallback, useMemo } from "react";
-import _ from "underscore";
-
-import {
- RadioButton,
- RadioContainerBubble,
- RadioContainerNormal,
- RadioContainerUnderlined,
- RadioGroupBubble,
- RadioGroupNormal,
- RadioInput,
- RadioLabelBubble,
- RadioLabelNormal,
- RadioLabelText,
-} from "./Radio.styled";
-import type { RadioColorScheme, RadioVariant } from "./types";
-
-const VARIANTS = {
- normal: {
- RadioGroup: RadioGroupNormal,
- RadioLabel: RadioLabelNormal,
- RadioContainer: RadioContainerNormal,
- },
- underlined: {
- RadioGroup: RadioGroupNormal,
- RadioLabel: RadioLabelNormal,
- RadioContainer: RadioContainerUnderlined,
- },
- bubble: {
- RadioGroup: RadioGroupBubble,
- RadioLabel: RadioLabelBubble,
- RadioContainer: RadioContainerBubble,
- },
-};
-
-export interface RadioProps<TValue, TOption = RadioOption<TValue>> extends Omit<
- HTMLAttributes<HTMLDivElement>,
- "onChange"
-> {
- name?: string;
- value?: TValue;
- options: TOption[];
- optionKeyFn?: (option: TOption) => Key;
- optionNameFn?: (option: TOption) => ReactNode;
- optionValueFn?: (option: TOption) => TValue;
- variant?: RadioVariant;
- colorScheme?: RadioColorScheme;
- disabled?: boolean;
- vertical?: boolean;
- showButtons?: boolean;
- onChange?: (value: TValue) => void;
- onOptionClick?: (value: TValue) => void;
-}
-
-export interface RadioOption<TValue> {
- name: ReactNode;
- value: TValue;
-}
-
-const BaseRadio = forwardRef(function Radio<
- TValue,
- TOption = RadioOption<TValue>,
->(
- {
- name,
- value,
- options,
- optionKeyFn = getDefaultOptionKey,
- optionNameFn = getDefaultOptionName,
- optionValueFn = getDefaultOptionValue,
- variant = "normal",
- colorScheme = "default",
- disabled = false,
- vertical = false,
- showButtons = vertical && variant !== "bubble",
- onChange,
- onOptionClick,
- ...props
- }: RadioProps<TValue, TOption>,
- ref: Ref<HTMLDivElement>,
-) {
- const { RadioGroup } = VARIANTS[variant];
- const groupName = useMemo(() => name ?? _.uniqueId("radio-"), [name]);
-
- return (
- <RadioGroup
- {...props}
- role="radiogroup"
- ref={ref}
- variant={variant}
- vertical={vertical}
- >
- {options.map((option) => {
- const optionKey = optionKeyFn(option);
- const optionName = optionNameFn(option);
- const optionValue = optionValueFn(option);
- const optionChecked = value === optionValue;
-
- return (
- <RadioItem
- key={optionKey}
- name={groupName}
- checked={optionChecked}
- label={optionName}
- value={optionValue}
- variant={variant}
- colorScheme={colorScheme}
- disabled={disabled}
- vertical={vertical}
- showButtons={showButtons}
- onChange={onChange}
- onOptionClick={onOptionClick}
- />
- );
- })}
- </RadioGroup>
- );
-});
-
-interface RadioItemProps<TValue> {
- name: string;
- checked: boolean;
- label: ReactNode;
- value: TValue;
- variant: RadioVariant;
- colorScheme: RadioColorScheme;
- disabled: boolean;
- vertical: boolean;
- showButtons: boolean;
- onChange?: (value: TValue) => void;
- onOptionClick?: (value: TValue) => void;
-}
-
-const RadioItem = <TValue,>({
- checked,
- name,
- label,
- value,
- variant,
- colorScheme,
- disabled,
- vertical,
- showButtons,
- onChange,
- onOptionClick,
-}: RadioItemProps<TValue>): JSX.Element => {
- const { RadioLabel, RadioContainer } = VARIANTS[variant];
-
- const handleChange = useCallback(() => {
- onChange?.(value);
- }, [value, onChange]);
-
- const handleClick = useCallback(() => {
- onOptionClick?.(value);
- }, [value, onOptionClick]);
-
- return (
- <RadioLabel variant={variant} vertical={vertical} onClick={handleClick}>
- <RadioInput
- type="radio"
- name={name}
- value={String(value)}
- checked={checked}
- disabled={disabled}
- onChange={handleChange}
- />
- <RadioContainer
- checked={checked}
- variant={variant}
- colorScheme={colorScheme}
- disabled={disabled}
- showButtons={showButtons}
- >
- {showButtons && (
- <RadioButton checked={checked} colorScheme={colorScheme} />
- )}
- <RadioLabelText>{label}</RadioLabelText>
- </RadioContainer>
- </RadioLabel>
- );
-};
-
-const getDefaultOptionKey = <TValue, TOption>(option: TOption): Key => {
- if (isDefaultOption<TValue>(option)) {
- return String(option.value);
- } else {
- throw new TypeError();
- }
-};
-
-const getDefaultOptionName = <TValue, TOption>(option: TOption): ReactNode => {
- if (isDefaultOption<TValue>(option)) {
- return option.name;
- } else {
- throw new TypeError();
- }
-};
-
-const getDefaultOptionValue = <TValue, TOption>(option: TOption): TValue => {
- if (isDefaultOption<TValue>(option)) {
- return option.value;
- } else {
- throw new TypeError();
- }
-};
-
-function isDefaultOption<TValue>(
- option: unknown,
-): option is RadioOption<TValue> {
- return typeof option === "object";
-}
-
-/**
- * @deprecated: use Radio from "metabase/ui"
- */
-export const Radio = Object.assign(BaseRadio, {
- RadioGroupVariants: [RadioGroupBubble, RadioGroupNormal],
- RadioLabelVariants: [RadioLabelBubble, RadioLabelNormal],
- RadioLabelText: RadioLabelText,
- RadioContainerVariants: [
- RadioContainerBubble,
- RadioContainerNormal,
- RadioContainerUnderlined,
- ],
-});
diff --git a/frontend/src/metabase/common/components/Radio/Radio.unit.spec.tsx b/frontend/src/metabase/common/components/Radio/Radio.unit.spec.tsx
deleted file mode 100644
index b62e64661e3..00000000000
--- a/frontend/src/metabase/common/components/Radio/Radio.unit.spec.tsx
+++ /dev/null
@@ -1,20 +0,0 @@
-import userEvent from "@testing-library/user-event";
-
-import { render, screen } from "__support__/ui";
-
-import { Radio } from "./Radio";
-
-describe("Radio", () => {
- const options = [
- { name: "Line", value: "L" },
- { name: "Area", value: "A" },
- { name: "Bar", value: "B" },
- ];
-
- it("should receive focus on tab", async () => {
- render(<Radio options={options} />);
- await userEvent.tab();
-
- expect(screen.getByLabelText("Line")).toHaveFocus();
- });
-});
diff --git a/frontend/src/metabase/common/components/Radio/index.ts b/frontend/src/metabase/common/components/Radio/index.ts
deleted file mode 100644
index d97458bde0b..00000000000
--- a/frontend/src/metabase/common/components/Radio/index.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-export { Radio } from "./Radio";
-export type { RadioProps, RadioOption } from "./Radio";
diff --git a/frontend/src/metabase/common/components/Radio/types.ts b/frontend/src/metabase/common/components/Radio/types.ts
deleted file mode 100644
index 98717994d04..00000000000
--- a/frontend/src/metabase/common/components/Radio/types.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-export type RadioVariant = "normal" | "underlined" | "bubble";
-export type RadioColorScheme = "default" | "accent7";
diff --git a/frontend/src/metabase/common/data-studio/components/PaneHeader/PaneHeader.tsx b/frontend/src/metabase/common/data-studio/components/PaneHeader/PaneHeader.tsx
index 8e15a57dbeb..e2bf8573be7 100644
--- a/frontend/src/metabase/common/data-studio/components/PaneHeader/PaneHeader.tsx
+++ b/frontend/src/metabase/common/data-studio/components/PaneHeader/PaneHeader.tsx
@@ -1,4 +1,4 @@
-import type { ReactNode } from "react";
+import type { FC, ReactNode } from "react";
import { Link } from "react-router";
import { t } from "ttag";
@@ -16,6 +16,8 @@ import {
Group,
Stack,
type StackProps,
+ Tabs,
+ type TabsTabProps,
Tooltip,
} from "metabase/ui";
import type { IconName } from "metabase-types/api";
@@ -134,40 +136,45 @@ export function PaneHeaderInput({
type PaneHeaderTabsProps = {
tabs: PaneHeaderTab[];
- withBackground?: boolean;
};
-export function PaneHeaderTabs({ tabs, withBackground }: PaneHeaderTabsProps) {
+/**
+ * Mantine's `Tabs.Tab` is built with the non-polymorphic `factory`, so
+ * `component`/`to` aren't in its prop types. However it still accepts the
+ * prop and it works as expected, thus type casting.
+ */
+const LinkTab = Tabs.Tab as FC<
+ TabsTabProps & { component: typeof Link; to: string }
+>;
+
+function isTabSelected(tab: PaneHeaderTab, pathname: string) {
+ const { to, isSelected } = tab;
+ return typeof isSelected === "function"
+ ? isSelected(pathname)
+ : (isSelected ?? to === pathname);
+}
+
+export function PaneHeaderTabs({ tabs }: PaneHeaderTabsProps) {
const { pathname } = useSelector(getLocation);
- const backgroundColor = withBackground
- ? "background_page-secondary"
- : "transparent";
+ const activeTab = tabs.find((tab) => isTabSelected(tab, pathname));
return (
- <Group gap="sm">
- {tabs.map(({ label, to, icon, isGated, isSelected }) => {
- const selected =
- typeof isSelected === "function"
- ? isSelected(pathname)
- : (isSelected ?? to === pathname);
- return (
- <Button
+ <Tabs variant="pills" value={activeTab?.to ?? null}>
+ <Tabs.List>
+ {tabs.map(({ label, to, icon, isGated }) => (
+ <LinkTab
key={label}
+ value={to}
component={Link}
to={to}
- size="sm"
- radius="xl"
- c={selected ? "core-brand" : undefined}
- bg={selected ? "background_surface-selected" : backgroundColor}
- bd="none"
leftSection={icon != null ? <FixedSizeIcon name={icon} /> : null}
rightSection={isGated ? <UpsellGem.New size={14} /> : null}
>
{label}
- </Button>
- );
- })}
- </Group>
+ </LinkTab>
+ ))}
+ </Tabs.List>
+ </Tabs>
);
}
diff --git a/frontend/src/metabase/metrics/components/MetricHeader/MetricTabs/MetricTabs.unit.spec.tsx b/frontend/src/metabase/metrics/components/MetricHeader/MetricTabs/MetricTabs.unit.spec.tsx
index 529ac15a817..fc865ce2bac 100644
--- a/frontend/src/metabase/metrics/components/MetricHeader/MetricTabs/MetricTabs.unit.spec.tsx
+++ b/frontend/src/metabase/metrics/components/MetricHeader/MetricTabs/MetricTabs.unit.spec.tsx
@@ -83,7 +83,7 @@ describe("MetricTabs", () => {
function getTabLabels() {
return Array.from(
- document.querySelectorAll(".mb-mantine-Button-label"),
+ document.querySelectorAll(".mb-mantine-Tabs-tabLabel"),
).map((element) => element.textContent);
}
diff --git a/frontend/src/metabase/transforms/components/TransformHeader/TransformHeader.unit.spec.tsx b/frontend/src/metabase/transforms/components/TransformHeader/TransformHeader.unit.spec.tsx
index 3a612ff02b1..78bab699087 100644
--- a/frontend/src/metabase/transforms/components/TransformHeader/TransformHeader.unit.spec.tsx
+++ b/frontend/src/metabase/transforms/components/TransformHeader/TransformHeader.unit.spec.tsx
@@ -61,25 +61,23 @@ describe("TransformHeader", () => {
setup({ isEditMode: false });
expect(
- screen.getByRole("link", { name: "Definition" }),
- ).toBeInTheDocument();
- expect(screen.getByRole("link", { name: "Run" })).toBeInTheDocument();
- expect(
- screen.getByRole("link", { name: "Settings" }),
+ screen.getByRole("tab", { name: "Definition" }),
).toBeInTheDocument();
+ expect(screen.getByRole("tab", { name: "Run" })).toBeInTheDocument();
+ expect(screen.getByRole("tab", { name: "Settings" })).toBeInTheDocument();
});
it("should not render tabs when isEditMode is true", () => {
setup({ isEditMode: true });
expect(
- screen.queryByRole("link", { name: "Definition" }),
+ screen.queryByRole("tab", { name: "Definition" }),
).not.toBeInTheDocument();
expect(
- screen.queryByRole("link", { name: "Run" }),
+ screen.queryByRole("tab", { name: "Run" }),
).not.toBeInTheDocument();
expect(
- screen.queryByRole("link", { name: "Target" }),
+ screen.queryByRole("tab", { name: "Target" }),
).not.toBeInTheDocument();
});
});
@@ -95,7 +93,7 @@ describe("TransformHeader", () => {
setupEnterprisePlugins();
setup();
- const inspectLink = screen.getByRole("link", { name: /Inspect/ });
+ const inspectLink = screen.getByRole("tab", { name: /Inspect/ });
expect(inspectLink).toBeInTheDocument();
expect(within(inspectLink).getByTestId("upsell-gem")).toBeInTheDocument();
@@ -107,7 +105,7 @@ describe("TransformHeader", () => {
setup();
- const inspectLink = screen.getByRole("link", { name: "Inspect" });
+ const inspectLink = screen.getByRole("tab", { name: "Inspect" });
expect(inspectLink).toBeInTheDocument();
expect(
diff --git a/frontend/src/metabase/transforms/pages/JobRunListPage/JobRunListPage.unit.spec.tsx b/frontend/src/metabase/transforms/pages/JobRunListPage/JobRunListPage.unit.spec.tsx
index 4b8d8010d1f..dde29d296e3 100644
--- a/frontend/src/metabase/transforms/pages/JobRunListPage/JobRunListPage.unit.spec.tsx
+++ b/frontend/src/metabase/transforms/pages/JobRunListPage/JobRunListPage.unit.spec.tsx
@@ -91,7 +91,7 @@ describe("JobRunListPage", () => {
expect(await screen.findAllByText("Nightly job")).not.toHaveLength(0);
expect(
- screen.getByRole("link", { name: "Run history" }),
+ screen.getByRole("tab", { name: "Run history" }),
).toBeInTheDocument();
expect(await screen.findByText("Success")).toBeInTheDocument();
});
diff --git a/frontend/src/metabase/ui/components/navigation/Tabs/Tab.module.css b/frontend/src/metabase/ui/components/navigation/Tabs/Tab.module.css
index c87aa84c826..b54e5364adc 100644
--- a/frontend/src/metabase/ui/components/navigation/Tabs/Tab.module.css
+++ b/frontend/src/metabase/ui/components/navigation/Tabs/Tab.module.css
@@ -14,6 +14,16 @@
text-align: left; /* "start" for some reason doesn't work properly */
}
}
+
+ &[data-variant="pills"] .tab {
+ border-radius: 999px;
+ padding: 0.6rem 1rem;
+
+ &[data-active="true"] {
+ background-color: var(--mb-color-background_surface-selected);
+ color: var(--mb-color-core-brand);
+ }
+ }
}
[data-list-border-hidden] .list::before {
diff --git a/frontend/src/metabase/ui/components/navigation/Tabs/Tabs.mdx b/frontend/src/metabase/ui/components/navigation/Tabs/Tabs.mdx
index 77ea9072bd7..0f4a315e4b6 100644
--- a/frontend/src/metabase/ui/components/navigation/Tabs/Tabs.mdx
+++ b/frontend/src/metabase/ui/components/navigation/Tabs/Tabs.mdx
@@ -26,3 +26,19 @@ Our themed wrapper around [Mantine Tabs](https://v6.mantine.dev/core/tabs/).
<Canvas of={TabsStories.VerticalOrientation} />
<Canvas of={TabsStories.VerticalOrientationIcons} />
+
+### Pills
+
+Use the `pills` variant for a compact, toggle-like set of tabs.
+
+<Canvas of={TabsStories.Pills} />
+
+<Canvas of={TabsStories.PillsIcons} />
+
+### List border
+
+The `listBorder` prop (default variant only) controls the divider rendered under
+the tab list. Set it to `false` when the divider is drawn elsewhere — e.g. a
+border on a parent container — so the tabs don't draw a second line.
+
+<Canvas of={TabsStories.NoListBorder} />
diff --git a/frontend/src/metabase/ui/components/navigation/Tabs/Tabs.stories.tsx b/frontend/src/metabase/ui/components/navigation/Tabs/Tabs.stories.tsx
index 01d7a19cbd5..a089fcc47d2 100644
--- a/frontend/src/metabase/ui/components/navigation/Tabs/Tabs.stories.tsx
+++ b/frontend/src/metabase/ui/components/navigation/Tabs/Tabs.stories.tsx
@@ -10,6 +10,10 @@ const argTypes = {
options: ["horizontal", "vertical"],
control: { type: "inline-radio" },
},
+ variant: {
+ options: ["default", "pills"],
+ control: { type: "inline-radio" },
+ },
listBorder: {
control: { type: "boolean" },
},
@@ -100,3 +104,18 @@ export const NoListBorder = {
listBorder: false,
},
};
+
+export const Pills = {
+ render: DefaultTemplate,
+ args: {
+ variant: "pills",
+ },
+};
+
+export const PillsIcons = {
+ render: IconsTemplate,
+ name: "Pills, icons",
+ args: {
+ variant: "pills",
+ },
+};