Skip to content

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

Two quality-of-life improvements for @-mentions (#66131)

Noah Moss74b8adabe635
diff --git a/enterprise/frontend/src/metabase-enterprise/documents/components/Editor/shared/MenuComponents.tsx b/enterprise/frontend/src/metabase-enterprise/documents/components/Editor/shared/MenuComponents.tsx
index 5b4ac55e371..69fbac8c418 100644
--- a/enterprise/frontend/src/metabase-enterprise/documents/components/Editor/shared/MenuComponents.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/documents/components/Editor/shared/MenuComponents.tsx
@@ -1,4 +1,4 @@
-import type { DOMAttributes } from "react";
+import type { DOMAttributes, MouseEvent } from "react";
import { t } from "ttag";
import {
@@ -39,11 +39,11 @@ export const MenuItemComponent = ({
}: {
item: MenuItem;
isSelected?: boolean;
- onClick?: () => void;
+ onClick?: (e: MouseEvent<HTMLButtonElement>) => void;
} & DOMAttributes<HTMLButtonElement>) => (
<UnstyledButton
className={S.menuItem}
- onClick={onClick || item.action}
+ onClick={onClick || (() => item.action())}
role="option"
aria-selected={isSelected}
{...rest}
diff --git a/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/Mention/MentionSuggestion.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/Mention/MentionSuggestion.unit.spec.tsx
index c2cad42ee7a..d48efa0f255 100644
--- a/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/Mention/MentionSuggestion.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/Mention/MentionSuggestion.unit.spec.tsx
@@ -1,3 +1,4 @@
+import { fireEvent } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import type { Editor } from "@tiptap/core";
import fetchMock from "fetch-mock";
@@ -206,4 +207,71 @@ describe("MentionSuggestion", () => {
const models = urlObject.searchParams.getAll("models").sort();
expect(models).toEqual(["card", "dashboard", "table"]);
});
+
+ describe("cmd/ctrl+click behavior", () => {
+ beforeEach(() => {
+ jest.spyOn(window, "open").mockImplementation(() => null);
+ });
+
+ afterEach(() => {
+ jest.restoreAllMocks();
+ });
+
+ it("regular click inserts mention", async () => {
+ const { command } = setup({
+ query: "ord",
+ searchItems: [
+ createMockSearchResult({
+ name: "Orders question",
+ model: "card",
+ id: 1,
+ }),
+ ],
+ });
+
+ await userEvent.click(
+ await screen.findByRole("option", { name: /Orders question/ }),
+ );
+
+ expect(command).toHaveBeenCalledWith(
+ expect.objectContaining({
+ id: 1,
+ model: "card",
+ label: "Orders question",
+ }),
+ );
+ expect(window.open).not.toHaveBeenCalled();
+ });
+
+ it.each([
+ { modifier: "metaKey", label: "cmd+click (Mac)" },
+ { modifier: "ctrlKey", label: "ctrl+click (Windows/Linux)" },
+ ])(
+ "$label opens item in new tab instead of inserting mention",
+ async ({ modifier }) => {
+ const { command } = setup({
+ query: "ord",
+ searchItems: [
+ createMockSearchResult({
+ name: "Orders question",
+ model: "card",
+ id: 1,
+ }),
+ ],
+ });
+
+ const option = await screen.findByRole("option", {
+ name: /Orders question/,
+ });
+
+ fireEvent.click(option, { [modifier]: true });
+
+ expect(window.open).toHaveBeenCalledWith(
+ expect.stringContaining("/question/1"),
+ "_blank",
+ );
+ expect(command).not.toHaveBeenCalled();
+ },
+ );
+ });
});
diff --git a/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/EntitySearchSection.tsx b/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/EntitySearchSection.tsx
index 17653ff1688..21b1b4f6d02 100644
--- a/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/EntitySearchSection.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/EntitySearchSection.tsx
@@ -68,7 +68,15 @@ export function EntitySearchSection({
key={index}
item={item}
isSelected={selectedIndex === index}
- onClick={() => onItemSelect(index)}
+ onClick={(e) => {
+ // cmd/ctrl+click to open in new tab
+ if ((e.metaKey || e.ctrlKey) && item.href) {
+ e.preventDefault();
+ window.open(item.href, "_blank");
+ } else {
+ onItemSelect(index);
+ }
+ }}
onMouseEnter={() => onItemHover(index)}
/>
))}
diff --git a/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/suggestionUtils.ts b/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/suggestionUtils.ts
index 7cfc4441561..6646492fcf8 100644
--- a/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/suggestionUtils.ts
+++ b/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/suggestionUtils.ts
@@ -3,7 +3,7 @@ import { match } from "ts-pattern";
import { getTranslatedEntityName } from "metabase/common/utils/model-names";
import { getIcon } from "metabase/lib/icon";
import { getName } from "metabase/lib/name";
-import type { UrlableModel } from "metabase/lib/urls/modelToUrl";
+import { type UrlableModel, modelToUrl } from "metabase/lib/urls/modelToUrl";
import type { MenuItem } from "metabase-enterprise/documents/components/Editor/shared/MenuComponents";
import type { MetabaseProtocolEntityModel } from "metabase-enterprise/metabot/utils/links";
import type {
@@ -28,11 +28,14 @@ export function buildSearchMenuItems(
model: result.model,
display: result.display,
});
+ const urlableModel = entityToUrlableModel(result, result.model);
+ const href = modelToUrl(urlableModel);
return {
icon: iconData.name,
label: result.name,
id: result.id,
model: result.model,
+ href: href || undefined,
action: () => onSelect(result),
};
});
@@ -44,11 +47,14 @@ export function buildRecentsMenuItems(
): MenuItem[] {
return recents.map((recent) => {
const iconData = getIcon(recent);
+ const urlableModel = entityToUrlableModel(recent, recent.model);
+ const href = modelToUrl(urlableModel);
return {
icon: iconData.name,
label: getName(recent),
id: recent.id,
model: recent.model as SuggestionModel,
+ href: href || undefined,
action: () => onSelect(recent),
};
});
diff --git a/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/useEntitySuggestions.ts b/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/useEntitySuggestions.ts
index 667055d6211..876968a84f1 100644
--- a/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/useEntitySuggestions.ts
+++ b/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/useEntitySuggestions.ts
@@ -233,12 +233,18 @@ export function useEntitySuggestions({
const onKeyDown = useCallback(
({ event }: { event: KeyboardEvent }) => {
- if (event.key === "ArrowUp") {
+ if (
+ event.key === "ArrowUp" ||
+ (event.key === "p" && (event.metaKey || event.ctrlKey))
+ ) {
upHandler();
return true;
}
- if (event.key === "ArrowDown") {
+ if (
+ event.key === "ArrowDown" ||
+ (event.key === "n" && (event.metaKey || event.ctrlKey))
+ ) {
downHandler();
return true;
}