Skip to content

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

Design polishes for modular embedding and embedding setup guide (#64893)

Phoomparin Manob56f63252ba5
diff --git a/frontend/src/metabase/admin/components/RelatedSettingsSection/RelatedSettingsSection.module.css b/frontend/src/metabase/admin/components/RelatedSettingsSection/RelatedSettingsSection.module.css
new file mode 100644
index 00000000000..edb960654c0
--- /dev/null
+++ b/frontend/src/metabase/admin/components/RelatedSettingsSection/RelatedSettingsSection.module.css
@@ -0,0 +1,3 @@
+.relatedSettingCard:hover {
+ background: var(--mb-color-background-hover);
+}
diff --git a/frontend/src/metabase/admin/components/RelatedSettingsSection/RelatedSettingsSection.tsx b/frontend/src/metabase/admin/components/RelatedSettingsSection/RelatedSettingsSection.tsx
index b18c4a1617b..69628339794 100644
--- a/frontend/src/metabase/admin/components/RelatedSettingsSection/RelatedSettingsSection.tsx
+++ b/frontend/src/metabase/admin/components/RelatedSettingsSection/RelatedSettingsSection.tsx
@@ -11,6 +11,7 @@ import {
Text,
} from "metabase/ui";
+import S from "./RelatedSettingsSection.module.css";
import type { RelatedSettingItem } from "./constants";
export function RelatedSettingsSection({
@@ -57,6 +58,7 @@ const RelatedSettingCard = ({
data-testid="related-setting-card"
shadow="none"
h="3rem"
+ className={S.relatedSettingCard}
>
<Group gap="sm" align="center" h="100%">
<Icon name={icon} color="var(--mb-color-brand)" />
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 6ffdd79d32b..e77d4f7f070 100644
--- a/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/EmbeddingSdkSettings.tsx
+++ b/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/EmbeddingSdkSettings.tsx
@@ -1,4 +1,5 @@
import cx from "classnames";
+import { Link } from "react-router";
import { match } from "ts-pattern";
import { c, jt, t } from "ttag";
@@ -18,18 +19,8 @@ import {
PLUGIN_EMBEDDING_IFRAME_SDK_SETUP,
PLUGIN_EMBEDDING_SDK,
} from "metabase/plugins";
-import {
- Alert,
- Box,
- Button,
- Flex,
- Group,
- HoverCard,
- Icon,
- Text,
-} from "metabase/ui";
+import { Box, Button, Group, HoverCard, Icon, Stack, Text } from "metabase/ui";
-import { SettingHeader } from "../../SettingHeader";
import { AdminSettingInput } from "../../widgets/AdminSettingInput";
import S from "./EmbeddingSdkSettings.module.css";
@@ -145,17 +136,7 @@ export function EmbeddingSdkSettings() {
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,
@@ -171,6 +152,15 @@ export function EmbeddingSdkSettings() {
/>
) : undefined
}
+ actionButton={
+ isSimpleEmbedFeatureAvailable && (
+ <Link to="/embed-js" className={CS.cursorPointer}>
+ <Button variant="brand" size="sm">
+ {t`New embed`}
+ </Button>
+ </Link>
+ )
+ }
/>
<SdkSettingsCard
@@ -179,18 +169,17 @@ export function EmbeddingSdkSettings() {
settingKey="enable-embedding-sdk"
links={[
{
- type: "link",
icon: "bolt",
title: t`Quick start`,
href: sdkQuickStartUrl,
},
{
- type: "link",
icon: "reference",
title: t`Documentation`,
href: sdkDocumentationUrl,
},
]}
+ alertInfoText={apiKeyBannerText}
/>
<Box py="lg" px="xl" className={S.SectionCard}>
@@ -211,7 +200,7 @@ export function EmbeddingSdkSettings() {
</HoverCard.Target>
<HoverCard.Dropdown>
- <Box p="md" w={270}>
+ <Box p="md" w={270} bg="white">
<Text lh="lg" c="text-medium">
{corsHintText}
</Text>
@@ -229,40 +218,32 @@ export function EmbeddingSdkSettings() {
</Box>
{isEmbeddingAvailable && isHosted && (
- <Box>
- <SettingHeader
- id="version-pinning"
- title={t`Version pinning`}
- description={t`Metabase Cloud instances are automatically upgraded to new releases. SDK packages are strictly compatible with specific version of Metabase. You can request to pin your Metabase to a major version and upgrade your Metabase and SDK dependency in a coordinated fashion.`}
- />
- <Button
- size="compact-md"
- variant="outline"
- leftSection={<Icon size={12} name="mail" aria-hidden />}
- component={ExternalLink}
- fz="0.75rem"
- href="mailto:[email protected]"
- >{t`Request version pinning`}</Button>
+ <Box py="lg" px="xl" className={S.SectionCard}>
+ <Stack gap="xs">
+ <Text
+ htmlFor="version-pinning"
+ component="label"
+ c="text-primary"
+ fw="bold"
+ fz="lg"
+ >
+ {t`Version pinning`}
+ </Text>
+
+ <Text c="text-secondary" lh="lg" mb="sm">
+ {t`Metabase Cloud instances are automatically upgraded to new releases. SDK packages are strictly compatible with specific version of Metabase. You can request to pin your Metabase to a major version and upgrade your Metabase and SDK dependency in a coordinated fashion.`}
+ </Text>
+
+ <ExternalLink href="mailto:[email protected]">
+ <Group gap="sm" fw="bold" w="fit-content">
+ <Icon name="mail" size={14} aria-hidden />
+ <span>{t`Request version pinning`}</span>
+ </Group>
+ </ExternalLink>
+ </Stack>
</Box>
)}
- <Alert
- data-testid="sdk-settings-alert-info"
- px="xl"
- bg="none"
- bd="1px solid var(--mb-color-border)"
- >
- <Flex gap="sm">
- <Box>
- <Icon color="var(--mb-color-text-secondary)" name="info" mt="2px" />
- </Box>
-
- <Text c="text-medium" lh="lg">
- {apiKeyBannerText}
- </Text>
- </Flex>
- </Alert>
-
<RelatedSettingsSection
items={getModularEmbeddingRelatedSettingItems()}
/>
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
index 394f2b77deb..997977a28bc 100644
--- a/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/SdkSettingsCard/SdkSettingsCard.tsx
+++ b/frontend/src/metabase/admin/settings/components/EmbeddingSettings/EmbeddingSdkSettings/SdkSettingsCard/SdkSettingsCard.tsx
@@ -1,10 +1,7 @@
-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,
+ Alert,
+ Box,
Flex,
Group,
Icon,
@@ -16,9 +13,7 @@ import {
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 };
+type LinkItem = { icon: IconName; title: string; href: string };
export function SdkSettingsCard({
title,
@@ -27,6 +22,8 @@ export function SdkSettingsCard({
isFeatureEnabled = true,
links,
rightSideContent,
+ alertInfoText,
+ actionButton,
}: {
title: string;
description: string;
@@ -34,28 +31,11 @@ export function SdkSettingsCard({
isFeatureEnabled?: boolean;
links?: LinkItem[];
rightSideContent?: React.ReactNode;
+ alertInfoText?: React.ReactNode;
+ actionButton?: 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"
@@ -80,11 +60,50 @@ export function SdkSettingsCard({
/>
{rightSideContent}
</Group>
+
+ {alertInfoText && (
+ <Alert
+ data-testid="sdk-settings-alert-info"
+ mt="md"
+ bg="bg-light"
+ bd="1px solid var(--mb-color-border)"
+ >
+ <Flex gap="sm">
+ <Box>
+ <Icon
+ color="var(--mb-color-text-secondary)"
+ name="info"
+ mt="2px"
+ />
+ </Box>
+
+ <Text c="text-primary" lh="lg">
+ {alertInfoText}
+ </Text>
+ </Flex>
+ </Alert>
+ )}
</Stack>
- {hasLinksContent && (
- <Group px="xl" className={S.CardLinksSection} h="3.5rem" gap="xl">
- {links?.map(renderLink)}
+ {(hasLinksContent || actionButton) && (
+ <Group
+ px="xl"
+ className={S.CardLinksSection}
+ h="3.5rem"
+ justify="space-between"
+ >
+ <Group gap="xl">
+ {links?.map((link, index) => (
+ <ExternalLink key={index} href={link.href}>
+ <Group gap="sm" fw="bold">
+ <Icon name={link.icon} size={14} aria-hidden />
+ <span>{link.title}</span>
+ </Group>
+ </ExternalLink>
+ ))}
+ </Group>
+
+ {actionButton}
</Group>
)}
</Flex>
diff --git a/frontend/src/metabase/embedding/embedding-hub/components/EmbeddingHubAdminSettingsPage.tsx b/frontend/src/metabase/embedding/embedding-hub/components/EmbeddingHubAdminSettingsPage.tsx
index f6746565376..b97850ac149 100644
--- a/frontend/src/metabase/embedding/embedding-hub/components/EmbeddingHubAdminSettingsPage.tsx
+++ b/frontend/src/metabase/embedding/embedding-hub/components/EmbeddingHubAdminSettingsPage.tsx
@@ -11,7 +11,7 @@ import { EmbeddingHub } from "./EmbeddingHub";
export const EmbeddingHubAdminSettingsPage = () => {
return (
<Stack mx="auto" py="xl" gap="xl" maw={800}>
- <Stack gap="xs" ml="3rem">
+ <Stack gap="xs">
<Title
order={1}
c="var(--mb-color-text-primary)"
diff --git a/frontend/src/metabase/embedding/embedding-hub/components/StepperWithCards/StepperWithCards.module.css b/frontend/src/metabase/embedding/embedding-hub/components/StepperWithCards/StepperWithCards.module.css
index b815ceeea0c..2d54b5e21f2 100644
--- a/frontend/src/metabase/embedding/embedding-hub/components/StepperWithCards/StepperWithCards.module.css
+++ b/frontend/src/metabase/embedding/embedding-hub/components/StepperWithCards/StepperWithCards.module.css
@@ -63,6 +63,7 @@
.lockedStepCard {
cursor: not-allowed;
+ background-color: var(--mb-color-bg-light);
}
.stepCard:not(.lockedStepCard):hover {