Skip to content

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

Allow selecting collection items with shift+click and a Select menu (#79663)

Andersonc9f16511fa01
diff --git a/e2e/test/scenarios/collections/collections.cy.spec.js b/e2e/test/scenarios/collections/collections.cy.spec.js
index 592747bbd40..691959bb021 100644
--- a/e2e/test/scenarios/collections/collections.cy.spec.js
+++ b/e2e/test/scenarios/collections/collections.cy.spec.js
@@ -849,22 +849,54 @@ describe("scenarios > collection defaults", () => {
cy.findByTestId("toast-card").should("not.exist");
});
+ it("should support shift+click and the Select menu entry", () => {
+ cy.visit("/collection/root");
+
+ cy.log("shift+click a row selects it instead of navigating");
+ H.getUnpinnedSection().findByText("Orders").click({ shiftKey: true });
+ cy.findByTestId("toast-card")
+ .findByText("1 item selected")
+ .should("be.visible");
+ cy.location("pathname").should("include", "/collection/root");
+
+ cy.log("shift+click the row again clears the selection");
+ H.getUnpinnedSection().findByText("Orders").click({ shiftKey: true });
+ H.getUnpinnedSection().findByText("Orders").should("be.visible");
+ cy.findByTestId("toast-card").should("not.exist");
+
+ cy.log(
+ "shift+clicking the ellipsis opens the menu without selecting",
+ );
+ H.getUnpinnedSection()
+ .findByText("Orders, Count")
+ .closest("tr")
+ .findByRole("button", { name: "Actions" })
+ .click({ shiftKey: true });
+ H.popover().findByText("Select").should("be.visible");
+ cy.findByTestId("toast-card").should("not.exist");
+
+ cy.log("the open overflow menu can start a selection");
+ H.popover().findByText("Select").click();
+ cy.findByTestId("toast-card")
+ .findByText("1 item selected")
+ .should("be.visible");
+ });
+
it("should clean up selection when opening another collection (metabase#16491)", () => {
cy.request("PUT", `/api/card/${ORDERS_QUESTION_ID}`, {
collection_id: ADMIN_PERSONAL_COLLECTION_ID,
});
cy.visit("/collection/root");
- // eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
- cy.findByText("Your personal collection").click();
+ H.navigationSidebar().findByText("Your personal collection").click();
selectItemUsingCheckbox("Orders");
- // eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
- cy.findByText("1 item selected").should("be.visible");
+ cy.findByTestId("toast-card")
+ .findByText("1 item selected")
+ .should("be.visible");
- // eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
- cy.findByText("Our analytics").click();
- // eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
- cy.findByText(/item(s)? selected/).should("not.exist");
+ H.navigationSidebar().findByText("Our analytics").click();
+ cy.location("pathname").should("eq", "/collection/root");
+ cy.findByTestId("toast-card").should("not.exist");
});
});
@@ -878,8 +910,7 @@ describe("scenarios > collection defaults", () => {
.button("Move to trash")
.click();
- // eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
- cy.findByText("Orders").should("not.exist");
+ H.getUnpinnedSection().findByText("Orders").should("not.exist");
cy.findByTestId("toast-card").should("not.exist");
});
});
@@ -896,22 +927,17 @@ describe("scenarios > collection defaults", () => {
cy.button("Move").click();
});
- // eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
- cy.findByText("Orders").should("not.exist");
+ H.getUnpinnedSection().findByText("Orders").should("not.exist");
cy.findByTestId("toast-card").should("not.exist");
// Check that items were actually moved
H.navigationSidebar().findByText("First collection").click();
- // eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
- cy.findByText("Orders");
+ H.getUnpinnedSection().findByText("Orders").should("be.visible");
- // eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
- cy.findByText("Undo").click();
+ cy.findByTestId("toast-undo").findByText("Undo").click();
H.navigationSidebar().findByText("Our analytics").click();
- // eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
- cy.findByText("Orders").should("be.visible");
- // eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
- cy.findByText("Undo").should("not.exist");
+ H.getUnpinnedSection().findByText("Orders").should("be.visible");
+ cy.findByTestId("toast-undo").should("not.exist");
});
it("moving collections should disable moving into any of the moving collections", () => {
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentSelection.unit.spec.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentSelection.unit.spec.tsx
index 05fede73aa9..5c6a45ee883 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentSelection.unit.spec.tsx
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentSelection.unit.spec.tsx
@@ -11,7 +11,7 @@ import {
setupSearchEndpoints,
setupUserMetabotPermissionsEndpoint,
} from "__support__/server-mocks";
-import { renderWithProviders, screen, within } from "__support__/ui";
+import { fireEvent, renderWithProviders, screen, within } from "__support__/ui";
import { Route } from "metabase/router";
import type { Collection, CollectionItem } from "metabase-types/api";
import {
@@ -279,4 +279,75 @@ describe("CollectionContent selection", () => {
expect(getPinnedSection().getAllByRole("link")).toHaveLength(2);
expect(screen.queryByRole("checkbox")).not.toBeInTheDocument();
});
+
+ it("should toggle a table row with shift+click without navigating", async () => {
+ const events = userEvent.setup();
+ await setup();
+
+ await events.keyboard("{Shift>}");
+ await events.click(screen.getByRole("link", { name: tableQuestion.name }));
+ await events.keyboard("{/Shift}");
+
+ expect(await screen.findByText("1 item selected")).toBeInTheDocument();
+ expect(getPinnedCard(pinnedDashboard.name)).toBeInTheDocument();
+
+ await events.keyboard("{Shift>}");
+ await events.click(screen.getByRole("link", { name: tableQuestion.name }));
+ await events.keyboard("{/Shift}");
+
+ expect(screen.queryByText(/items? selected/)).not.toBeInTheDocument();
+ });
+
+ it("should select a pinned card from an empty selection with shift+click", async () => {
+ const events = userEvent.setup();
+ await setup();
+ const pinnedCard = getPinnedLink(pinnedDashboard.name);
+
+ await events.keyboard("{Shift>}");
+ await events.click(pinnedCard);
+ await events.keyboard("{/Shift}");
+
+ expect(await screen.findByText("1 item selected")).toBeInTheDocument();
+ expect(getPinnedCard(pinnedDashboard.name)).toBeChecked();
+ });
+
+ it("should select a pinned card from its overflow menu", async () => {
+ await setup();
+ const pinnedCard = getPinnedLink(pinnedDashboard.name);
+
+ await userEvent.click(
+ within(pinnedCard).getByRole("button", { name: "Actions" }),
+ );
+ await userEvent.click(await screen.findByText("Select"));
+
+ expect(await screen.findByText("1 item selected")).toBeInTheDocument();
+ expect(getPinnedCard(pinnedDashboard.name)).toBeChecked();
+ });
+
+ it("should select a table row from its overflow menu", async () => {
+ await setup();
+ const row = screen.getByRole("row", {
+ name: new RegExp(tableQuestion.name),
+ });
+
+ await userEvent.click(within(row).getByRole("button", { name: "Actions" }));
+ await userEvent.click(await screen.findByText("Select"));
+
+ expect(await screen.findByText("1 item selected")).toBeInTheDocument();
+ });
+
+ it("should open a row menu without selecting on shift+click", async () => {
+ await setup();
+ const row = screen.getByRole("row", {
+ name: new RegExp(tableQuestion.name),
+ });
+ const actions = within(row).getByRole("button", { name: "Actions" });
+
+ fireEvent.click(within(actions).getByLabelText("ellipsis icon"), {
+ shiftKey: true,
+ });
+
+ expect(await screen.findByText("Select")).toBeInTheDocument();
+ expect(screen.queryByText(/items? selected/)).not.toBeInTheDocument();
+ });
});
diff --git a/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.tsx b/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.tsx
index e79473a2d8a..84d0fd3c637 100644
--- a/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.tsx
+++ b/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.tsx
@@ -22,6 +22,8 @@ import type {
CollectionItem,
} from "metabase-types/api";
+import { useIsShiftPressed } from "./use-is-shift-pressed";
+
type Props = {
databases?: Database[];
bookmarks?: Bookmark[];
@@ -62,6 +64,10 @@ export function PinnedItemsGrid({
}
: skipToken,
);
+ const canSelect = canSelectItems(collection, onToggleSelected);
+ const isSelectMode = canSelect && selected.length > 0;
+ const isShiftPressed = useIsShiftPressed(canSelect);
+ const showSelectAffordance = canSelect && !isSelectMode && isShiftPressed;
const sortedItems = useMemo(() => {
const items = pinnedItemsData?.data ?? [];
@@ -76,9 +82,6 @@ export function PinnedItemsGrid({
);
}
- const canSelect = canSelectItems(collection, onToggleSelected);
- const isSelectMode = canSelect && selected.length > 0;
-
return (
<Box mb={rem(48)} pos="relative" data-testid="pinned-items">
<PinDropZone variant="pin" />
@@ -115,6 +118,7 @@ export function PinnedItemsGrid({
isSelectMode={isSelectMode}
isSelected={isSelected}
onToggleSelected={canSelect ? onToggleSelected : undefined}
+ showSelectAffordance={showSelectAffordance}
/>
</div>
</ItemDragSource>
diff --git a/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.unit.spec.tsx b/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.unit.spec.tsx
index 59281d2d6da..5b256dc6c23 100644
--- a/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.unit.spec.tsx
+++ b/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.unit.spec.tsx
@@ -1,7 +1,7 @@
import userEvent from "@testing-library/user-event";
import { setupCollectionItemsEndpoint } from "__support__/server-mocks";
-import { renderWithProviders, screen, within } from "__support__/ui";
+import { fireEvent, renderWithProviders, screen, within } from "__support__/ui";
import type { OnToggleSelectedWithItem } from "metabase/common/collections/types";
import type { Collection, CollectionItem } from "metabase-types/api";
import {
@@ -181,4 +181,21 @@ describe("PinnedItemsGrid", () => {
expect(screen.queryByRole("checkbox")).not.toBeInTheDocument();
expect(screen.getAllByRole("link")).toHaveLength(defaultItems.length);
});
+
+ it("should preview selection while Shift is held", async () => {
+ setup({ selected: [], onToggleSelected: jest.fn() });
+ await screen.findByTestId("pinned-items");
+ const card = screen.getByRole("link", { name: /Metric Bar/ });
+
+ fireEvent.keyDown(window, { key: "Shift", shiftKey: true });
+ await userEvent.hover(card);
+
+ expect(card).toBeInTheDocument();
+ expect(screen.getByTestId("pinned-item-checkbox")).not.toBeChecked();
+
+ fireEvent.keyUp(window, { key: "Shift", shiftKey: false });
+ expect(
+ screen.queryByTestId("pinned-item-checkbox"),
+ ).not.toBeInTheDocument();
+ });
});
diff --git a/frontend/src/metabase/collections/components/PinnedItemsGrid/use-is-shift-pressed.ts b/frontend/src/metabase/collections/components/PinnedItemsGrid/use-is-shift-pressed.ts
new file mode 100644
index 00000000000..6ca31e31a07
--- /dev/null
+++ b/frontend/src/metabase/collections/components/PinnedItemsGrid/use-is-shift-pressed.ts
@@ -0,0 +1,29 @@
+import { useEffect, useState } from "react";
+
+export function useIsShiftPressed(enabled = true): boolean {
+ const [isShiftPressed, setIsShiftPressed] = useState(false);
+
+ useEffect(() => {
+ if (!enabled) {
+ setIsShiftPressed(false);
+ return;
+ }
+
+ const syncFromEvent = (event: KeyboardEvent) => {
+ setIsShiftPressed(event.shiftKey);
+ };
+ const reset = () => setIsShiftPressed(false);
+
+ window.addEventListener("keydown", syncFromEvent);
+ window.addEventListener("keyup", syncFromEvent);
+ window.addEventListener("blur", reset);
+
+ return () => {
+ window.removeEventListener("keydown", syncFromEvent);
+ window.removeEventListener("keyup", syncFromEvent);
+ window.removeEventListener("blur", reset);
+ };
+ }, [enabled]);
+
+ return isShiftPressed;
+}
diff --git a/frontend/src/metabase/collections/components/PinnedItemsGrid/use-is-shift-pressed.unit.spec.ts b/frontend/src/metabase/collections/components/PinnedItemsGrid/use-is-shift-pressed.unit.spec.ts
new file mode 100644
index 00000000000..9414e0557c8
--- /dev/null
+++ b/frontend/src/metabase/collections/components/PinnedItemsGrid/use-is-shift-pressed.unit.spec.ts
@@ -0,0 +1,59 @@
+import { fireEvent, renderHook } from "__support__/ui";
+
+import { useIsShiftPressed } from "./use-is-shift-pressed";
+
+describe("useIsShiftPressed", () => {
+ it("tracks the Shift modifier across keyboard events", () => {
+ const { result } = renderHook(() => useIsShiftPressed());
+
+ expect(result.current).toBe(false);
+
+ fireEvent.keyDown(window, { key: "Shift", shiftKey: true });
+ expect(result.current).toBe(true);
+
+ fireEvent.keyUp(window, { key: "Shift", shiftKey: false });
+ expect(result.current).toBe(false);
+ });
+
+ it("reads shiftKey from non-Shift keyboard events", () => {
+ const { result } = renderHook(() => useIsShiftPressed());
+
+ fireEvent.keyDown(window, { key: "A", shiftKey: true });
+
+ expect(result.current).toBe(true);
+ });
+
+ it("resets when the window loses focus", () => {
+ const { result } = renderHook(() => useIsShiftPressed());
+
+ fireEvent.keyDown(window, { key: "Shift", shiftKey: true });
+ fireEvent.blur(window);
+
+ expect(result.current).toBe(false);
+ });
+
+ it("does not track Shift while disabled", () => {
+ const { result } = renderHook(() => useIsShiftPressed(false));
+
+ fireEvent.keyDown(window, { key: "Shift", shiftKey: true });
+
+ expect(result.current).toBe(false);
+ });
+
+ it("resets when disabled and resumes tracking when re-enabled", () => {
+ let enabled = true;
+ const { result, rerender } = renderHook(() => useIsShiftPressed(enabled));
+
+ fireEvent.keyDown(window, { key: "Shift", shiftKey: true });
+ expect(result.current).toBe(true);
+
+ enabled = false;
+ rerender();
+ expect(result.current).toBe(false);
+
+ enabled = true;
+ rerender();
+ fireEvent.keyDown(window, { key: "Shift", shiftKey: true });
+ expect(result.current).toBe(true);
+ });
+});
diff --git a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx
index 6bee0acc11f..9436a9fe3f7 100644
--- a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx
+++ b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx
@@ -16,6 +16,7 @@ import type {
DeleteBookmark,
OnCopy,
OnMove,
+ OnToggleSelected,
} from "metabase/common/collections/types";
import {
canArchiveItem,
@@ -25,6 +26,7 @@ import {
} from "metabase/common/collections/utils";
import { ConfirmModal } from "metabase/common/components/ConfirmModal";
import { EntityItem } from "metabase/common/components/EntityItem";
+import { canSelectItems } from "metabase/common/components/ItemsTable/utils";
import {
canMoveItem,
canPinItem,
@@ -49,6 +51,8 @@ export interface ActionMenuProps {
onMove?: OnMove;
createBookmark?: CreateBookmark;
deleteBookmark?: DeleteBookmark;
+ isSelected?: boolean;
+ onToggleSelected?: OnToggleSelected;
}
interface ActionMenuStateProps {
@@ -88,6 +92,8 @@ function ActionMenuInner({
onMove,
createBookmark,
deleteBookmark,
+ isSelected,
+ onToggleSelected,
}: ActionMenuProps & ActionMenuStateProps) {
const archive = useSetArchive();
const restore = useRestore();
@@ -102,6 +108,7 @@ function ActionMenuInner({
const canRestore = item.can_restore;
const canDelete = item.can_delete;
const canCopy = onCopy && canCopyItem(item);
+ const canSelect = canSelectItems(collection, onToggleSelected);
const handlePin = useCallback(() => {
if (isPinnable(item)) {
@@ -160,8 +167,10 @@ function ActionMenuInner({
className={`${S.EntityItemMenu} ${className || ""}`}
item={item}
isBookmarked={isBookmarked}
+ isSelected={isSelected}
isXrayEnabled={!item.archived && isXrayEnabled}
onPin={canPin ? handlePin : undefined}
+ onToggleSelected={canSelect ? onToggleSelected : undefined}
onMove={canMove ? handleMove : undefined}
onCopy={canCopy ? handleCopy : undefined}
onArchive={canArchive ? handleArchive : undefined}
diff --git a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.unit.spec.tsx b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.unit.spec.tsx
index 174814fa65e..21eaed9c03d 100644
--- a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.unit.spec.tsx
+++ b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.unit.spec.tsx
@@ -24,6 +24,8 @@ interface SetupOpts {
databases?: Database[];
isXrayEnabled?: boolean;
withBookmarks?: boolean;
+ isSelected?: boolean;
+ onToggleSelected?: jest.Mock;
}
const setup = ({
@@ -32,6 +34,8 @@ const setup = ({
databases = [],
isXrayEnabled = false,
withBookmarks = false,
+ isSelected,
+ onToggleSelected,
}: SetupOpts) => {
const storeInitialState = createMockState({
entities: createMockEntitiesState({
@@ -57,6 +61,8 @@ const setup = ({
onMove={onMove}
createBookmark={createBookmark}
deleteBookmark={deleteBookmark}
+ isSelected={isSelected}
+ onToggleSelected={onToggleSelected}
/>,
{ storeInitialState },
);
@@ -83,6 +89,56 @@ describe("ActionMenu", () => {
});
});
+ describe("selection", () => {
+ const item = createMockCollectionItem({
+ id: 1,
+ name: "Dashboard",
+ model: "dashboard",
+ can_write: true,
+ });
+
+ it("should select an item in a writable collection", async () => {
+ const onToggleSelected = jest.fn();
+ setup({ item, onToggleSelected });
+
+ await userEvent.click(getIcon("ellipsis"));
+ await userEvent.click(await screen.findByText("Select"));
+
+ expect(onToggleSelected).toHaveBeenCalledTimes(1);
+ expect(onToggleSelected).toHaveBeenCalledWith();
+ });
+
+ it("should show Deselect for a selected item", async () => {
+ setup({ item, isSelected: true, onToggleSelected: jest.fn() });
+
+ await userEvent.click(getIcon("ellipsis"));
+
+ expect(await screen.findByText("Deselect")).toBeInTheDocument();
+ });
+
+ it("should not show selection in a read-only collection", async () => {
+ setup({
+ item,
+ collection: createMockCollection({ can_write: false }),
+ onToggleSelected: jest.fn(),
+ });
+
+ await userEvent.click(getIcon("ellipsis"));
+
+ expect(screen.queryByText("Select")).not.toBeInTheDocument();
+ expect(screen.queryByText("Deselect")).not.toBeInTheDocument();
+ });
+
+ it("should not show selection without a toggle callback", async () => {
+ setup({ item });
+
+ await userEvent.click(getIcon("ellipsis"));
+
+ expect(screen.queryByText("Select")).not.toBeInTheDocument();
+ expect(screen.queryByText("Deselect")).not.toBeInTheDocument();
+ });
+ });
+
describe("moving and archiving", () => {
it("should duplicate an item", async () => {
const item = createMockCollectionItem({
diff --git a/frontend/src/metabase/common/collections/components/CompactPinnedItemCard/CompactPinnedItemCard.tsx b/frontend/src/metabase/common/collections/components/CompactPinnedItemCard/CompactPinnedItemCard.tsx
index ca1e213cf38..e9030dce722 100644
--- a/frontend/src/metabase/common/collections/components/CompactPinnedItemCard/CompactPinnedItemCard.tsx
+++ b/frontend/src/metabase/common/collections/components/CompactPinnedItemCard/CompactPinnedItemCard.tsx
@@ -1,5 +1,5 @@
import cx from "classnames";
-import { type FocusEvent, useState } from "react";
+import { type FocusEvent, type MouseEvent, useState } from "react";
import { t } from "ttag";
import { ActionMenu } from "metabase/common/collections/components/ActionMenu";
@@ -26,6 +26,7 @@ import type {
} from "metabase-types/api";
import S from "./CompactPinnedItemCard.module.css";
+import { SelectModeCardWrapper } from "./SelectModeCardWrapper";
const TOOLTIP_MAX_WIDTH = 450;
@@ -60,6 +61,7 @@ export type CompactPinnedItemCardProps = {
isSelectMode?: boolean;
isSelected?: boolean;
onToggleSelected?: OnToggleSelectedWithItem;
+ showSelectAffordance?: boolean;
};
const isCollectionItem = (
@@ -81,6 +83,7 @@ export function CompactPinnedItemCard({
isSelectMode,
isSelected,
onToggleSelected,
+ showSelectAffordance,
}: CompactPinnedItemCardProps) {
const getIcon = useGetIcon();
const icon = getIcon({
@@ -97,11 +100,13 @@ export function CompactPinnedItemCard({
onToggleSelected && isCollectionItem(item)
? () => onToggleSelected(item)
: undefined;
- const handleToggleSelected = isSelectMode ? toggleSelected : undefined;
- const showAsSelected = handleToggleSelected != null && Boolean(isSelected);
+ const isInSelectMode = Boolean(isSelectMode) && toggleSelected != null;
+ const showAsSelected = isInSelectMode && Boolean(isSelected);
const [isHoveredOrFocused, setIsHoveredOrFocused] = useState(false);
const showCheckbox =
- handleToggleSelected != null && (showAsSelected || isHoveredOrFocused);
+ toggleSelected != null &&
+ (isInSelectMode || Boolean(showSelectAffordance)) &&
+ (showAsSelected || isHoveredOrFocused);
const highlightProps = toggleSelected
? {
onMouseEnter: () => setIsHoveredOrFocused(true),
@@ -118,11 +123,20 @@ export function CompactPinnedItemCard({
},
}
: {};
+ const handleLinkClick = (event: MouseEvent) => {
+ if (event.shiftKey && toggleSelected) {
+ event.preventDefault();
+ document.getSelection()?.removeAllRanges();
+ toggleSelected();
+ return;
+ }
+ onClick?.();
+ };
const card = (
<Card
className={cx(S.card, {
- [S.selectable]: handleToggleSelected != null,
+ [S.selectable]: isInSelectMode || showSelectAffordance,
[S.selected]: showAsSelected,
})}
data-testid="pinned-item-card"
@@ -188,6 +202,8 @@ export function CompactPinnedItemCard({
deleteBookmark={deleteBookmark}
onCopy={onCopy}
onMove={onMove}
+ isSelected={showAsSelected}
+ onToggleSelected={toggleSelected}
/>
</EventSandbox>
</Box>
@@ -195,28 +211,16 @@ export function CompactPinnedItemCard({
</Card>
);
- if (handleToggleSelected) {
+ if (isInSelectMode && toggleSelected) {
return (
- <Box
- {...highlightProps}
- aria-checked={showAsSelected}
- aria-label={item.name}
- className={S.link}
- role="checkbox"
- tabIndex={0}
- onClick={handleToggleSelected}
- onKeyDown={(event) => {
- if (event.target !== event.currentTarget) {
- return;
- }
- if (event.key === " " || event.key === "Enter") {
- event.preventDefault();
- handleToggleSelected();
- }
- }}
+ <SelectModeCardWrapper
+ name={item.name}
+ isSelected={showAsSelected}
+ onToggle={toggleSelected}
+ onHighlightChange={setIsHoveredOrFocused}
>
{card}
- </Box>
+ </SelectModeCardWrapper>
);
}
@@ -225,7 +229,7 @@ export function CompactPinnedItemCard({
{...highlightProps}
className={S.link}
to={modelToUrl(item)}
- onClick={onClick}
+ onClick={handleLinkClick}
>
{card}
</Link>
diff --git a/frontend/src/metabase/common/collections/components/CompactPinnedItemCard/CompactPinnedItemCard.unit.spec.tsx b/frontend/src/metabase/common/collections/components/CompactPinnedItemCard/CompactPinnedItemCard.unit.spec.tsx
index aaa1440871e..f455332854c 100644
--- a/frontend/src/metabase/common/collections/components/CompactPinnedItemCard/CompactPinnedItemCard.unit.spec.tsx
+++ b/frontend/src/metabase/common/collections/components/CompactPinnedItemCard/CompactPinnedItemCard.unit.spec.tsx
@@ -74,12 +74,16 @@ function setup({
isSelectMode,
isSelected,
onToggleSelected,
+ onClick,
+ showSelectAffordance,
}: {
item?: CollectionItem | RecentCollectionItem;
collection?: Collection;
isSelectMode?: boolean;
isSelected?: boolean;
onToggleSelected?: OnToggleSelectedWithItem;
+ onClick?: () => void;
+ showSelectAffordance?: boolean;
} = {}) {
return renderWithProviders(
<Route
@@ -95,6 +99,8 @@ function setup({
isSelectMode={isSelectMode}
isSelected={isSelected}
onToggleSelected={onToggleSelected}
+ onClick={onClick}
+ showSelectAffordance={showSelectAffordance}
/>
}
/>,
@@ -359,6 +365,113 @@ describe("CompactPinnedItemCard", () => {
});
});
+ describe("shift selection", () => {
+ it("should select a link-mode card without navigating on shift+click", async () => {
+ const utils = userEvent.setup();
+ const onClick = jest.fn();
+ const onToggleSelected = jest.fn();
+ setup({ onClick, onToggleSelected });
+
+ await utils.keyboard("{Shift>}");
+ await utils.click(screen.getByText(defaultItem.name));
+ await utils.keyboard("{/Shift}");
+
+ expect(onToggleSelected).toHaveBeenCalledWith(defaultItem);
+ expect(onClick).not.toHaveBeenCalled();
+ expect(screen.getByRole("link")).toBeInTheDocument();
+ });
+
+ it("should preserve plain link clicks", async () => {
+ const onClick = jest.fn();
+ const onToggleSelected = jest.fn();
+ setup({ onClick, onToggleSelected });
+ screen
+ .getByRole("link")
+ .addEventListener("click", (event) => event.preventDefault());
+
+ await userEvent.click(screen.getByText(defaultItem.name));
+
+ expect(onClick).toHaveBeenCalledTimes(1);
+ expect(onToggleSelected).not.toHaveBeenCalled();
+ });
+
+ it("should not select on shift+click when selection is unavailable", async () => {
+ const utils = userEvent.setup();
+ const onClick = jest.fn();
+ setup({ onClick });
+ screen
+ .getByRole("link")
+ .addEventListener("click", (event) => event.preventDefault());
+
+ await utils.keyboard("{Shift>}");
+ await utils.click(screen.getByText(defaultItem.name));
+ await utils.keyboard("{/Shift}");
+
+ expect(onClick).toHaveBeenCalledTimes(1);
+ });
+
+ it("should preview an unchecked checkbox on a hovered link", async () => {
+ setup({
+ onToggleSelected: jest.fn(),
+ showSelectAffordance: true,
+ });
+ const card = screen.getByRole("link");
+
+ expect(testGetIcon(modelIconMap[defaultItem.model])).toBeInTheDocument();
+ await userEvent.hover(card);
+
+ expect(card).toBeInTheDocument();
+ expect(screen.getByTestId("pinned-item-checkbox")).not.toBeChecked();
+ expect(
+ queryIcon(modelIconMap[defaultItem.model]),
+ ).not.toBeInTheDocument();
+ });
+
+ it("should keep the model icon until the link is hovered", () => {
+ setup({
+ onToggleSelected: jest.fn(),
+ showSelectAffordance: true,
+ });
+
+ expect(screen.getByRole("link")).toBeInTheDocument();
+ expect(testGetIcon(modelIconMap[defaultItem.model])).toBeInTheDocument();
+ expect(
+ screen.queryByTestId("pinned-item-checkbox"),
+ ).not.toBeInTheDocument();
+ });
+
+ it("should select an item from the overflow menu", async () => {
+ const onToggleSelected = jest.fn();
+ setup({ onToggleSelected });
+
+ await userEvent.click(screen.getByRole("button", { name: "Actions" }));
+ await userEvent.click(await screen.findByText("Select"));
+
+ expect(onToggleSelected).toHaveBeenCalledWith(defaultItem);
+ });
+
+ it("should show Deselect for a selected item", async () => {
+ setup({
+ isSelectMode: true,
+ isSelected: true,
+ onToggleSelected: jest.fn(),
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: "Actions" }));
+
+ expect(await screen.findByText("Deselect")).toBeInTheDocument();
+ });
+
+ it("should omit selection from the menu without a toggle callback", async () => {
+ setup();
+
+ await userEvent.click(screen.getByRole("button", { name: "Actions" }));
+
+ expect(screen.queryByText("Select")).not.toBeInTheDocument();
+ expect(screen.queryByText("Deselect")).not.toBeInTheDocument();
+ });
+ });
+
describe("recent items", () => {
const recentModel = createMockRecentCollectionItem({
id: 7,
diff --git a/frontend/src/metabase/common/collections/components/CompactPinnedItemCard/SelectModeCardWrapper.tsx b/frontend/src/metabase/common/collections/components/CompactPinnedItemCard/SelectModeCardWrapper.tsx
new file mode 100644
index 00000000000..ef0d797189a
--- /dev/null
+++ b/frontend/src/metabase/common/collections/components/CompactPinnedItemCard/SelectModeCardWrapper.tsx
@@ -0,0 +1,54 @@
+import type { PropsWithChildren } from "react";
+
+import { Box } from "metabase/ui";
+
+import S from "./CompactPinnedItemCard.module.css";
+
+type Props = PropsWithChildren<{
+ name: string;
+ isSelected: boolean;
+ onToggle: () => void;
+ onHighlightChange: (isHighlighted: boolean) => void;
+}>;
+
+export function SelectModeCardWrapper({
+ name,
+ isSelected,
+ onToggle,
+ onHighlightChange,
+ children,
+}: Props) {
+ return (
+ <Box
+ aria-checked={isSelected}
+ aria-label={name}
+ className={S.link}
+ role="checkbox"
+ tabIndex={0}
+ onBlur={(event) => {
+ if (event.target === event.currentTarget) {
+ onHighlightChange(false);
+ }
+ }}
+ onClick={onToggle}
+ onFocus={(event) => {
+ if (event.target === event.currentTarget) {
+ onHighlightChange(true);
+ }
+ }}
+ onKeyDown={(event) => {
+ if (event.target !== event.currentTarget) {
+ return;
+ }
+ if (event.key === " " || event.key === "Enter") {
+ event.preventDefault();
+ onToggle();
+ }
+ }}
+ onMouseEnter={() => onHighlightChange(true)}
+ onMouseLeave={() => onHighlightChange(false)}
+ >
+ {children}
+ </Box>
+ );
+}
diff --git a/frontend/src/metabase/common/components/EntityItem/EntityItem.tsx b/frontend/src/metabase/common/components/EntityItem/EntityItem.tsx
index 24ddc36f634..83b318b0ddf 100644
--- a/frontend/src/metabase/common/components/EntityItem/EntityItem.tsx
+++ b/frontend/src/metabase/common/components/EntityItem/EntityItem.tsx
@@ -155,6 +155,7 @@ function MenuItemTooltip({
function EntityItemMenu({
item,
isBookmarked,
+ isSelected,
isXrayEnabled,
onPin,
onMove,
@@ -163,10 +164,12 @@ function EntityItemMenu({
onRestore,
onDeletePermanently,
onToggleBookmark,
+ onToggleSelected,
className,
}: {
item: CollectionItem;
isBookmarked?: boolean;
+ isSelected?: boolean;
isXrayEnabled?: boolean;
onPin?: OnPin;
onMove?: OnMove;
@@ -175,6 +178,7 @@ function EntityItemMenu({
onRestore?: OnRestore;
onDeletePermanently?: OnDeletePermanently;
onToggleBookmark?: OnToggleBookmark;
+ onToggleSelected?: () => void;
className?: string;
}) {
const isPinned = isItemPinned(item);
@@ -184,6 +188,14 @@ function EntityItemMenu({
const actions = useMemo(() => {
const result: EntityItemMenuAction[] = [];
+ if (onToggleSelected) {
+ result.push({
+ title: isSelected ? t`Deselect` : t`Select`,
+ icon: "check",
+ action: onToggleSelected,
+ });
+ }
+
if (onPin) {
result.push({
title: isPinned ? t`Unpin` : t`Pin this`,
@@ -261,11 +273,13 @@ function EntityItemMenu({
isPinned,
isXrayShown,
isBookmarked,
+ isSelected,
onPin,
onMove,
onCopy,
onArchive,
onToggleBookmark,
+ onToggleSelected,
onDeletePermanently,
onRestore,
]);
diff --git a/frontend/src/metabase/common/components/ItemsTable/BaseItemTableRow.tsx b/frontend/src/metabase/common/components/ItemsTable/BaseItemTableRow.tsx
index 2766f04d2bc..7ac39b596b6 100644
--- a/frontend/src/metabase/common/components/ItemsTable/BaseItemTableRow.tsx
+++ b/frontend/src/metabase/common/components/ItemsTable/BaseItemTableRow.tsx
@@ -1,8 +1,9 @@
import cx from "classnames";
-import type { PropsWithChildren } from "react";
+import type { MouseEvent, PropsWithChildren } from "react";
import type { BaseItemsTableProps } from "metabase/common/components/ItemsTable/BaseItemsTable";
import { DefaultItemRenderer } from "metabase/common/components/ItemsTable/DefaultItemRenderer";
+import { canSelectItems } from "metabase/common/components/ItemsTable/utils";
import {
type CollectionDropTargetRenderProps,
CollectionRowDropTarget,
@@ -69,6 +70,32 @@ type BaseItemTableRowProps = PropsWithChildren<
>
>;
+const getRowShiftSelectHandler = ({
+ item,
+ collection,
+ onToggleSelected,
+}: Pick<BaseItemTableRowProps, "item" | "collection" | "onToggleSelected">) => {
+ if (!canSelectItems(collection, onToggleSelected)) {
+ return undefined;
+ }
+
+ return (event: MouseEvent<HTMLTableRowElement>) => {
+ if (!event.shiftKey) {
+ return;
+ }
+ if (
+ event.target instanceof Element &&
+ event.target.closest("[data-ignore-row-selection]")
+ ) {
+ return;
+ }
+ event.preventDefault();
+ event.stopPropagation();
+ document.getSelection()?.removeAllRanges();
+ onToggleSelected?.(item);
+ };
+};
+
export const TableRow = ({
testIdPrefix,
databases,
@@ -87,7 +114,16 @@ export const TableRow = ({
onClick,
visibleColumnsMap,
}: BaseItemTableRowProps) => (
- <tr key={itemKey} data-testid={testIdPrefix} style={{ height: 48 }}>
+ <tr
+ key={itemKey}
+ data-testid={testIdPrefix}
+ style={{ height: 48 }}
+ onClickCapture={getRowShiftSelectHandler({
+ item,
+ collection,
+ onToggleSelected,
+ })}
+ >
<ItemComponent
onClick={onClick}
testIdPrefix={testIdPrefix}
@@ -141,6 +177,11 @@ export const ItemDragSourceTableRow = ({
[S.disabledRow]: dndState === "disabled",
[S.dropTargetRow]: dndState === "drop-target-hovered",
})}
+ onClickCapture={getRowShiftSelectHandler({
+ item,
+ collection,
+ onToggleSelected,
+ })}
>
<ItemComponent
testIdPrefix={testIdPrefix}
diff --git a/frontend/src/metabase/common/components/ItemsTable/Columns.tsx b/frontend/src/metabase/common/components/ItemsTable/Columns.tsx
index 7c4e1f2b74f..6370e0071da 100644
--- a/frontend/src/metabase/common/components/ItemsTable/Columns.tsx
+++ b/frontend/src/metabase/common/components/ItemsTable/Columns.tsx
@@ -336,29 +336,11 @@ export const Columns = {
ActionMenu: {
Header: () => <th></th>,
Col: () => <col style={{ width: "100px" }} />,
- Cell: ({
- item,
- collection,
- databases,
- bookmarks,
- onCopy,
- onMove,
- createBookmark,
- deleteBookmark,
- }: ActionMenuProps) => {
+ Cell: (props: ActionMenuProps) => {
return (
<ItemCell>
- <RowActionsContainer>
- <ActionMenu
- item={item}
- collection={collection}
- databases={databases}
- bookmarks={bookmarks}
- onCopy={onCopy}
- onMove={onMove}
- createBookmark={createBookmark}
- deleteBookmark={deleteBookmark}
- />
+ <RowActionsContainer data-ignore-row-selection>
+ <ActionMenu {...props} />
</RowActionsContainer>
</ItemCell>
);
diff --git a/frontend/src/metabase/common/components/ItemsTable/DefaultItemRenderer.tsx b/frontend/src/metabase/common/components/ItemsTable/DefaultItemRenderer.tsx
index 47be1978568..53da6b8fcd8 100644
--- a/frontend/src/metabase/common/components/ItemsTable/DefaultItemRenderer.tsx
+++ b/frontend/src/metabase/common/components/ItemsTable/DefaultItemRenderer.tsx
@@ -6,20 +6,18 @@ import type { BaseItemsTableProps } from "metabase/common/components/ItemsTable/
import { Columns } from "metabase/common/components/ItemsTable/Columns";
import { canSelectItems } from "metabase/common/components/ItemsTable/utils";
import { useGetIcon } from "metabase/hooks/use-icon";
-import type Database from "metabase-lib/v1/metadata/Database";
-import type { Bookmark, Collection, CollectionItem } from "metabase-types/api";
+import type { CollectionItem } from "metabase-types/api";
export type ItemRendererProps = {
item: CollectionItem;
isSelected?: boolean;
isPinned?: boolean;
onToggleSelected?: OnToggleSelectedWithItem;
- collection?: Collection;
- draggable?: boolean;
testIdPrefix?: string;
- databases?: Database[];
- bookmarks?: Bookmark[];
-} & ActionMenuProps &
+} & Omit<
+ ActionMenuProps,
+ "className" | "item" | "isSelected" | "onToggleSelected"
+> &
Pick<BaseItemsTableProps, "onClick" | "visibleColumnsMap">;
export const DefaultItemRenderer = ({
@@ -95,6 +93,8 @@ export const DefaultItemRenderer = ({
onMove={onMove}
createBookmark={createBookmark}
deleteBookmark={deleteBookmark}
+ isSelected={isSelected}
+ onToggleSelected={canSelect ? handleSelectionToggled : undefined}
/>
)}
{visibleColumnsMap["archive"] && <Columns.Archive.Cell item={item} />}
diff --git a/frontend/src/metabase/common/components/ItemsTable/utils.ts b/frontend/src/metabase/common/components/ItemsTable/utils.ts
index 017d2ff4440..a9da2f4e2fd 100644
--- a/frontend/src/metabase/common/components/ItemsTable/utils.ts
+++ b/frontend/src/metabase/common/components/ItemsTable/utils.ts
@@ -2,7 +2,10 @@ import type {
CollectionContentTableColumn,
CollectionContentTableColumnsMap,
} from "metabase/common/collections/columns";
-import type { OnToggleSelectedWithItem } from "metabase/common/collections/types";
+import type {
+ OnToggleSelected,
+ OnToggleSelectedWithItem,
+} from "metabase/common/collections/types";
import { isRootTrashCollection } from "metabase/common/collections/utils";
import { PLUGIN_LIBRARY } from "metabase/plugins";
import { type BreakpointName, breakpoints } from "metabase/ui/theme";
@@ -32,7 +35,7 @@ export const getVisibleColumnsMap = (
export const canSelectItems = (
collection: Collection | undefined,
- onToggleSelected: OnToggleSelectedWithItem | undefined,
+ onToggleSelected: OnToggleSelected | OnToggleSelectedWithItem | undefined,
): boolean => {
if (typeof onToggleSelected !== "function") {
return false;