Skip to content

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

Adjust link and action button layout for modular embedding cards (#63876)

Phoomparin Manof393237eb94d
diff --git a/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/EmbeddingSdkSettings.module.css b/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/EmbeddingSdkSettings.module.css
index ad148637caa..5a67e2b66b1 100644
--- a/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/EmbeddingSdkSettings.module.css
+++ b/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/EmbeddingSdkSettings.module.css
@@ -3,3 +3,7 @@
border: 1px solid var(--mb-color-border);
background: var(--mb-color-background);
}
+
+.CardLinksSection {
+ border-top: 1px solid var(--mb-color-border);
+}
diff --git a/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/EmbeddingSdkSettings.tsx b/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/EmbeddingSdkSettings.tsx
index 64301dcb36a..023a91ef940 100644
--- a/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/EmbeddingSdkSettings.tsx
+++ b/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/EmbeddingSdkSettings.tsx
@@ -26,16 +26,14 @@ import {
Group,
HoverCard,
Icon,
- Stack,
Text,
} from "metabase/ui";
import { SettingHeader } from "../../SettingHeader";
import { AdminSettingInput } from "../../widgets/AdminSettingInput";
-import { EmbeddingToggle } from "../EmbeddingToggle";
-import { LinkButton } from "../LinkButton";
import S from "./EmbeddingSdkSettings.module.css";
+import { SdkSettingsCard } from "./SdkSettingsCard/SdkSettingsCard";
const utmTags = {
utm_source: "product",
@@ -48,19 +46,19 @@ export function EmbeddingSdkSettings() {
const isEE = isEEBuild();
const isReactSdkEnabled = useSetting("enable-embedding-sdk");
- const isReactSdkFeatureEnabled = PLUGIN_EMBEDDING_SDK.isEnabled();
+ const isReactSdkFeatureAvailable = PLUGIN_EMBEDDING_SDK.isEnabled();
const isLocalhostCorsDisabled = useSetting("disable-cors-on-localhost");
const isSimpleEmbedEnabled = useSetting("enable-embedding-simple");
- const isSimpleEmbedFeatureEnabled =
+ const isSimpleEmbedFeatureAvailable =
PLUGIN_EMBEDDING_IFRAME_SDK_SETUP.isFeatureEnabled();
const isEmbeddingAvailable =
- isReactSdkFeatureEnabled || isSimpleEmbedFeatureEnabled;
+ isReactSdkFeatureAvailable || isSimpleEmbedFeatureAvailable;
const canEditSdkOrigins =
- (isReactSdkFeatureEnabled && isReactSdkEnabled) ||
- (isSimpleEmbedFeatureEnabled && isSimpleEmbedEnabled);
+ (isReactSdkFeatureAvailable && isReactSdkEnabled) ||
+ (isSimpleEmbedFeatureAvailable && isSimpleEmbedEnabled);
const isHosted = useSetting("is-hosted?");
@@ -143,103 +141,59 @@ export function EmbeddingSdkSettings() {
<SettingsPageWrapper title={t`Modular embedding`}>
<UpsellDevInstances location="embedding-page" />
- <Flex direction="column" p="xl" className={S.SectionCard} gap="md">
- <Stack gap="xs">
- <Text fz="h3" fw={600} c="text-dark">
- {t`SDK for React`}
- </Text>
-
- <Text c="var(--mb-color-text-secondary)" lh="lg">
- {t`Embed the full power of Metabase into your application to build a custom analytics experience and programmatically manage dashboards and data.`}
- </Text>
- </Stack>
-
- <Group gap="sm" align="center" justify="space-between" w="100%">
- <EmbeddingToggle
- settingKey="enable-embedding-sdk"
- labelPosition="right"
- aria-label={t`SDK for React toggle`}
- />
-
- <Group gap="md">
- <Button
- size="compact-xs"
- variant="outline"
- component={ExternalLink}
- href={sdkQuickStartUrl}
- rightSection={<Icon size={12} name="external" />}
- fz="sm"
- >
- {t`Quick start`}
- </Button>
-
- <Button
- size="compact-xs"
- variant="outline"
- component={ExternalLink}
- href={sdkDocumentationUrl}
- rightSection={<Icon size={12} name="external" />}
- fz="sm"
- >
- {t`Documentation`}
- </Button>
- </Group>
- </Group>
- </Flex>
-
- <Box p="xl" className={S.SectionCard}>
- <Flex direction="column" gap="md">
- <Stack gap="xs">
- <Text fz="h3" fw={600} c="text-dark">
- {t`Embedded Analytics JS`}
- </Text>
-
- <Text c="var(--mb-color-text-secondary)" lh="lg">
- {t`An easy-to-use library that lets you embed Metabase entities like charts, dashboards, or even the query builder into your own application using customizable components.`}
- </Text>
- </Stack>
-
- <Group gap="sm" align="center" justify="space-between" w="100%">
- <EmbeddingToggle
- labelPosition="right"
- settingKey="enable-embedding-simple"
- disabled={!isSimpleEmbedFeatureEnabled}
- aria-label={t`Embedded Analytics JS toggle`}
+ <SdkSettingsCard
+ title={t`Embedded Analytics JS`}
+ description={t`An easy-to-use library that lets you embed Metabase entities like charts, dashboards, or even the query builder into your own application using customizable components.`}
+ settingKey="enable-embedding-simple"
+ isFeatureEnabled={isSimpleEmbedFeatureAvailable}
+ links={[
+ ...(isSimpleEmbedFeatureAvailable
+ ? [
+ {
+ type: "button" as const,
+ title: t`New embed`,
+ to: "/embed-js",
+ },
+ ]
+ : []),
+ {
+ type: "link",
+ icon: "reference",
+ title: t`Documentation`,
+ href: embedJsDocumentationUrl?.url,
+ },
+ ]}
+ rightSideContent={
+ !isSimpleEmbedFeatureAvailable ? (
+ <UpsellEmbeddingButton
+ url="https://www.metabase.com/product/embedded-analytics"
+ campaign="embedded-analytics-js"
+ location="embedding-page"
+ size="default"
/>
+ ) : undefined
+ }
+ />
- {isSimpleEmbedFeatureEnabled ? (
- <Group gap="md">
- <LinkButton
- size="compact-xs"
- variant="outline"
- to="/embed-js"
- fz="sm"
- >
- {t`Try it out`}
- </LinkButton>
-
- <Button
- size="compact-xs"
- variant="outline"
- component={ExternalLink}
- href={embedJsDocumentationUrl?.url}
- rightSection={<Icon size={12} name="external" />}
- fz="sm"
- >
- {t`Documentation`}
- </Button>
- </Group>
- ) : (
- <UpsellEmbeddingButton
- url="https://www.metabase.com/product/embedded-analytics"
- campaign="embedded-analytics-js"
- location="embedding-page"
- size="default"
- />
- )}
- </Group>
- </Flex>
- </Box>
+ <SdkSettingsCard
+ title={t`SDK for React`}
+ description={t`Embed the full power of Metabase into your application to build a custom analytics experience and programmatically manage dashboards and data.`}
+ settingKey="enable-embedding-sdk"
+ links={[
+ {
+ type: "link",
+ icon: "bolt",
+ title: t`Quick start`,
+ href: sdkQuickStartUrl,
+ },
+ {
+ type: "link",
+ icon: "reference",
+ title: t`Documentation`,
+ href: sdkDocumentationUrl,
+ },
+ ]}
+ />
<Box py="lg" px="xl" className={S.SectionCard}>
<AdminSettingInput
diff --git a/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/SdkSettingsCard/SdkSettingsCard.tsx b/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/SdkSettingsCard/SdkSettingsCard.tsx
new file mode 100644
index 00000000000..394f2b77deb
--- /dev/null
+++ b/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/SdkSettingsCard/SdkSettingsCard.tsx
@@ -0,0 +1,92 @@
+import { Link } from "react-router";
+import { match } from "ts-pattern";
+
+import ExternalLink from "metabase/common/components/ExternalLink";
+import CS from "metabase/css/core/index.css";
+import {
+ Button,
+ Flex,
+ Group,
+ Icon,
+ type IconName,
+ Stack,
+ Text,
+} from "metabase/ui";
+
+import { EmbeddingToggle } from "../../EmbeddingToggle";
+import S from "../EmbeddingSdkSettings.module.css";
+
+type LinkItem =
+ | { type: "link"; icon: IconName; title: string; href: string }
+ | { type: "button"; title: string; to: string };
+
+export function SdkSettingsCard({
+ title,
+ description,
+ settingKey,
+ isFeatureEnabled = true,
+ links,
+ rightSideContent,
+}: {
+ title: string;
+ description: string;
+ settingKey: "enable-embedding-sdk" | "enable-embedding-simple";
+ isFeatureEnabled?: boolean;
+ links?: LinkItem[];
+ rightSideContent?: React.ReactNode;
+}) {
+ const hasLinksContent = links && links.length > 0;
+
+ const renderLink = (linkItem: LinkItem, index: number) =>
+ match(linkItem)
+ .with({ type: "button" }, ({ to, title }) => (
+ <Link key={index} to={to} className={CS.cursorPointer}>
+ <Button variant="brand" size="sm">
+ {title}
+ </Button>
+ </Link>
+ ))
+ .with({ type: "link" }, ({ icon, title, href }) => (
+ <ExternalLink key={index} href={href}>
+ <Group gap="sm" fw="bold">
+ <Icon name={icon} size={14} />
+ <span>{title}</span>
+ </Group>
+ </ExternalLink>
+ ))
+ .exhaustive();
+
+ return (
+ <Flex
+ direction="column"
+ className={S.SectionCard}
+ data-testid="sdk-setting-card"
+ >
+ <Stack gap="sm" px="xl" py="lg">
+ <Text fz="h3" fw={600} c="text-dark">
+ {title}
+ </Text>
+
+ <Text c="var(--mb-color-text-secondary)" lh="lg" mb="md">
+ {description}
+ </Text>
+
+ <Group justify="space-between" align="center">
+ <EmbeddingToggle
+ settingKey={settingKey}
+ labelPosition="right"
+ disabled={!isFeatureEnabled}
+ aria-label={`${title} toggle`}
+ />
+ {rightSideContent}
+ </Group>
+ </Stack>
+
+ {hasLinksContent && (
+ <Group px="xl" className={S.CardLinksSection} h="3.5rem" gap="xl">
+ {links?.map(renderLink)}
+ </Group>
+ )}
+ </Flex>
+ );
+}
diff --git a/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/tests/common.unit.spec.tsx b/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/tests/common.unit.spec.tsx
index 0ce22558983..660aa0defc3 100644
--- a/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/tests/common.unit.spec.tsx
+++ b/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/tests/common.unit.spec.tsx
@@ -156,6 +156,35 @@ describe("EmbeddingSdkSettings (OSS)", () => {
expect(within(toggleContainer!).getByText("Disabled")).toBeInTheDocument();
});
+
+ it("should not show embed button and docs when Embedded Analytics JS is not available", async () => {
+ setup({ tokenFeatures: { embedding_simple: false } });
+
+ const card = screen
+ .getAllByTestId("sdk-setting-card")
+ .find((card) => card.textContent?.includes("Embedded Analytics JS"));
+
+ // Upsell and documentation should be shown
+ expect(card).toHaveTextContent("Try for free");
+ expect(card).toHaveTextContent("Documentation");
+
+ // Call-to-action should not be shown
+ expect(card).not.toHaveTextContent("New embed");
+ });
+
+ it("should not show embed button on oss even if simple embedding is enabled", async () => {
+ await setup({
+ isEmbeddingSimpleEnabled: true,
+ tokenFeatures: { embedding_simple: false },
+ });
+
+ const card = screen
+ .getAllByTestId("sdk-setting-card")
+ .find((card) => card.textContent?.includes("Embedded Analytics JS"));
+
+ expect(card).not.toHaveTextContent("New embed");
+ expect(card).toHaveTextContent("Documentation");
+ });
});
function assertLegaleseModal() {
diff --git a/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/tests/simple-embedding.unit.spec.tsx b/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/tests/simple-embedding.unit.spec.tsx
index 2093c3741c4..5d1086ae8b0 100644
--- a/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/tests/simple-embedding.unit.spec.tsx
+++ b/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/tests/simple-embedding.unit.spec.tsx
@@ -26,9 +26,13 @@ describe("EmbeddingSdkSettings (EE with Simple Embedding feature)", () => {
const toggles = screen.getAllByRole("switch");
expect(toggles).toHaveLength(2);
- expect(screen.getByText("SDK for React")).toBeInTheDocument();
+ expect(
+ screen.getByRole("switch", { name: "SDK for React toggle" }),
+ ).toBeInTheDocument();
- expect(screen.getByText("Embedded Analytics JS")).toBeInTheDocument();
+ expect(
+ screen.getByRole("switch", { name: "Embedded Analytics JS toggle" }),
+ ).toBeInTheDocument();
});
it("should show legalese modal when Simple Embedding toggle is enabled", async () => {
@@ -40,9 +44,12 @@ describe("EmbeddingSdkSettings (EE with Simple Embedding feature)", () => {
expect(screen.queryByRole("dialog")).not.toBeInTheDocument();
- // Check the Simple Embedding toggle
- const toggles = screen.getAllByRole("switch");
- await userEvent.click(toggles[1]); // Second toggle is for Simple SDK Embedding
+ // Enable Embedded Analytics JS
+ const toggle = await screen.findByRole("switch", {
+ name: "Embedded Analytics JS toggle",
+ });
+
+ await userEvent.click(toggle);
// Should show the legalese modal
expect(screen.getByRole("dialog")).toBeInTheDocument();
@@ -58,8 +65,11 @@ describe("EmbeddingSdkSettings (EE with Simple Embedding feature)", () => {
showSdkEmbedTerms: false,
});
- const toggles = screen.getAllByRole("switch");
- await userEvent.click(toggles[1]); // Second toggle is for Simple SDK Embedding
+ const toggle = await screen.findByRole("switch", {
+ name: "Embedded Analytics JS toggle",
+ });
+
+ await userEvent.click(toggle);
await userEvent.click(screen.getByText("Agree and continue"));
expect(screen.queryByRole("dialog")).not.toBeInTheDocument();
@@ -73,6 +83,21 @@ describe("EmbeddingSdkSettings (EE with Simple Embedding feature)", () => {
});
});
+ it("should show embed button and docs when simple embedding is available", async () => {
+ await setup({
+ isEmbeddingSdkEnabled: false,
+ isEmbeddingSimpleEnabled: true,
+ showSdkEmbedTerms: false,
+ });
+
+ const card = screen
+ .getAllByTestId("sdk-setting-card")
+ .find((card) => card.textContent?.includes("Embedded Analytics JS"));
+
+ expect(card).toHaveTextContent("New embed");
+ expect(card).toHaveTextContent("Documentation");
+ });
+
describe("Authorized Origins input field", () => {
it("should be disabled when both SDK and simple embedding are disabled", async () => {
await setup({