The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
/* eslint-disable i18next/no-literal-string */
import cx from "classnames";
import { useState } from "react";
import wrenchImage from "assets/img/sdk-banner-wrench.svg";
import { DEFAULT_FONT } from "embedding-sdk-bundle/config";
import { useSdkDispatch } from "embedding-sdk-bundle/store";
import { setUsageProblem } from "embedding-sdk-bundle/store/reducer";
import type { SdkUsageProblem } from "embedding-sdk-bundle/types/usage-problem";
import { ExternalLink } from "metabase/common/components/ExternalLink";
import { DefaultLogoIcon } from "metabase/common/components/LogoIcon";
import { Button, Card, Flex, Icon, Popover, Stack, Text } from "metabase/ui";
import { originalColors } from "metabase/ui/colors";
import S from "./SdkUsageProblemBanner.module.css";
export interface SdkUsageProblemBannerProps {
problem: SdkUsageProblem | null;
}
// Prevent the usage problem banner from inheriting the theme colors,
// so they remain legible even when the theme is changed.
const unthemedTextDark = originalColors["text-primary"];
export const SdkUsageProblemBanner = ({
problem,
}: SdkUsageProblemBannerProps) => {
const [expanded, setExpanded] = useState(false);
const dispatch = useSdkDispatch();
if (!problem) {
return null;
}
const { title, severity } = problem;
// When the font family cannot be loaded from the MB instance,
// due to MB instance outage or missing CORS header,
// we fall back to the system font.
const fontFamily = `${DEFAULT_FONT}, sans-serif`;
// eslint-disable-next-line metabase/no-literal-metabase-strings -- shown in development
const pillTitle = "Metabase SDK";
return (
<Popover
position="top-start"
opened={expanded}
onChange={setExpanded}
// We don't want to render the popover within the portal,
// as this is used within a fixed-position container in a portal.
withinPortal={false}
>
<Popover.Target>
<Flex
onClick={() => setExpanded(!expanded)}
className={cx(S.Indicator)}
data-testid="sdk-usage-problem-indicator"
i-should-be-flex="true"
>
<Flex bg="core-white" px="sm" className={S.Logo} align="center">
<DefaultLogoIcon height={24} />
</Flex>
<Flex justify="center" align="center" className={S.Content}>
<img src={wrenchImage} alt="wrench" />
<Text ff={fontFamily} className={S.PillTitle} fw="bold" fz="xs">
{pillTitle}
</Text>
</Flex>
</Flex>
</Popover.Target>
<Popover.Dropdown className={S.PopoverDropdown}>
<Card
p="xl"
radius="sm"
maw="22rem"
data-testid="sdk-usage-problem-card"
>
<Stack gap="sm">
<Flex w="100%" justify="space-between">
<Text
fw="bold"
size="md"
style={{ color: unthemedTextDark }}
ff={fontFamily}
>
{title}
</Text>
</Flex>
<Text style={{ color: unthemedTextDark }} ff={fontFamily} fz="sm">
{problem.message}
</Text>
<Flex w="100%" justify="end" mt="sm" columnGap="lg">
<Button
variant="subtle"
ff={fontFamily}
onClick={() => {
dispatch(setUsageProblem(null));
}}
>
Hide {severity === "error" ? "error" : "warning"}
</Button>
<Button
component={ExternalLink}
ff={fontFamily}
href={problem.documentationUrl}
rightSection={<Icon aria-hidden name="external" />}
variant="light"
>
Documentation
</Button>
</Flex>
</Stack>
</Card>
</Popover.Dropdown>
</Popover>
);
};