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
import { useTrackSdkComponentMount } from "embedding-sdk-bundle/analytics/component-events";
import { withPublicComponentWrapper } from "embedding-sdk-bundle/components/private/PublicComponentWrapper";
import {
getCollectionIdSlugFromReference,
getCollectionIdValueFromReference,
} from "embedding-sdk-bundle/store/collections";
import type {
MetabaseDashboard,
SdkCollectionId,
} from "embedding-sdk-bundle/types";
import { skipToken, useGetCollectionQuery } from "metabase/api";
import { CreateDashboardModal as CreateDashboardModalCore } from "metabase/common/CreateDashboard/CreateDashboardModal";
import { useLocale } from "metabase/common/hooks";
import { useSelector } from "metabase/redux";
import { createDashboardModalSchema } from "./CreateDashboardModal.schema";
/**
* @expand
* @category CreateDashboardModal
*/
export interface CreateDashboardModalProps {
/**
* Initial collection in which to create a dashboard. You can use predefined system values like `root` or `personal`.
*/
initialCollectionId?: SdkCollectionId;
/**
* The collection to save the dashboard to. This will hide the collection picker from the save modal.
*/
targetCollection?: SdkCollectionId;
/**
* Whether the modal is open or not.
*/
isOpen?: boolean;
/**
* Handler to react on dashboard creation.
*/
onCreate: (dashboard: MetabaseDashboard) => void;
/**
* Handler to close modal component
*/
onClose?: () => void;
}
const CreateDashboardModalInner = ({
initialCollectionId = "personal",
targetCollection,
isOpen = true,
onCreate,
onClose,
}: CreateDashboardModalProps) => {
const { isLocaleLoading } = useLocale();
const collectionId = useSelector((state) =>
getCollectionIdValueFromReference(state, initialCollectionId),
);
const collectionIdSlug = useSelector((state) =>
getCollectionIdSlugFromReference(state, initialCollectionId),
);
const resolvedTargetCollection = useSelector((state) =>
targetCollection
? getCollectionIdValueFromReference(state, targetCollection)
: undefined,
);
const { isLoading: isCollectionQueryLoading } = useGetCollectionQuery(
// To avoid `/api/collection/undefined` and 404.
collectionIdSlug === null || collectionIdSlug === undefined
? skipToken
: { id: collectionIdSlug },
);
useTrackSdkComponentMount("CreateDashboardModal", null, {});
if (isLocaleLoading || isCollectionQueryLoading) {
return null;
}
return (
<CreateDashboardModalCore
opened={!isCollectionQueryLoading && isOpen}
onCreate={onCreate}
onClose={() => onClose?.()}
collectionId={collectionId}
targetCollection={resolvedTargetCollection}
/>
);
};
export const CreateDashboardModal = Object.assign(
withPublicComponentWrapper(CreateDashboardModalInner, {
supportsGuestEmbed: false,
}),
{ schema: createDashboardModalSchema },
);