Skip to content

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

UXW-603 unified picker for Document smart link (#67408)

Denis Berezin25091a2fd115
diff --git a/e2e/support/helpers/e2e-document-helpers.ts b/e2e/support/helpers/e2e-document-helpers.ts
index 8bf42e0d615..d7b857cb9fd 100644
--- a/e2e/support/helpers/e2e-document-helpers.ts
+++ b/e2e/support/helpers/e2e-document-helpers.ts
@@ -19,11 +19,11 @@ export const clearDocumentContent = () => {
documentContent().type("{selectAll}{backspace}");
};
-export const documentSuggestionDialog = () =>
+export const documentMentionDialog = () =>
cy.findByRole("dialog", { name: "Mention Dialog" });
-export const documentSuggestionItem = (name: RegExp | string) =>
- documentSuggestionDialog().findByRole("option", { name });
+export const documentMentionItem = (name: RegExp | string) =>
+ documentMentionDialog().findByRole("option", { name });
export const commandSuggestionDialog = () =>
cy.findByRole("dialog", { name: "Command Dialog" });
diff --git a/e2e/test/scenarios/documents/comments.cy.spec.ts b/e2e/test/scenarios/documents/comments.cy.spec.ts
index ab7f881baa2..3b5c7733edf 100644
--- a/e2e/test/scenarios/documents/comments.cy.spec.ts
+++ b/e2e/test/scenarios/documents/comments.cy.spec.ts
@@ -724,7 +724,7 @@ describe("document comments", () => {
startNewCommentIn1ParagraphDocument();
cy.realType("@");
- H.documentSuggestionDialog().within(() => {
+ H.documentMentionDialog().within(() => {
cy.findByText("Lorem ipsum").should("be.visible");
cy.findByText("First collection").should("be.visible");
cy.findByText("Browse all").should("be.visible");
@@ -732,14 +732,14 @@ describe("document comments", () => {
});
cy.realType("tAbLe");
- H.documentSuggestionDialog().within(() => {
+ H.documentMentionDialog().within(() => {
cy.findByText("Lorem ipsum").should("not.exist");
cy.findByText("Bobby Tables").should("be.visible");
cy.findByText("No Collection Tableton").should("be.visible");
});
cy.realType("s");
- H.documentSuggestionDialog().within(() => {
+ H.documentMentionDialog().within(() => {
cy.findByText("Bobby Tables").should("be.visible");
cy.findByText("Bobby Tables's Personal Collection").should(
"be.visible",
@@ -748,17 +748,17 @@ describe("document comments", () => {
});
cy.realPress("Enter");
- H.documentSuggestionDialog().should("not.exist");
+ H.documentMentionDialog().should("not.exist");
cy.log("closes suggestion dialog but not the comments modal on Esc");
cy.realType(" @no");
- H.documentSuggestionDialog().should("be.visible");
+ H.documentMentionDialog().should("be.visible");
cy.realPress("Escape");
- H.documentSuggestionDialog().should("not.exist");
+ H.documentMentionDialog().should("not.exist");
Comments.getSidebar().should("be.visible");
cy.realType("{backspace}{backspace}{backspace}@none");
- H.documentSuggestionDialog().findByText("None Tableton").click();
+ H.documentMentionDialog().findByText("None Tableton").click();
Comments.getSidebar().within(() => {
Comments.getNewThreadInput()
diff --git a/e2e/test/scenarios/documents/document-links.cy.spec.ts b/e2e/test/scenarios/documents/document-links.cy.spec.ts
index 7b5e7686a66..6fd16f184b4 100644
--- a/e2e/test/scenarios/documents/document-links.cy.spec.ts
+++ b/e2e/test/scenarios/documents/document-links.cy.spec.ts
@@ -132,5 +132,138 @@ describe("Links in documents", () => {
.icon("eye_crossed_out")
.should("exist");
});
+
+ it("should allow adding a smart link using the suggestion menu", () => {
+ cy.visit("/document/new");
+ H.documentContent().click();
+
+ cy.log("Trigger suggestion menu with /");
+ H.addToDocument("/", false);
+
+ cy.log("Select Link from the suggestion menu");
+ H.commandSuggestionItem("Link").click();
+
+ H.addToDocument(PRODUCTS_AVERAGE_BY_CATEGORY.name.substring(0, 5), false);
+
+ cy.log("Select the first item from the list");
+ H.commandSuggestionDialog().findAllByRole("option").first().click();
+
+ cy.log("Verify smart link was added");
+ H.documentContent()
+ .findByRole("link", {
+ name: new RegExp(PRODUCTS_AVERAGE_BY_CATEGORY.name),
+ })
+ .should("exist");
+ });
+
+ it("should allow adding a smart link using 'Browse all' option in suggestion menu", () => {
+ cy.visit("/document/new");
+
+ openLinkSuggestionBrowseAllPicker();
+
+ H.modal().within(() => {
+ cy.findByText("Choose an item to link").should("be.visible");
+ cy.findByTestId("tabs-view")
+ .should("be.visible")
+ .within(() => {
+ cy.findByText("Recents").should("be.visible");
+ cy.findByText("Tables").should("be.visible");
+ cy.findByText("Questions").should("be.visible");
+ cy.findByText("Models").should("be.visible");
+ cy.findByText("Dashboards").should("be.visible");
+ cy.findByText("Collections").should("be.visible");
+ });
+
+ cy.findByText("Dashboards").click();
+ cy.findByText("Orders in a dashboard").click();
+ cy.button("Select").should("be.visible").and("be.enabled").click();
+ });
+
+ cy.log("Verify dashboard smart link was added");
+ H.documentContent()
+ .findByRole("link", {
+ name: new RegExp("Orders in a dashboard"),
+ })
+ .should("exist");
+
+ cy.log("Add collection link");
+ H.addToDocument("", true);
+
+ openLinkSuggestionBrowseAllPicker();
+ H.modal().within(() => {
+ cy.findByText("Collections").click();
+ cy.findByText("All personal collections").click();
+
+ cy.log(
+ "Verify that synthetic collections are not available for using as links",
+ );
+ cy.button("Select").should("be.visible").and("be.disabled");
+
+ cy.findAllByText("Bobby Tables's Personal Collection")
+ .should("have.length", 2)
+ .last()
+ .click();
+ cy.button("Select").should("be.visible").and("be.enabled").click();
+ });
+
+ cy.log("Verify collection smart link was added");
+ H.documentContent()
+ .findByRole("link", {
+ name: new RegExp("Bobby Tables's Personal Collection"),
+ })
+ .should("exist");
+ });
+
+ it("should allow adding a smart link using 'Browse all' option in mention menu", () => {
+ cy.visit("/document/new");
+
+ openLinkMentionMenuBrowseAllPicker();
+
+ H.modal().within(() => {
+ cy.findByText("Choose an item to link").should("be.visible");
+ cy.findByTestId("tabs-view")
+ .should("be.visible")
+ .within(() => {
+ cy.findByText("Recents").should("be.visible");
+ cy.findByText("Tables").should("be.visible");
+ cy.findByText("Questions").should("be.visible");
+ cy.findByText("Models").should("be.visible");
+ cy.findByText("Dashboards").should("be.visible");
+ cy.findByText("Collections").should("be.visible");
+ });
+
+ cy.findByText("Tables").click();
+ cy.findByText("Products").click();
+ cy.button("Select").should("be.visible").and("be.enabled").click();
+ });
+
+ cy.log("Verify table smart link was added");
+ H.documentContent()
+ .findByRole("link", {
+ name: new RegExp("Products"),
+ })
+ .should("exist");
+ });
});
});
+
+function openLinkSuggestionBrowseAllPicker() {
+ H.documentContent().click();
+
+ cy.log("Trigger suggestion menu with /");
+ H.addToDocument("/", false);
+
+ cy.log("Select Link from the suggestion menu");
+ H.commandSuggestionItem("Link").click();
+
+ H.commandSuggestionItem(/Browse all/).click();
+}
+
+function openLinkMentionMenuBrowseAllPicker() {
+ H.documentContent().click();
+
+ cy.log("Trigger mention menu with @");
+ H.addToDocument("@", false);
+
+ H.documentMentionItem(/Browse all/).click();
+}
diff --git a/e2e/test/scenarios/documents/documents.cy.spec.ts b/e2e/test/scenarios/documents/documents.cy.spec.ts
index 7d7887702ce..8f485e5ea51 100644
--- a/e2e/test/scenarios/documents/documents.cy.spec.ts
+++ b/e2e/test/scenarios/documents/documents.cy.spec.ts
@@ -605,7 +605,7 @@ describe("documents", () => {
assertOnlyOneOptionActive(/Orders, Count$/, "mention");
- H.documentSuggestionDialog()
+ H.documentMentionDialog()
.findByRole("option", { name: /Browse all/ })
.realHover();
@@ -1375,7 +1375,7 @@ const assertOnlyOneOptionActive = (
dialog === "command"
? H.commandSuggestionDialog
: dialog === "mention"
- ? H.documentSuggestionDialog
+ ? H.documentMentionDialog
: H.documentMetabotDialog;
dialogContainer()
diff --git a/frontend/src/metabase/common/components/EntityPicker/components/EntityPickerModal/EntityPickerModal.tsx b/frontend/src/metabase/common/components/EntityPicker/components/EntityPickerModal/EntityPickerModal.tsx
index 72ec5445fe6..2007aac951d 100644
--- a/frontend/src/metabase/common/components/EntityPicker/components/EntityPickerModal/EntityPickerModal.tsx
+++ b/frontend/src/metabase/common/components/EntityPicker/components/EntityPickerModal/EntityPickerModal.tsx
@@ -229,62 +229,79 @@ export function EntityPickerModal<
return recentFilter(relevantModelRecents);
}, [recentItems, recentFilter, searchModels]);
- const tabs: EntityPickerTab<Id, Model, Item>[] = (function getTabs() {
- const computedTabs: EntityPickerTab<Id, Model, Item>[] = [];
- const hasRecentsTab =
- hydratedOptions.hasRecents && filteredRecents.length > 0;
- const hasSearchTab = !!searchQuery;
- // This is to prevent different tab being initially open and then flickering back
- // to recents tab once recents have loaded (due to computeInitialTab)
- const shouldOptimisticallyAddRecentsTabWhileLoading =
- defaultToRecentTab && isLoadingRecentItems;
-
- if (hasRecentsTab || shouldOptimisticallyAddRecentsTabWhileLoading) {
- computedTabs.push({
- id: RECENTS_TAB_ID,
- models: [],
- folderModels: [],
- displayName: t`Recents`,
- icon: "clock",
- render: ({ onItemSelect }) => (
- <RecentsTab
- isLoading={isLoadingRecentItems}
- recentItems={filteredRecents}
- selectedItem={selectedItem}
- onItemSelect={onItemSelect}
- />
- ),
- });
- }
+ const tabs: EntityPickerTab<Id, Model, Item>[] = useMemo(
+ function getTabs() {
+ const computedTabs: EntityPickerTab<Id, Model, Item>[] = [];
+ const hasRecentsTab =
+ hydratedOptions.hasRecents && filteredRecents.length > 0;
+ const hasSearchTab = !!searchQuery;
+ // This is to prevent different tab being initially open and then flickering back
+ // to recents tab once recents have loaded (due to computeInitialTab)
+ const shouldOptimisticallyAddRecentsTabWhileLoading =
+ defaultToRecentTab && isLoadingRecentItems;
+
+ if (hasRecentsTab || shouldOptimisticallyAddRecentsTabWhileLoading) {
+ computedTabs.push({
+ id: RECENTS_TAB_ID,
+ models: [],
+ folderModels: [],
+ displayName: t`Recents`,
+ icon: "clock",
+ render: ({ onItemSelect }) => (
+ <RecentsTab
+ isLoading={isLoadingRecentItems}
+ recentItems={filteredRecents}
+ selectedItem={selectedItem}
+ onItemSelect={onItemSelect}
+ />
+ ),
+ });
+ }
- computedTabs.push(...passedTabs);
-
- if (hasSearchTab) {
- computedTabs.push({
- id: SEARCH_TAB_ID,
- models: [],
- folderModels: [],
- displayName: getSearchTabText(finalSearchResults, searchQuery),
- icon: "search",
- render: ({ onItemSelect }) => (
- <SearchTab
- folder={selectedFolder}
- isLoading={isFetching}
- searchScope={searchScope}
- searchResults={finalSearchResults ?? []}
- searchEngine={data?.engine}
- searchRequestId={requestId}
- searchTerm={searchQuery}
- selectedItem={selectedItem}
- onItemSelect={onItemSelect}
- onSearchScopeChange={setSearchScope}
- />
- ),
- });
- }
+ computedTabs.push(...passedTabs);
+
+ if (hasSearchTab) {
+ computedTabs.push({
+ id: SEARCH_TAB_ID,
+ models: [],
+ folderModels: [],
+ displayName: getSearchTabText(finalSearchResults, searchQuery),
+ icon: "search",
+ render: ({ onItemSelect }) => (
+ <SearchTab
+ folder={selectedFolder}
+ isLoading={isFetching}
+ searchScope={searchScope}
+ searchResults={finalSearchResults ?? []}
+ searchEngine={data?.engine}
+ searchRequestId={requestId}
+ searchTerm={searchQuery}
+ selectedItem={selectedItem}
+ onItemSelect={onItemSelect}
+ onSearchScopeChange={setSearchScope}
+ />
+ ),
+ });
+ }
- return computedTabs;
- })();
+ return computedTabs;
+ },
+ [
+ data?.engine,
+ defaultToRecentTab,
+ filteredRecents,
+ finalSearchResults,
+ hydratedOptions.hasRecents,
+ isFetching,
+ isLoadingRecentItems,
+ passedTabs,
+ requestId,
+ searchQuery,
+ searchScope,
+ selectedFolder,
+ selectedItem,
+ ],
+ );
const hasTabs = tabs.length > 1;
const initialTabId = useMemo(
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 c53fbda1a79..3899a7b17a0 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
@@ -23,6 +23,7 @@ import {
import { getCurrentDocument } from "metabase/documents/selectors";
import { useSelector } from "metabase/lib/redux";
import { getBrowseAllItemIndex } from "metabase/rich_text_editing/tiptap/extensions/shared/suggestionUtils";
+import type { SuggestionPickerViewMode } from "metabase/rich_text_editing/tiptap/extensions/shared/types";
import {
Box,
Divider,
@@ -102,9 +103,7 @@ export const CommandSuggestion = forwardRef<
const document = useSelector(getCurrentDocument);
const [selectedIndex, setSelectedIndex] = useState(0);
- const [viewMode, setViewMode] = useState<
- "linkTo" | "embedQuestion" | "newQuestionType" | null
- >(null);
+ const [viewMode, setViewMode] = useState<SuggestionPickerViewMode>(null);
const [newQuestionType, setNewQuestionType] = useState<
"notebook" | "native" | null
>(null);
@@ -378,6 +377,7 @@ export const CommandSuggestion = forwardRef<
query={query}
searchResults={searchResults}
modal={entityModal}
+ viewMode={viewMode}
onModalSelect={entityHandlers.handleModalSelect}
onModalClose={entityHandlers.handleModalClose}
canBrowseAll
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Mention/MentionSuggestion.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Mention/MentionSuggestion.tsx
index 05238e172bb..8b1e083dd68 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Mention/MentionSuggestion.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Mention/MentionSuggestion.tsx
@@ -109,6 +109,7 @@ const MentionSuggestionComponent = forwardRef<
query={query}
searchResults={searchResults}
modal={modal}
+ viewMode="linkTo"
onModalSelect={handlers.handleModalSelect}
onModalClose={handlers.handleModalClose}
onItemHover={handlers.hoverHandler}
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/EntitySearchSection.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/EntitySearchSection.tsx
index 7bfbca0c4ab..9f3d8a87f00 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/EntitySearchSection.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/EntitySearchSection.tsx
@@ -1,16 +1,21 @@
import { t } from "ttag";
import { QuestionPickerModal } from "metabase/common/components/Pickers/QuestionPicker/components/QuestionPickerModal";
-import type { QuestionPickerValueItem } from "metabase/common/components/Pickers/QuestionPicker/types";
import type { MenuItem } from "metabase/documents/components/Editor/shared/MenuComponents";
import {
CreateNewQuestionFooter,
MenuItemComponent,
SearchResultsFooter,
} from "metabase/documents/components/Editor/shared/MenuComponents";
+import type {
+ SuggestionPickerModalType,
+ SuggestionPickerViewMode,
+} from "metabase/rich_text_editing/tiptap/extensions/shared/types";
import { Box, Divider, Text } from "metabase/ui";
import type { SearchResult } from "metabase-types/api";
+import { LinkedEntityPickerModalWithConfirm } from "./LinkedEntityPickerModal";
+import type { DocumentLinkedEntityPickerItemValue } from "./LinkedEntityPickerModal/types";
import { getBrowseAllItemIndex } from "./suggestionUtils";
interface EntitySearchSectionProps {
@@ -20,8 +25,9 @@ interface EntitySearchSectionProps {
onFooterClick: () => void;
query: string;
searchResults: SearchResult[];
- modal: "question-picker" | null;
- onModalSelect: (item: QuestionPickerValueItem) => void;
+ modal: SuggestionPickerModalType;
+ viewMode: SuggestionPickerViewMode;
+ onModalSelect: (item: DocumentLinkedEntityPickerItemValue) => void;
onModalClose: () => void;
onItemHover: (index: number) => void;
canBrowseAll?: boolean;
@@ -38,6 +44,7 @@ export function EntitySearchSection({
query,
searchResults,
modal,
+ viewMode,
onModalSelect,
onModalClose,
onItemHover,
@@ -106,12 +113,19 @@ export function EntitySearchSection({
onMouseEnter={() => onItemHover(browseAllItemIndex)}
/>
- {modal === "question-picker" && (
+ {modal === "question-picker" && viewMode !== "linkTo" && (
<QuestionPickerModal
onChange={onModalSelect}
onClose={onModalClose}
/>
)}
+
+ {modal === "question-picker" && viewMode === "linkTo" && (
+ <LinkedEntityPickerModalWithConfirm
+ onConfirm={onModalSelect}
+ onClose={onModalClose}
+ />
+ )}
</>
)}
</>
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/LinkedEntityPickerModal.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/LinkedEntityPickerModal.tsx
new file mode 100644
index 00000000000..d5ea9fc17a4
--- /dev/null
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/LinkedEntityPickerModal.tsx
@@ -0,0 +1,230 @@
+import { useMemo, useState } from "react";
+import { t } from "ttag";
+
+import { useSearchQuery } from "metabase/api";
+import {
+ EntityPickerModal,
+ type EntityPickerOptions,
+ type EntityPickerTab,
+} from "metabase/common/components/EntityPicker";
+import {
+ CollectionPicker,
+ type CollectionPickerStatePath,
+} from "metabase/common/components/Pickers/CollectionPicker";
+import {
+ DashboardPicker,
+ type DashboardPickerStatePath,
+} from "metabase/common/components/Pickers/DashboardPicker";
+import {
+ QuestionPicker,
+ type QuestionPickerStatePath,
+} from "metabase/common/components/Pickers/QuestionPicker";
+import {
+ TablePicker,
+ type TablePickerStatePath,
+} from "metabase/common/components/Pickers/TablePicker";
+
+import {
+ COLLECTION_PICKER_OPTIONS,
+ DASHBOARD_PICKER_OPTIONS,
+ ENTITY_PICKER_OPTIONS,
+ QUESTION_PICKER_OPTIONS,
+ RECENTS_CONTEXT,
+} from "./constants";
+import type {
+ DocumentLinkedEntityPickerItem,
+ DocumentLinkedEntityPickerItemId,
+ DocumentLinkedEntityPickerItemModel,
+} from "./types";
+import { getCanSelectItem, hasAvailableModels } from "./utils";
+
+interface LinkedEntityPickerModalProps {
+ value: DocumentLinkedEntityPickerItem | null;
+ options?: Partial<EntityPickerOptions>;
+ onChange: (value: DocumentLinkedEntityPickerItem) => void;
+ onConfirm?: () => void;
+ onClose: () => void;
+}
+
+export function LinkedEntityPickerModal({
+ value,
+ options,
+ onChange,
+ onClose,
+ onConfirm,
+}: LinkedEntityPickerModalProps) {
+ const [tablesPath, setTablesPath] = useState<TablePickerStatePath>();
+ const [questionsPath, setQuestionsPath] = useState<QuestionPickerStatePath>();
+ const [modelsPath, setModelsPath] = useState<QuestionPickerStatePath>();
+ const [metricsPath, setMetricsPath] = useState<QuestionPickerStatePath>();
+ const [dashboardsPath, setDashboardsPath] =
+ useState<DashboardPickerStatePath>();
+ const [collectionsPath, setCollectionsPath] =
+ useState<CollectionPickerStatePath>();
+
+ const { data: searchResponse, isLoading: isSearchLoading } = useSearchQuery({
+ models: ["card"],
+ limit: 0,
+ calculate_available_models: true,
+ });
+
+ const computedOptions = useMemo(
+ () => ({
+ ...ENTITY_PICKER_OPTIONS,
+ ...(options || null),
+ }),
+ [options],
+ );
+
+ const tabs = useMemo(() => {
+ const computedTabs: EntityPickerTab<
+ DocumentLinkedEntityPickerItemId,
+ DocumentLinkedEntityPickerItemModel,
+ DocumentLinkedEntityPickerItem
+ >[] = [];
+
+ computedTabs.push({
+ id: "tables-tab",
+ displayName: t`Tables`,
+ models: ["table"],
+ folderModels: ["database", "schema"],
+ icon: "table",
+ render: ({ onItemSelect }) => (
+ <TablePicker
+ value={undefined}
+ path={tablesPath}
+ onItemSelect={onItemSelect}
+ onPathChange={setTablesPath}
+ />
+ ),
+ });
+
+ if (hasAvailableModels(searchResponse, ["card"])) {
+ computedTabs.push({
+ id: "questions-tab",
+ displayName: t`Questions`,
+ models: ["card"],
+ folderModels: ["collection", "dashboard"],
+ icon: "table2",
+ render: ({ onItemSelect }) => (
+ <QuestionPicker
+ initialValue={undefined}
+ models={["card", "dashboard"]}
+ options={QUESTION_PICKER_OPTIONS}
+ path={questionsPath}
+ onInit={onItemSelect}
+ onItemSelect={onItemSelect}
+ onPathChange={setQuestionsPath}
+ />
+ ),
+ });
+ }
+
+ if (hasAvailableModels(searchResponse, ["dataset"])) {
+ computedTabs.push({
+ id: "models-tab",
+ displayName: t`Models`,
+ models: ["dataset"],
+ folderModels: ["collection"],
+ icon: "model",
+ render: ({ onItemSelect }) => (
+ <QuestionPicker
+ initialValue={undefined}
+ models={["dataset"]}
+ options={QUESTION_PICKER_OPTIONS}
+ path={modelsPath}
+ onInit={onItemSelect}
+ onItemSelect={onItemSelect}
+ onPathChange={setModelsPath}
+ />
+ ),
+ });
+ }
+
+ if (hasAvailableModels(searchResponse, ["metric"])) {
+ computedTabs.push({
+ id: "metrics-tab",
+ displayName: t`Metrics`,
+ models: ["metric"],
+ folderModels: ["collection"],
+ icon: "metric",
+ render: ({ onItemSelect }) => (
+ <QuestionPicker
+ initialValue={undefined}
+ models={["metric"]}
+ options={DASHBOARD_PICKER_OPTIONS}
+ path={metricsPath}
+ onInit={onItemSelect}
+ onItemSelect={onItemSelect}
+ onPathChange={setMetricsPath}
+ />
+ ),
+ });
+ }
+
+ if (hasAvailableModels(searchResponse, ["dashboard"])) {
+ computedTabs.push({
+ id: "dashboards-tab",
+ displayName: t`Dashboards`,
+ models: ["dashboard"],
+ folderModels: ["collection"],
+ icon: "dashboard",
+ render: ({ onItemSelect }) => (
+ <DashboardPicker
+ initialValue={undefined}
+ models={["dashboard"]}
+ options={QUESTION_PICKER_OPTIONS}
+ path={dashboardsPath}
+ onItemSelect={onItemSelect}
+ onPathChange={setDashboardsPath}
+ />
+ ),
+ });
+ }
+
+ computedTabs.push({
+ id: "collections-tab",
+ displayName: t`Collections`,
+ models: ["collection"],
+ folderModels: ["collection"],
+ icon: "collection",
+ render: ({ onItemSelect }) => (
+ <CollectionPicker
+ initialValue={undefined}
+ models={["collection"]}
+ options={COLLECTION_PICKER_OPTIONS}
+ path={collectionsPath}
+ onInit={onItemSelect}
+ onItemSelect={onItemSelect}
+ onPathChange={setCollectionsPath}
+ />
+ ),
+ });
+
+ return computedTabs;
+ }, [
+ searchResponse,
+ tablesPath,
+ questionsPath,
+ modelsPath,
+ metricsPath,
+ dashboardsPath,
+ collectionsPath,
+ ]);
+
+ return (
+ <EntityPickerModal
+ title={t`Choose an item to link`}
+ tabs={tabs}
+ initialValue={value || undefined}
+ selectedItem={value ?? null}
+ options={computedOptions}
+ recentsContext={RECENTS_CONTEXT}
+ isLoadingTabs={isSearchLoading}
+ canSelectItem={getCanSelectItem(value)}
+ onItemSelect={onChange}
+ onClose={onClose}
+ onConfirm={onConfirm}
+ />
+ );
+}
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/LinkedEntityPickerModalWithConfirm.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/LinkedEntityPickerModalWithConfirm.tsx
new file mode 100644
index 00000000000..142fe28c4cc
--- /dev/null
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/LinkedEntityPickerModalWithConfirm.tsx
@@ -0,0 +1,47 @@
+import { useCallback, useState } from "react";
+
+import { LinkedEntityPickerModal } from "./LinkedEntityPickerModal";
+import type {
+ DocumentLinkedEntityPickerItem,
+ DocumentLinkedEntityPickerItemValue,
+} from "./types";
+import { getCanSelectItem } from "./utils";
+
+interface LinkedEntityPickerModalWithConfirmProps {
+ onConfirm: (value: DocumentLinkedEntityPickerItemValue) => void;
+ onClose: () => void;
+}
+
+const EXTRA_OPTIONS = {
+ hasConfirmButtons: true,
+};
+
+export const LinkedEntityPickerModalWithConfirm = ({
+ onConfirm,
+ onClose,
+}: LinkedEntityPickerModalWithConfirmProps) => {
+ const [value, setValue] = useState<DocumentLinkedEntityPickerItem | null>(
+ null,
+ );
+
+ const handleChange = useCallback((value: DocumentLinkedEntityPickerItem) => {
+ setValue(value);
+ }, []);
+
+ const handleConfirm = useCallback(() => {
+ if (value && getCanSelectItem(value)) {
+ onConfirm(value);
+ }
+ onClose();
+ }, [onClose, onConfirm, value]);
+
+ return (
+ <LinkedEntityPickerModal
+ value={value}
+ options={EXTRA_OPTIONS}
+ onChange={handleChange}
+ onClose={onClose}
+ onConfirm={handleConfirm}
+ />
+ );
+};
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/constants.ts b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/constants.ts
new file mode 100644
index 00000000000..90337268dc6
--- /dev/null
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/constants.ts
@@ -0,0 +1,45 @@
+import {
+ type EntityPickerModalOptions,
+ defaultOptions,
+} from "metabase/common/components/EntityPicker";
+import type { CollectionPickerOptions } from "metabase/common/components/Pickers/CollectionPicker";
+import type { DashboardPickerOptions } from "metabase/common/components/Pickers/DashboardPicker";
+import type { QuestionPickerOptions } from "metabase/common/components/Pickers/QuestionPicker";
+import type { RecentContexts } from "metabase-types/api";
+
+export const DOCUMENT_LINK_MODELS = [
+ "card",
+ "dataset",
+ "metric",
+ "dashboard",
+ "collection",
+ "document",
+ "table",
+ "database",
+ "transform",
+] as const;
+export type DocumentLinkItemModel = (typeof DOCUMENT_LINK_MODELS)[number];
+
+export const RECENTS_CONTEXT: RecentContexts[] = ["selections"];
+
+export const ENTITY_PICKER_OPTIONS: EntityPickerModalOptions = {
+ ...defaultOptions,
+ hasConfirmButtons: false,
+ hasRecents: true,
+};
+
+export const QUESTION_PICKER_OPTIONS: QuestionPickerOptions = {
+ showRootCollection: true,
+ showPersonalCollections: true,
+};
+
+export const DASHBOARD_PICKER_OPTIONS: DashboardPickerOptions = {
+ showRootCollection: true,
+ showPersonalCollections: true,
+};
+
+export const COLLECTION_PICKER_OPTIONS: CollectionPickerOptions = {
+ showRootCollection: false,
+ showPersonalCollections: true,
+ showLibrary: false,
+};
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/index.ts b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/index.ts
new file mode 100644
index 00000000000..bd43e41916c
--- /dev/null
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/index.ts
@@ -0,0 +1,2 @@
+export * from "./LinkedEntityPickerModal";
+export * from "./LinkedEntityPickerModalWithConfirm";
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/types.ts b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/types.ts
new file mode 100644
index 00000000000..94c96d04757
--- /dev/null
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/types.ts
@@ -0,0 +1,28 @@
+import type { CollectionPickerItem } from "metabase/common/components/Pickers/CollectionPicker";
+import type { DashboardPickerItem } from "metabase/common/components/Pickers/DashboardPicker";
+import type { QuestionPickerItem } from "metabase/common/components/Pickers/QuestionPicker";
+import type {
+ DatabaseItem,
+ TableItem,
+ TablePickerItem,
+} from "metabase/common/components/Pickers/TablePicker";
+
+export type DocumentLinkedEntityPickerItem =
+ | TablePickerItem
+ | QuestionPickerItem
+ | CollectionPickerItem
+ | DashboardPickerItem;
+
+export type DocumentLinkedEntityPickerItemId =
+ DocumentLinkedEntityPickerItem["id"];
+
+export type DocumentLinkedEntityPickerItemModel =
+ DocumentLinkedEntityPickerItem["model"];
+
+export type DocumentLinkedEntityPickerItemValue =
+ // exclude "schema" item
+ | TableItem
+ | DatabaseItem
+ | QuestionPickerItem
+ | CollectionPickerItem
+ | DashboardPickerItem;
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/utils.ts b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/utils.ts
new file mode 100644
index 00000000000..0d6b782922d
--- /dev/null
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/utils.ts
@@ -0,0 +1,39 @@
+import type { TypeWithModel } from "metabase/common/components/EntityPicker";
+import {
+ PERSONAL_COLLECTIONS,
+ ROOT_COLLECTION,
+} from "metabase/entities/collections";
+import type { SearchModel, SearchResponse } from "metabase-types/api";
+
+import { DOCUMENT_LINK_MODELS, type DocumentLinkItemModel } from "./constants";
+import type { DocumentLinkedEntityPickerItemValue } from "./types";
+
+export function hasAvailableModels(
+ response: SearchResponse | undefined,
+ models: SearchModel[],
+) {
+ const availableModels = response?.available_models ?? [];
+ return models.some((model) => availableModels.includes(model));
+}
+
+export const getCanSelectItem = (
+ item: TypeWithModel<string | number, string> | null,
+): item is DocumentLinkedEntityPickerItemValue => {
+ if (
+ item &&
+ DOCUMENT_LINK_MODELS.includes(item.model as DocumentLinkItemModel)
+ ) {
+ if (
+ item.model === "collection" &&
+ (!item.id ||
+ item.id === PERSONAL_COLLECTIONS.id ||
+ item.id === ROOT_COLLECTION.id)
+ ) {
+ return false;
+ }
+
+ return true;
+ }
+
+ return false;
+};
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/types.ts b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/types.ts
index f5a29ce8c0c..b651feaf2c1 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/types.ts
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/types.ts
@@ -1,3 +1,11 @@
import type { SearchModel } from "metabase-types/api";
-export type SuggestionModel = SearchModel | "transform" | "user";
+export type SuggestionModel = SearchModel | "user";
+
+export type SuggestionPickerModalType = "question-picker" | null;
+
+export type SuggestionPickerViewMode =
+ | "linkTo"
+ | "embedQuestion"
+ | "newQuestionType"
+ | null;
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/useEntitySuggestions.ts b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/useEntitySuggestions.ts
index 3b57f61e827..f3ea7ef4c73 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/useEntitySuggestions.ts
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/useEntitySuggestions.ts
@@ -1,9 +1,9 @@
import type { Editor, Range } from "@tiptap/core";
import { useCallback, useEffect, useMemo, useState } from "react";
-import type { QuestionPickerValueItem } from "metabase/common/components/Pickers/QuestionPicker/types";
import { getTranslatedEntityName } from "metabase/common/utils/model-names";
import { modelToUrl } from "metabase/lib/urls/modelToUrl";
+import type { DocumentLinkedEntityPickerItemValue } from "metabase/rich_text_editing/tiptap/extensions/shared/LinkedEntityPickerModal/types";
import type {
MentionableUser,
RecentItem,
@@ -15,7 +15,7 @@ import {
entityToUrlableModel,
getBrowseAllItemIndex,
} from "./suggestionUtils";
-import type { SuggestionModel } from "./types";
+import type { SuggestionModel, SuggestionPickerModalType } from "./types";
import { type EntitySearchOptions, useEntitySearch } from "./useEntitySearch";
interface UseEntitySuggestionsOptions {
@@ -42,7 +42,7 @@ interface UseEntitySuggestionsResult {
isLoading: boolean;
searchResults: SearchResult[];
selectedIndex: number;
- modal: "question-picker" | null;
+ modal: SuggestionPickerModalType;
totalItems: number;
selectedSearchModelName?: string;
handlers: {
@@ -51,7 +51,7 @@ interface UseEntitySuggestionsResult {
downHandler: () => void;
enterHandler: () => void;
onKeyDown: (props: { event: KeyboardEvent }) => boolean;
- handleModalSelect: (item: QuestionPickerValueItem) => void;
+ handleModalSelect: (item: DocumentLinkedEntityPickerItemValue) => void;
handleModalClose: () => void;
openModal: () => void;
hoverHandler: (index: number) => void;
@@ -73,7 +73,7 @@ export function useEntitySuggestions({
onTriggerCreateNewQuestion,
}: UseEntitySuggestionsOptions): UseEntitySuggestionsResult {
const [selectedIndex, setSelectedIndex] = useState(0);
- const [modal, setModal] = useState<"question-picker" | null>(null);
+ const [modal, setModal] = useState<SuggestionPickerModalType>(null);
const [selectedSearchModel, setSelectedSearchModel] =
useState<SuggestionModel | null>(null);
@@ -264,7 +264,7 @@ export function useEntitySuggestions({
);
const handleModalSelect = useCallback(
- (item: QuestionPickerValueItem) => {
+ (item: DocumentLinkedEntityPickerItemValue) => {
onSelectEntity({
id: item.id,
model: item.model,