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
feat(embed-js): Add docs hint for additional wizard properties (#69906)
Timofey Kachalovc8d8369fec5f
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/guest-embed-ee.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/guest-embed-ee.cy.spec.tsindex 3c74e0c46a9..e4562fcfcbb 100644--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/guest-embed-ee.cy.spec.ts+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/guest-embed-ee.cy.spec.ts@@ -183,6 +183,12 @@ describe("scenarios > embedding > sdk iframe embed setup > guest-embed", () => {.should("be.visible").should("be.disabled");+ getEmbedSidebar().findByTestId("behavior-docs-link").should("be.visible");+ getEmbedSidebar()+ .findByTestId("behavior-docs-link")+ .should("have.attr", "href")+ .and("include", "embedding/guest-embedding");+H.setEmbeddingParameter("Text", "Locked");cy.findAllByTestId("parameter-widget").find("input").type("Foo Bar Baz");diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.tsindex 92200860d38..c302820cf18 100644--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts@@ -681,6 +681,29 @@ describe(suiteTitle, () => {codeBlock().should("contain", 'with-alerts="true"');});+ it("shows a docs icon in behavior section depending on a component", () => {+ navigateToEmbedOptionsStep({+ experience: "chart",+ resourceName: QUESTION_NAME,+ preselectSso: true,+ });++ getEmbedSidebar().within(() => {+ cy.findByTestId("behavior-docs-link").should("be.visible");+ cy.findByTestId("behavior-docs-link")+ .should("have.attr", "href")+ .and("include", "embedding/components.html#question");++ cy.findByText("Back").click();+ cy.findByText("Back").click();++ cy.findByText("Metabot").click();+ cy.findByText("Next").click();++ cy.findByTestId("behavior-docs-link").should("not.exist");+ });+ });+["exploration", "chart"].forEach((experience) => {it(`toggles save button for ${experience}`, () => {navigateToEmbedOptionsStep(diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SelectEmbedOptionsStep.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SelectEmbedOptionsStep.tsxindex 735f38d7c70..0bf9eeb4a9e 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SelectEmbedOptionsStep.tsx+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SelectEmbedOptionsStep.tsx@@ -3,12 +3,13 @@ import { Link } from "react-router";import { P, match } from "ts-pattern";import { c, t } from "ttag";-import { useHasEmailSetup } from "metabase/common/hooks";+import { useDocsUrl, useHasEmailSetup } from "metabase/common/hooks";import type {MetabaseColors,MetabaseThemePreset,} from "metabase/embedding-sdk/theme";import {+ Anchor,Card,Checkbox,Divider,@@ -21,6 +22,7 @@ import {import { UPSELL_CAMPAIGN_BEHAVIOR } from "../analytics";import { useSdkIframeEmbedSetupContext } from "../context";+import { getBehaviorDocsUrlParams } from "../utils/get-behavior-docs-url-params";import { ColorCustomizationSection } from "./Appearance/ColorCustomizationSection";import { SimpleThemeSwitcherSection } from "./Appearance/SimpleThemeSwitcherSection";@@ -45,6 +47,12 @@ const BehaviorSection = () => {useSdkIframeEmbedSetupContext();const hasEmailSetup = useHasEmailSetup();+ const behaviorDocsParams = getBehaviorDocsUrlParams(settings);+ // eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- Only admins can see the EmbedJS Wizard+ const { url: behaviorDocsUrl } = useDocsUrl(behaviorDocsParams?.page ?? "", {+ anchor: behaviorDocsParams?.anchor,+ });+const behaviorSection = useMemo(() => {return match(settings).with(@@ -253,9 +261,27 @@ const BehaviorSection = () => {return (<Card p="md">- <Text size="lg" fw="bold" mb="md">- {t`Behavior`}- </Text>+ <Flex align="center" justify="space-between" gap="xs" mb="md">+ <Text size="lg" fw="bold">+ {t`Behavior`}+ </Text>+ {!!behaviorDocsParams?.page && (+ <Anchor+ data-testid="behavior-docs-link"+ href={behaviorDocsUrl}+ target="_blank"+ rel="noreferrer"+ c="brand"+ lh={1}+ >+ <Icon+ name="book_open"+ size={16}+ tooltip={t`See all properties in the docs`}+ />+ </Anchor>+ )}+ </Flex>{behaviorSection}</Card>diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/utils/get-behavior-docs-url-params.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/utils/get-behavior-docs-url-params.tsnew file mode 100644index 00000000000..733f2283808--- /dev/null+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/utils/get-behavior-docs-url-params.ts@@ -0,0 +1,25 @@+import { match } from "ts-pattern";++import type { SdkIframeEmbedSetupSettings } from "../types";++export type BehaviorDocsParams = { page: string; anchor?: string } | null;++export const getBehaviorDocsUrlParams = (+ settings: SdkIframeEmbedSetupSettings,+): BehaviorDocsParams => {+ if (settings.isGuest) {+ return { page: "embedding/guest-embedding" };+ }++ const anchor = match(settings.componentName)+ .with("metabase-question", () => "question")+ .with("metabase-dashboard", () => "dashboard")+ .with("metabase-browser", () => "browser")+ .otherwise(() => null);++ if (!anchor) {+ return null;+ }++ return { page: "embedding/components", anchor };+};diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/utils/get-behavior-docs-url-params.unit.spec.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/utils/get-behavior-docs-url-params.unit.spec.tsnew file mode 100644index 00000000000..59fc05037d1--- /dev/null+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/utils/get-behavior-docs-url-params.unit.spec.ts@@ -0,0 +1,53 @@+import type { SdkIframeEmbedSetupSettings } from "../types";++import {+ type BehaviorDocsParams,+ getBehaviorDocsUrlParams,+} from "./get-behavior-docs-url-params";++describe("getBehaviorDocsUrlParams", () => {+ it.each<{+ name: string;+ settings: Partial<SdkIframeEmbedSetupSettings>;+ expected: BehaviorDocsParams;+ }>([+ {+ name: "guest settings",+ settings: { isGuest: true, componentName: "metabase-question" },+ expected: { page: "embedding/guest-embedding" },+ },+ {+ name: "exploration template",+ settings: {+ isGuest: false,+ componentName: "metabase-question",+ template: "exploration",+ },+ expected: { page: "embedding/components", anchor: "question" },+ },+ {+ name: "metabase-question component",+ settings: { componentName: "metabase-question", questionId: 1 },+ expected: { page: "embedding/components", anchor: "question" },+ },+ {+ name: "metabase-dashboard component",+ settings: { componentName: "metabase-dashboard", dashboardId: 1 },+ expected: { page: "embedding/components", anchor: "dashboard" },+ },+ {+ name: "metabase-browser component",+ settings: { componentName: "metabase-browser" },+ expected: { page: "embedding/components", anchor: "browser" },+ },+ {+ name: "metabase-metabot component",+ settings: { componentName: "metabase-metabot" },+ expected: null,+ },+ ])("returns $expected for $name", ({ settings, expected }) => {+ expect(+ getBehaviorDocsUrlParams(settings as SdkIframeEmbedSetupSettings),+ ).toEqual(expected);+ });+});