Skip to content

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

Move card-embed editor extensions into documents (#79695)

Fraser5f6f2ba89225
diff --git a/frontend/lint/shared-tiers.mjs b/frontend/lint/shared-tiers.mjs
index 1ea92e5f6c8..4f7b1c002c5 100644
--- a/frontend/lint/shared-tiers.mjs
+++ b/frontend/lint/shared-tiers.mjs
@@ -40,6 +40,7 @@ const SHARED_UTILS_LEVELS = [
"shared/route-guards",
"shared/redux-store",
"shared/search-ui",
+ "shared/rich_text_editing",
],
];
@@ -64,7 +65,6 @@ const SHARED_DOMAIN = [
"shared/nav",
"shared/notifications",
"shared/palette",
- "shared/rich_text_editing",
"shared/static-viz",
"shared/status",
"shared/timelines",
@@ -118,10 +118,6 @@ const sharedRules = [
...TIERED_SHARED.map((type) => ({ from: [type], allow: [type] })),
// Transitional clusters: these domain modules still import each other, so both ways are allowed.
// Delete each entry once the imports are one-directional.
- {
- from: ["shared/metabot", "shared/rich_text_editing", "shared/comments"],
- allow: ["shared/metabot", "shared/rich_text_editing", "shared/comments"],
- },
{
from: ["shared/nav", "shared/palette"],
allow: ["shared/nav", "shared/palette"],
diff --git a/frontend/src/metabase/documents/components/Editor/DocumentCommandSuggestion.tsx b/frontend/src/metabase/documents/components/Editor/DocumentCommandSuggestion.tsx
index 212c47cda5e..b71ea27a936 100644
--- a/frontend/src/metabase/documents/components/Editor/DocumentCommandSuggestion.tsx
+++ b/frontend/src/metabase/documents/components/Editor/DocumentCommandSuggestion.tsx
@@ -8,17 +8,28 @@ import {
} from "metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion";
import { useSetting } from "metabase/settings";
+import { CreateNativeQuestionModal } from "../editor-extensions/CardEmbed/modals/CreateNativeQuestionModal";
+import { CreateStructuredQuestionModal } from "../editor-extensions/CardEmbed/modals/CreateStructuredQuestionModal";
+
+import { useNewQuestionOptions } from "./use-new-question-options";
+
type DocumentCommandSuggestionProps = Omit<
CommandSuggestionProps,
- "metabotCommand"
+ "metabotCommand" | "newQuestionOptions" | "newQuestionModals"
>;
+const NEW_QUESTION_MODALS = {
+ notebook: CreateStructuredQuestionModal,
+ native: CreateNativeQuestionModal,
+};
+
export const DocumentCommandSuggestion = forwardRef<
CommandSuggestionRef,
DocumentCommandSuggestionProps
>(function DocumentCommandSuggestion(props, ref) {
const { canUseMetabot } = useUserMetabotPermissions();
const metabotName = useSetting("metabot-name");
+ const newQuestionOptions = useNewQuestionOptions();
const metabotCommand = useMemo(
() => (canUseMetabot ? { name: metabotName } : null),
@@ -26,6 +37,12 @@ export const DocumentCommandSuggestion = forwardRef<
);
return (
- <CommandSuggestion {...props} ref={ref} metabotCommand={metabotCommand} />
+ <CommandSuggestion
+ {...props}
+ ref={ref}
+ metabotCommand={metabotCommand}
+ newQuestionOptions={newQuestionOptions}
+ newQuestionModals={NEW_QUESTION_MODALS}
+ />
);
});
diff --git a/frontend/src/metabase/documents/components/Editor/Editor.tsx b/frontend/src/metabase/documents/components/Editor/Editor.tsx
index 016b8106979..cf14834cda9 100644
--- a/frontend/src/metabase/documents/components/Editor/Editor.tsx
+++ b/frontend/src/metabase/documents/components/Editor/Editor.tsx
@@ -21,7 +21,6 @@ import { useDispatch, useSelector, useStore } from "metabase/redux";
import type { State } from "metabase/redux/store";
import type { CardEmbedRef } from "metabase/redux/store/documents";
import { EditorBubbleMenu } from "metabase/rich_text_editing/tiptap/components/EditorBubbleMenu/EditorBubbleMenu";
-import { CardEmbed } from "metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedNode";
import { CommandExtension } from "metabase/rich_text_editing/tiptap/extensions/Command/CommandExtension";
import { CustomStarterKit } from "metabase/rich_text_editing/tiptap/extensions/CustomStarterKit/CustomStarterKit";
import { DisableMetabotSidebar } from "metabase/rich_text_editing/tiptap/extensions/DisableMetabotSidebar";
@@ -39,6 +38,8 @@ import { createSuggestionRenderer } from "metabase/rich_text_editing/tiptap/exte
import { getSetting } from "metabase/settings";
import { Box, Center, Loader } from "metabase/ui";
+import { CardEmbed } from "../editor-extensions/CardEmbed/CardEmbedNode";
+
import { DocumentBlockShell } from "./DocumentBlockShell";
import { DocumentCommandSuggestion } from "./DocumentCommandSuggestion";
import { DocumentEditorHostProvider } from "./DocumentEditorHost";
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/use-create-questions-menu-items.ts b/frontend/src/metabase/documents/components/Editor/use-new-question-options.ts
similarity index 61%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/use-create-questions-menu-items.ts
rename to frontend/src/metabase/documents/components/Editor/use-new-question-options.ts
index 216927bcf4d..3d68eebd7b1 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/use-create-questions-menu-items.ts
+++ b/frontend/src/metabase/documents/components/Editor/use-new-question-options.ts
@@ -4,49 +4,40 @@ import { t } from "ttag";
import { useListDatabasesQuery } from "metabase/api";
import { getHasDatabaseWithJsonEngine } from "metabase/databases/utils/predicates";
import { useSelector } from "metabase/redux";
+import type { NewQuestionOption } from "metabase/rich_text_editing/tiptap/extensions/Command/types";
import {
canUserCreateNativeQueries,
canUserCreateQueries,
} from "metabase/selectors/user";
-import type { NewQuestionMenuItem } from "./types";
-
-export const useCreateQuestionsMenuItems = ({
- onSelectItem,
-}: {
- onSelectItem: (item: "notebook" | "native") => void;
-}) => {
+export const useNewQuestionOptions = (): NewQuestionOption[] => {
const { data } = useListDatabasesQuery();
const databases = useMemo(() => data?.data ?? [], [data]);
const hasDatabaseWithJsonEngine = getHasDatabaseWithJsonEngine(databases);
const hasDataAccess = useSelector(canUserCreateQueries);
const hasNativeWrite = useSelector(canUserCreateNativeQueries);
- const items = useMemo(() => {
- const result: NewQuestionMenuItem[] = [];
+ return useMemo(() => {
+ const options: NewQuestionOption[] = [];
if (hasDataAccess) {
- result.push({
+ options.push({
label: t`New Question`,
icon: "insight",
- value: "notebook" as const,
- action: () => onSelectItem("notebook"),
+ value: "notebook",
});
}
if (hasNativeWrite) {
- result.push({
+ options.push({
label: hasDatabaseWithJsonEngine
? t`New Native query`
: t`New SQL query`,
icon: "sql",
- value: "native" as const,
- action: () => onSelectItem("native"),
+ value: "native",
});
}
- return result;
- }, [hasDataAccess, hasDatabaseWithJsonEngine, hasNativeWrite, onSelectItem]);
-
- return items;
+ return options;
+ }, [hasDataAccess, hasDatabaseWithJsonEngine, hasNativeWrite]);
};
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedMenuDropdown.tsx b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/CardEmbedMenuDropdown.tsx
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedMenuDropdown.tsx
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/CardEmbedMenuDropdown.tsx
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedNode.module.css b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/CardEmbedNode.module.css
similarity index 91%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedNode.module.css
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/CardEmbedNode.module.css
index efd150abb21..4c427e089b5 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedNode.module.css
+++ b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/CardEmbedNode.module.css
@@ -48,15 +48,6 @@
overflow: hidden; /* needed to constraint funnel chart */
}
-.loadingContainer {
- display: flex;
- align-items: center;
- gap: 0.5rem;
- padding: 1rem;
- height: 100%;
- justify-content: center;
-}
-
.titleContainer {
display: flex;
align-items: center;
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedNode.tsx b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/CardEmbedNode.tsx
similarity index 97%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedNode.tsx
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/CardEmbedNode.tsx
index fbe6c8be5f3..270b05e3c54 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedNode.tsx
+++ b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/CardEmbedNode.tsx
@@ -19,11 +19,23 @@ import type { QuestionPickerValueItem } from "metabase/common/components/Pickers
import { useDownloadData } from "metabase/common/components/QuestionDownloadWidget/use-download-data";
import { useDispatch, useSelector } from "metabase/redux";
import { useEditorHost } from "metabase/rich_text_editing/tiptap/EditorHost";
+import { CommentsButton } from "metabase/rich_text_editing/tiptap/components/CommentsButton";
+import { CardEmbedLoadingState } from "metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedLoadingState";
+import {
+ cleanupFlexContainerNodes,
+ findNodeParentAndPos,
+} from "metabase/rich_text_editing/tiptap/extensions/HandleEditorDrop/utils";
+import {
+ createIdAttribute,
+ createProseMirrorPlugin,
+} from "metabase/rich_text_editing/tiptap/extensions/NodeIds";
+import CS from "metabase/rich_text_editing/tiptap/extensions/extensions.module.css";
import {
EDITOR_STYLE_BOUNDARY_CLASS,
MAX_GROUP_SIZE,
} from "metabase/rich_text_editing/tiptap/extensions/shared/constants";
import { DropZone } from "metabase/rich_text_editing/tiptap/extensions/shared/dnd/DropZone";
+import { useDndHelpers } from "metabase/rich_text_editing/tiptap/extensions/shared/dnd/use-dnd-helpers";
import { useNavigate } from "metabase/router";
import { getMetadata } from "metabase/selectors/metadata";
import {
@@ -43,23 +55,13 @@ import { getDatasetError } from "metabase/visualizations/lib/errors";
import Question from "metabase-lib/v1/Question";
import type { CardDisplayType } from "metabase-types/api";
-import { CommentsButton } from "../../components/CommentsButton";
-import {
- cleanupFlexContainerNodes,
- findNodeParentAndPos,
-} from "../HandleEditorDrop/utils";
-import { createIdAttribute, createProseMirrorPlugin } from "../NodeIds";
-import CS from "../extensions.module.css";
-import { NativeQueryModal } from "../shared/NativeQueryModal";
-import { useDndHelpers } from "../shared/dnd/use-dnd-helpers";
-
-import { CardEmbedLoadingState } from "./CardEmbedLoadingState";
import { CardEmbedMenuDropdown } from "./CardEmbedMenuDropdown";
import styles from "./CardEmbedNode.module.css";
import { DocumentMode } from "./DocumentMode";
import { useExternalCardData } from "./ExternalCardDataContext";
import { ExternalDocumentCardMenu } from "./ExternalDocumentCardMenu";
import { ModifyQuestionModal } from "./modals/ModifyQuestionModal";
+import { NativeQueryModal } from "./modals/NativeQueryModal";
import { useUpdateCardOperations } from "./use-update-card-operations";
import { getEmbedIndex } from "./utils";
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/DocumentMode.ts b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/DocumentMode.ts
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/DocumentMode.ts
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/DocumentMode.ts
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/ExternalCardDataContext.tsx b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/ExternalCardDataContext.tsx
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/ExternalCardDataContext.tsx
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/ExternalCardDataContext.tsx
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/ExternalDocumentCardMenu.tsx b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/ExternalDocumentCardMenu.tsx
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/ExternalDocumentCardMenu.tsx
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/ExternalDocumentCardMenu.tsx
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CreateNativeQuestionModal.tsx b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/CreateNativeQuestionModal.tsx
similarity index 91%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CreateNativeQuestionModal.tsx
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/CreateNativeQuestionModal.tsx
index 98466af9fea..74f500d87cf 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CreateNativeQuestionModal.tsx
+++ b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/CreateNativeQuestionModal.tsx
@@ -2,7 +2,7 @@ import { useMemo } from "react";
import Question from "metabase-lib/v1/Question";
-import { NativeQueryModal } from "../shared/NativeQueryModal";
+import { NativeQueryModal } from "./NativeQueryModal";
interface CreateQuestionModalProps {
onSave: (id: number, name: string) => void;
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CreateStructuredQuestionModal.module.css b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/CreateStructuredQuestionModal.module.css
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CreateStructuredQuestionModal.module.css
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/CreateStructuredQuestionModal.module.css
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CreateStructuredQuestionModal.tsx b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/CreateStructuredQuestionModal.tsx
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CreateStructuredQuestionModal.tsx
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/CreateStructuredQuestionModal.tsx
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/modals/ModifyQuestionModal.module.css b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/ModifyQuestionModal.module.css
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/modals/ModifyQuestionModal.module.css
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/ModifyQuestionModal.module.css
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/modals/ModifyQuestionModal.tsx b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/ModifyQuestionModal.tsx
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/modals/ModifyQuestionModal.tsx
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/ModifyQuestionModal.tsx
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/NativeQueryModal.module.css b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/NativeQueryModal.module.css
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/NativeQueryModal.module.css
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/NativeQueryModal.module.css
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/NativeQueryModal.tsx b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/NativeQueryModal.tsx
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/NativeQueryModal.tsx
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/NativeQueryModal.tsx
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/use-update-card-operations.ts b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/use-update-card-operations.ts
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/use-update-card-operations.ts
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/use-update-card-operations.ts
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/utils.ts b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/utils.ts
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/utils.ts
rename to frontend/src/metabase/documents/components/editor-extensions/CardEmbed/utils.ts
diff --git a/frontend/src/metabase/documents/hooks/use-external-card-data.ts b/frontend/src/metabase/documents/hooks/use-external-card-data.ts
index 780e56c7273..720937f1ce9 100644
--- a/frontend/src/metabase/documents/hooks/use-external-card-data.ts
+++ b/frontend/src/metabase/documents/hooks/use-external-card-data.ts
@@ -3,11 +3,12 @@ import { useMemo } from "react";
import { skipToken, useGetPublicDocumentCardQueryQuery } from "metabase/api";
import { useSelector } from "metabase/redux";
import type { UseCardDataResult } from "metabase/rich_text_editing/tiptap/EditorHost";
-import { useExternalCardData } from "metabase/rich_text_editing/tiptap/extensions/CardEmbed/ExternalCardDataContext";
import { getMetadata } from "metabase/selectors/metadata";
import Question from "metabase-lib/v1/Question";
import type { Card, CardId, Dataset, RawSeries } from "metabase-types/api";
+import { useExternalCardData } from "../components/editor-extensions/CardEmbed/ExternalCardDataContext";
+
function buildSeries(card: Card, dataset: Dataset): RawSeries {
return [
{
diff --git a/frontend/src/metabase/public/containers/PublicDocument/PublicDocument.tsx b/frontend/src/metabase/public/containers/PublicDocument/PublicDocument.tsx
index 4f2cac4d866..c6262bf59f6 100644
--- a/frontend/src/metabase/public/containers/PublicDocument/PublicDocument.tsx
+++ b/frontend/src/metabase/public/containers/PublicDocument/PublicDocument.tsx
@@ -9,14 +9,14 @@ import { runRtkEndpoint } from "metabase/api/utils/run-rtk-endpoint";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import CS from "metabase/css/core/index.css";
import { DocumentEditorHostProvider } from "metabase/documents/components/Editor/DocumentEditorHost";
+import { CardEmbed } from "metabase/documents/components/editor-extensions/CardEmbed/CardEmbedNode";
+import { ExternalCardDataProvider } from "metabase/documents/components/editor-extensions/CardEmbed/ExternalCardDataContext";
import { EmbeddingEntityContextProvider } from "metabase/embedding/context";
import { MetabotNode } from "metabase/metabot/components/editor-extensions/MetabotEmbed";
import { EmbedFrame } from "metabase/public/components/EmbedFrame";
import { useEmbedFrameOptions } from "metabase/public/hooks";
import { useDispatch, useSelector } from "metabase/redux";
import { setErrorPage } from "metabase/redux/app";
-import { CardEmbed } from "metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedNode";
-import { ExternalCardDataProvider } from "metabase/rich_text_editing/tiptap/extensions/CardEmbed/ExternalCardDataContext";
import { CustomStarterKit } from "metabase/rich_text_editing/tiptap/extensions/CustomStarterKit/CustomStarterKit";
import { FlexContainer } from "metabase/rich_text_editing/tiptap/extensions/FlexContainer/FlexContainer";
import { ResizeNode } from "metabase/rich_text_editing/tiptap/extensions/ResizeNode/ResizeNode";
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedLoadingState.module.css b/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedLoadingState.module.css
new file mode 100644
index 00000000000..bfdb591e1d2
--- /dev/null
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedLoadingState.module.css
@@ -0,0 +1,14 @@
+.questionResults {
+ position: relative;
+ flex-grow: 1;
+ overflow: hidden;
+}
+
+.loadingContainer {
+ display: flex;
+ align-items: center;
+ gap: 0.5rem;
+ padding: 1rem;
+ height: 100%;
+ justify-content: center;
+}
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedLoadingState.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedLoadingState.tsx
index 63c9057f3d8..1afa24454da 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedLoadingState.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedLoadingState.tsx
@@ -1,6 +1,6 @@
import { Box, Loader, Stack } from "metabase/ui";
-import styles from "./CardEmbedNode.module.css";
+import styles from "./CardEmbedLoadingState.module.css";
export const CardEmbedLoadingState = () => {
return (
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.tsx
index 6bb0384d4ac..94c30fe7896 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.tsx
@@ -42,8 +42,13 @@ import { useEntitySuggestions } from "../shared/useEntitySuggestions";
import type { CommandProps } from "./CommandExtension";
import CommandS from "./CommandSuggestion.module.css";
import { NewQuestionTypeMenuView } from "./NewQuestionTypeMenuView";
-import type { CommandOption, CommandSection } from "./types";
-import { useCreateQuestionsMenuItems } from "./use-create-questions-menu-items";
+import type {
+ CommandOption,
+ CommandSection,
+ NewQuestionMenuItem,
+ NewQuestionModals,
+ NewQuestionOption,
+} from "./types";
import { type MetabotCommandConfig, getAllCommandSections } from "./utils";
export interface CommandSuggestionProps {
@@ -53,6 +58,8 @@ export interface CommandSuggestionProps {
range: Range;
query: string;
metabotCommand?: MetabotCommandConfig | null;
+ newQuestionOptions: NewQuestionOption[];
+ newQuestionModals: NewQuestionModals;
}
export interface CommandSuggestionRef {
@@ -101,7 +108,14 @@ export const CommandSuggestion = forwardRef<
CommandSuggestionRef,
CommandSuggestionProps
>(function CommandSuggestionComponent(
- { command, editor, query, metabotCommand },
+ {
+ command,
+ editor,
+ query,
+ metabotCommand,
+ newQuestionOptions,
+ newQuestionModals,
+ },
ref,
) {
const host = useEditorHost();
@@ -146,9 +160,14 @@ export const CommandSuggestion = forwardRef<
);
}, [viewMode, query, allowedCommandOptions]);
- const createQuestionsMenuItems = useCreateQuestionsMenuItems({
- onSelectItem: setNewQuestionType,
- });
+ const createQuestionsMenuItems: NewQuestionMenuItem[] = useMemo(
+ () =>
+ newQuestionOptions.map((option) => ({
+ ...option,
+ action: () => setNewQuestionType(option.value),
+ })),
+ [newQuestionOptions],
+ );
const areChartsAllowed = !editor.isActive("supportingText");
const canBrowseAll = areChartsAllowed || viewMode === "linkTo";
@@ -399,6 +418,7 @@ export const CommandSuggestion = forwardRef<
{viewMode === "newQuestionType" && (
<NewQuestionTypeMenuView
+ modals={newQuestionModals}
menuItems={createQuestionsMenuItems}
selectedIndex={selectedIndex}
setSelectedIndex={setSelectedIndex}
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.unit.spec.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.unit.spec.tsx
index 672cfb7a067..7f8ed8c2e2f 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.unit.spec.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.unit.spec.tsx
@@ -13,25 +13,21 @@ import { mockSettings } from "__support__/settings";
import { renderWithProviders, screen, within } from "__support__/ui";
import { createMockState } from "metabase/redux/store/mocks";
import { Input } from "metabase/ui";
-import { registerVisualizations } from "metabase/visualizations/register";
import { type RecentItem, isRecentTableItem } from "metabase-types/api";
import {
createMockDatabase,
createMockRecentCollectionItem,
createMockRecentTableItem,
createMockSearchResult,
- createMockUser,
- createMockUserPermissions,
} from "metabase-types/api/mocks";
import {
CommandSuggestion,
type CommandSuggestionProps,
} from "./CommandSuggestion";
+import type { NewQuestionOption } from "./types";
import type { MetabotCommandConfig } from "./utils";
-registerVisualizations();
-
const SEARCH_ITEMS = [
createMockSearchResult({
name: "Orders by product",
@@ -109,9 +105,19 @@ const TestWrapper = (props: CommandSuggestionProps) => {
type SetupProps = {
query?: string;
metabotCommand?: MetabotCommandConfig | null;
+ newQuestionOptions?: NewQuestionOption[];
+};
+
+const TEST_NEW_QUESTION_MODALS = {
+ notebook: () => null,
+ native: () => null,
};
-const setup = ({ query = "", metabotCommand = null }: SetupProps = {}) => {
+const setup = ({
+ query = "",
+ metabotCommand = null,
+ newQuestionOptions = [],
+}: SetupProps = {}) => {
const command = jest.fn();
const editor = {
@@ -135,6 +141,8 @@ const setup = ({ query = "", metabotCommand = null }: SetupProps = {}) => {
items={[]}
range={{ from: 0, to: 0 }}
metabotCommand={metabotCommand}
+ newQuestionOptions={newQuestionOptions}
+ newQuestionModals={TEST_NEW_QUESTION_MODALS}
/>,
{ storeInitialState: createMockState({ settings: mockSettings({}) }) },
);
@@ -154,17 +162,14 @@ describe("CommandSuggestion", () => {
it("searches for possible card embeds by default", async () => {
const { command } = setup({ query: "Ord" });
- // Find cards that were searched for, with appropriate icons
+ // Find cards that were searched for. The per-display icon names come from
+ // the visualization registry, which isn't populated in this isolated spec.
expect(
- within(
- await screen.findByRole("option", { name: /Orders by product/ }),
- ).getByRole("img", { name: /bar/ }),
+ await screen.findByRole("option", { name: /Orders by product/ }),
).toBeInTheDocument();
expect(
- within(
- await screen.findByRole("option", { name: /Orders by category/ }),
- ).getByRole("img", { name: /pie/ }),
+ await screen.findByRole("option", { name: /Orders by category/ }),
).toBeInTheDocument();
// Should not find things that cannot be embedded as a card
@@ -360,6 +365,8 @@ describe("CommandSuggestion", () => {
query=""
items={[]}
range={{ from: 0, to: 0 }}
+ newQuestionOptions={[]}
+ newQuestionModals={TEST_NEW_QUESTION_MODALS}
/>,
{ storeInitialState: createMockState({ settings: mockSettings({}) }) },
);
@@ -402,17 +409,12 @@ describe("CommandSuggestion", () => {
query=""
items={[]}
range={{ from: 0, to: 0 }}
+ newQuestionOptions={[
+ { value: "notebook", label: "New Question", icon: "insight" },
+ ]}
+ newQuestionModals={TEST_NEW_QUESTION_MODALS}
/>,
- {
- storeInitialState: createMockState({
- currentUser: createMockUser({
- permissions: createMockUserPermissions({
- can_create_queries: true,
- }),
- }),
- settings: mockSettings({}),
- }),
- },
+ { storeInitialState: createMockState({ settings: mockSettings({}) }) },
);
await userEvent.click(await screen.findByRole("option", { name: "Chart" }));
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/NewQuestionTypeMenuView.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/NewQuestionTypeMenuView.tsx
index 864d18e0c1e..edb8512367d 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/NewQuestionTypeMenuView.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/NewQuestionTypeMenuView.tsx
@@ -2,9 +2,7 @@ import { useCallback, useLayoutEffect } from "react";
import { MenuItemComponent } from "metabase/rich_text_editing/tiptap/extensions/shared/MenuComponents";
-import { CreateNativeQuestionModal } from "./CreateNativeQuestionModal";
-import { CreateStructuredQuestionModal } from "./CreateStructuredQuestionModal";
-import type { NewQuestionMenuItem } from "./types";
+import type { NewQuestionMenuItem, NewQuestionModals } from "./types";
interface Props {
menuItems: NewQuestionMenuItem[];
@@ -14,6 +12,7 @@ interface Props {
setNewQuestionType: (type: "notebook" | "native" | null) => void;
onSave: (id: number, name: string) => void;
onClose: () => void;
+ modals: NewQuestionModals;
}
export const NewQuestionTypeMenuView = ({
@@ -24,6 +23,7 @@ export const NewQuestionTypeMenuView = ({
setNewQuestionType,
onSave,
onClose,
+ modals: { notebook: NotebookQuestionModal, native: NativeQuestionModal },
}: Props) => {
const handleSaveNewQuestion = useCallback(
(id: number, name: string) => {
@@ -52,17 +52,14 @@ export const NewQuestionTypeMenuView = ({
))}
{newQuestionType === "notebook" && (
- <CreateStructuredQuestionModal
+ <NotebookQuestionModal
onSave={handleSaveNewQuestion}
onClose={onClose}
/>
)}
{newQuestionType === "native" && (
- <CreateNativeQuestionModal
- onSave={handleSaveNewQuestion}
- onClose={onClose}
- />
+ <NativeQuestionModal onSave={handleSaveNewQuestion} onClose={onClose} />
)}
</>
);
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/types.ts b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/types.ts
index cd82c0b3a7d..93e90dcb931 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/types.ts
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/types.ts
@@ -1,4 +1,5 @@
import type { Editor } from "@tiptap/core";
+import type { ComponentType } from "react";
import type { MenuItem } from "metabase/rich_text_editing/tiptap/extensions/shared/MenuComponents";
import type { IconName } from "metabase-types/api";
@@ -18,3 +19,19 @@ export interface CommandSection {
export interface NewQuestionMenuItem extends MenuItem {
value: "native" | "notebook";
}
+
+export interface NewQuestionOption {
+ value: "native" | "notebook";
+ label: string;
+ icon: IconName;
+}
+
+export interface NewQuestionModalProps {
+ onSave: (id: number, name: string) => void;
+ onClose: () => void;
+}
+
+export interface NewQuestionModals {
+ notebook: ComponentType<NewQuestionModalProps>;
+ native: ComponentType<NewQuestionModalProps>;
+}