Skip to content

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

feat(sdk): Let end users archive items in the CollectionBrowser SDK component (#64561)

Mahatthana (Kelvin) Nomsawadiabeef3b5a887
diff --git a/e2e/test-component/scenarios/embedding-sdk/collection-browser.cy.spec.tsx b/e2e/test-component/scenarios/embedding-sdk/collection-browser.cy.spec.tsx
index e13fc6a4cdc..83a2ff7d6db 100644
--- a/e2e/test-component/scenarios/embedding-sdk/collection-browser.cy.spec.tsx
+++ b/e2e/test-component/scenarios/embedding-sdk/collection-browser.cy.spec.tsx
@@ -1,3 +1,4 @@
+const { H } = cy;
import { CollectionBrowser } from "@metabase/embedding-sdk-react";
import { useState } from "react";
@@ -69,6 +70,25 @@ describe("scenarios > embedding-sdk > collection browser", () => {
getSdkRoot().findByText("Our analytics").should("exist");
});
+
+ it("should be able to delete resources (EMB-892)", () => {
+ mountSdkContent(<CollectionBrowser collectionId="root" />);
+
+ const dashboardName = "Orders in a dashboard";
+
+ getSdkRoot().within(() => {
+ cy.findByText("Our analytics").should("exist");
+ cy.findByText("Orders in a dashboard").should("exist");
+
+ cy.log("delete the dashboard");
+ cy.findByText(dashboardName).closest("tr").button("Actions").click();
+ });
+
+ H.popover().findByRole("menuitem", { name: "Delete" }).click();
+
+ cy.log("the deleted dashboard should be gone");
+ getSdkRoot().findByText(dashboardName).should("not.exist");
+ });
});
describe("collection using entity ids", () => {
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/components/public/CollectionBrowser/CollectionBrowser.tsx b/enterprise/frontend/src/embedding-sdk-bundle/components/public/CollectionBrowser/CollectionBrowser.tsx
index fa7abe47f61..fa42dcbace7 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/components/public/CollectionBrowser/CollectionBrowser.tsx
+++ b/enterprise/frontend/src/embedding-sdk-bundle/components/public/CollectionBrowser/CollectionBrowser.tsx
@@ -37,13 +37,15 @@ export type CollectionBrowserListColumns =
| "type"
| "name"
| "lastEditedBy"
- | "lastEditedAt";
+ | "lastEditedAt"
+ | "archive";
const COLLECTION_BROWSER_LIST_COLUMNS: CollectionBrowserListColumns[] = [
"type",
"name",
"lastEditedBy",
"lastEditedAt",
+ "archive",
];
const ENTITY_NAME_MAP: Partial<
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.tsx
index c6910187756..2f478b1fc63 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.tsx
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.tsx
@@ -195,6 +195,7 @@ type CollectionItemsTableContentProps = CollectionItemsTableProps & {
onUnpinnedItemsSortingChange: (
unpinnedItemsSorting: SortingOptions<ListCollectionItemsSortColumn>,
) => void;
+ visibleColumns: CollectionContentTableColumn[];
};
const CollectionItemsTableContentInner = ({
@@ -219,7 +220,7 @@ const CollectionItemsTableContentInner = ({
toggleItem,
total,
unpinnedItemsSorting,
- visibleColumns = DEFAULT_VISIBLE_COLUMNS_LIST,
+ visibleColumns,
onClick,
onNextPage,
onPreviousPage,
diff --git a/frontend/src/metabase/collections/components/CollectionContent/constants.ts b/frontend/src/metabase/collections/components/CollectionContent/constants.ts
index 369ece166ac..7c5674af0e2 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/constants.ts
+++ b/frontend/src/metabase/collections/components/CollectionContent/constants.ts
@@ -2,12 +2,13 @@ import type { CollectionItemModel } from "metabase-types/api";
export const COLLECTION_PAGE_SIZE = 25;
-export const COLLECTION_CONTENT_COLUMNS = [
+const COLLECTION_CONTENT_COLUMNS = [
"type",
"name",
"lastEditedBy",
"lastEditedAt",
"actionMenu",
+ "archive",
] as const;
export type CollectionContentTableColumn =
diff --git a/frontend/src/metabase/common/components/ItemsTable/BaseItemsTable/BaseItemsTable.tsx b/frontend/src/metabase/common/components/ItemsTable/BaseItemsTable/BaseItemsTable.tsx
index a6419967fd2..b8d1463b81d 100644
--- a/frontend/src/metabase/common/components/ItemsTable/BaseItemsTable/BaseItemsTable.tsx
+++ b/frontend/src/metabase/common/components/ItemsTable/BaseItemsTable/BaseItemsTable.tsx
@@ -171,6 +171,7 @@ export const BaseItemsTable = ({
{visibleColumnsMap["lastEditedBy"] && <Columns.LastEditedBy.Col />}
{visibleColumnsMap["lastEditedAt"] && <Columns.LastEditedAt.Col />}
{visibleColumnsMap["actionMenu"] && <Columns.ActionMenu.Col />}
+ {visibleColumnsMap["archive"] && <Columns.Archive.Col />}
<Columns.RightEdge.Col />
</colgroup>
)}
@@ -216,6 +217,7 @@ export const BaseItemsTable = ({
/>
)}
{visibleColumnsMap["actionMenu"] && <Columns.ActionMenu.Header />}
+ {visibleColumnsMap["archive"] && <Columns.Archive.Header />}
<Columns.RightEdge.Header />
</tr>
</thead>
diff --git a/frontend/src/metabase/common/components/ItemsTable/Columns.tsx b/frontend/src/metabase/common/components/ItemsTable/Columns.tsx
index b4d0e9e463b..0e9008c5a50 100644
--- a/frontend/src/metabase/common/components/ItemsTable/Columns.tsx
+++ b/frontend/src/metabase/common/components/ItemsTable/Columns.tsx
@@ -8,6 +8,7 @@ import DateTime from "metabase/common/components/DateTime";
import { Ellipsified } from "metabase/common/components/Ellipsified";
import EntityItem from "metabase/common/components/EntityItem";
import Markdown from "metabase/common/components/Markdown";
+import { ArchiveButton } from "metabase/embedding/components/ArchiveButton";
import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
import { getUserName } from "metabase/lib/user";
import { PLUGIN_MODERATION } from "metabase/plugins";
@@ -316,6 +317,19 @@ export const Columns = {
);
},
},
+ Archive: {
+ Header: () => <th></th>,
+ Col: () => <col style={{ width: "100px" }} />,
+ Cell: ({ item }: { item: CollectionItem }) => {
+ return (
+ <ItemCell>
+ <RowActionsContainer>
+ <ArchiveButton item={item} />
+ </RowActionsContainer>
+ </ItemCell>
+ );
+ },
+ },
/** Applies a border-radius to the right edge of the table.
* This is needed since columns can be hidden responsively,
* and so we can't just apply the border-radius to the last column in the DOM */
diff --git a/frontend/src/metabase/common/components/ItemsTable/DefaultItemRenderer.tsx b/frontend/src/metabase/common/components/ItemsTable/DefaultItemRenderer.tsx
index bac4bd9f2ee..8f3ffba7408 100644
--- a/frontend/src/metabase/common/components/ItemsTable/DefaultItemRenderer.tsx
+++ b/frontend/src/metabase/common/components/ItemsTable/DefaultItemRenderer.tsx
@@ -92,6 +92,7 @@ export const DefaultItemRenderer = ({
deleteBookmark={deleteBookmark}
/>
)}
+ {visibleColumnsMap["archive"] && <Columns.Archive.Cell item={item} />}
<Columns.RightEdge.Cell />
</>
);
diff --git a/frontend/src/metabase/embedding/components/ArchiveButton.module.css b/frontend/src/metabase/embedding/components/ArchiveButton.module.css
new file mode 100644
index 00000000000..2265463a44f
--- /dev/null
+++ b/frontend/src/metabase/embedding/components/ArchiveButton.module.css
@@ -0,0 +1,8 @@
+.archiveMenuItem {
+ color: var(--mb-color-danger);
+
+ &:hover:not([data-css-specificity-hack]) {
+ color: var(--mb-color-danger);
+ background-color: var(--mb-color-bg-error);
+ }
+}
diff --git a/frontend/src/metabase/embedding/components/ArchiveButton.tsx b/frontend/src/metabase/embedding/components/ArchiveButton.tsx
new file mode 100644
index 00000000000..dfdd4e92e33
--- /dev/null
+++ b/frontend/src/metabase/embedding/components/ArchiveButton.tsx
@@ -0,0 +1,58 @@
+import { useDisclosure } from "@mantine/hooks";
+import { c, t } from "ttag";
+
+import { useGetCollectionQuery } from "metabase/api";
+import { canArchiveItem } from "metabase/collections/utils";
+import { ActionIcon, Icon, Menu } from "metabase/ui";
+import type { CollectionItem } from "metabase-types/api";
+
+import S from "./ArchiveButton.module.css";
+
+interface ArchiveButtonProps {
+ item: CollectionItem;
+}
+export function ArchiveButton({ item }: ArchiveButtonProps) {
+ const { data: collection } = useGetCollectionQuery({
+ id: item.collection_id ?? "root",
+ });
+ const canArchive = collection ? canArchiveItem(item, collection) : false;
+ const [dropdownOpened, dropdownActions] = useDisclosure();
+
+ const handleArchive = () => {
+ item.setArchived?.(true);
+ dropdownActions.close();
+ };
+
+ if (!canArchive) {
+ return null;
+ }
+
+ return (
+ <Menu
+ opened={dropdownOpened}
+ onClose={() => dropdownActions.close()}
+ position="bottom-end"
+ >
+ <Menu.Target>
+ <ActionIcon
+ aria-label={c(
+ "button that opens a actions dropdown e.g. Delete this row",
+ ).t`Actions`}
+ variant="subtle"
+ onClick={dropdownActions.open}
+ >
+ <Icon name="ellipsis" />
+ </ActionIcon>
+ </Menu.Target>
+ <Menu.Dropdown>
+ <Menu.Item
+ leftSection={<Icon name="trash" aria-hidden />}
+ onClick={handleArchive}
+ className={S.archiveMenuItem}
+ >
+ {t`Delete`}
+ </Menu.Item>
+ </Menu.Dropdown>
+ </Menu>
+ );
+}