Skip to content

feat: manage columns in package list page #855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
carlosthe19916 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: manage columns in package list page #855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions client/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"@hookform/resolvers": "^2.9.11",
"@patternfly/patternfly": "^6.4.0",
"@patternfly/react-charts": "^8.4.0",
"@patternfly/react-component-groups": "^6.4.0",
"@patternfly/react-core": "^6.4.0",
"@patternfly/react-log-viewer": "^6.3.0",
"@patternfly/react-table": "^6.4.0",
Expand Down
81 changes: 81 additions & 0 deletions client/src/app/components/TableControls/ManageColumnsToolbar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
import { useState } from "react";

import {
ColumnManagementModal,
type ColumnManagementModalColumn,
} from "@patternfly/react-component-groups";
import {
Button,
OverflowMenu,
OverflowMenuGroup,
OverflowMenuItem,
ToolbarItem,
} from "@patternfly/react-core";
import { ColumnsIcon } from "@patternfly/react-icons";

import type { ColumnState } from "@app/hooks/table-controls/column/useColumnState";

interface ManageColumnsToolbarProps<TColumnKey extends string> {
columns: ColumnState<TColumnKey>[];
defaultColumns: ColumnState<TColumnKey>[];
setColumns: (newColumns: ColumnState<TColumnKey>[]) => void;
}

export const ManageColumnsToolbar = <TColumnKey extends string>({
columns,
setColumns,
defaultColumns,
}: ManageColumnsToolbarProps<TColumnKey>) => {
const [isOpen, setIsOpen] = useState(false);

const onApplyColumns = (
newUiColumns: ColumnManagementModalColumn[],
): void => {
const newTableColumns = columns.map((tableColumn) => {
const uiColumn = newUiColumns.find(
(column) => column.key === tableColumn.id,
);
return { ...tableColumn, isVisible: uiColumn?.isShown ?? false };
});
setColumns(newTableColumns);
};

return (
<>
<ToolbarItem>
<OverflowMenu breakpoint="md">
<OverflowMenuGroup groupType="button" isPersistent>
<OverflowMenuItem isPersistent>
<Button
variant="plain"
onClick={() => setIsOpen(true)}
icon={<ColumnsIcon />}
></Button>
</OverflowMenuItem>
</OverflowMenuGroup>
</OverflowMenu>
</ToolbarItem>
<ColumnManagementModal
appliedColumns={columns.map(({ id, label, isVisible, isIdentity }) => {
const shouldBeShown = (isVisible: boolean, isIdentity?: boolean) => {
return isVisible || (isIdentity ?? false);
};
const defaultColumn = defaultColumns.find((e) => e.id === id);

return {
key: id,
title: label,
isShownByDefault: defaultColumn
? shouldBeShown(defaultColumn.isVisible, defaultColumn.isIdentity)
: false,
isShown: shouldBeShown(isVisible, isIdentity),
isUntoggleable: isIdentity,
};
})}
applyColumns={onApplyColumns}
isOpen={isOpen}
onClose={() => setIsOpen(false)}
/>
</>
);
};
5 changes: 5 additions & 0 deletions client/src/app/pages/package-list/package-context.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@ export const PackageSearchProvider: React.FunctionComponent<
qualifiers: "Qualifiers",
vulnerabilities: "Vulnerabilities",
},
initialColumns: {
name: { isIdentity: true },
},
isPaginationEnabled: true,
isSortEnabled: true,
sortableColumns: ["name", "namespace", "version"],
Expand Down Expand Up @@ -139,6 +142,8 @@ export const PackageSearchProvider: React.FunctionComponent<
],
isExpansionEnabled: true,
expandableVariant: "compound",
isActiveItemEnabled: false,
isSelectionEnabled: false,
});

const {
Expand Down
211 changes: 123 additions & 88 deletions client/src/app/pages/package-list/package-table.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import React from "react";
import { generatePath, NavLink } from "react-router-dom";

import { List, ListItem } from "@patternfly/react-core";
import spacing from "@patternfly/react-styles/css/utilities/Spacing/spacing";
import {
ExpandableRowContent,
Table,
Expand All @@ -9,7 +12,6 @@ import {
Thead,
Tr,
} from "@patternfly/react-table";
import spacing from "@patternfly/react-styles/css/utilities/Spacing/spacing";

import { PackageQualifiers } from "@app/components/PackageQualifiers";
import { SimplePagination } from "@app/components/SimplePagination";
Expand All @@ -19,11 +21,11 @@ import {
TableRowContentWithControls,
} from "@app/components/TableControls";
import { Paths } from "@app/Routes";
import { PackageSearchContext } from "./package-context";
import { PackageVulnerabilities } from "./components/PackageVulnerabilities";
import { List, ListItem } from "@patternfly/react-core";

import { WithPackage } from "../../components/WithPackage";
import { PackageLicenses } from "./components/PackageLicences";
import { PackageVulnerabilities } from "./components/PackageVulnerabilities";
import { PackageSearchContext } from "./package-context";

export const PackageTable: React.FC = () => {
const { isFetching, fetchError, totalItemCount, tableControls } =
Expand All @@ -39,6 +41,7 @@ export const PackageTable: React.FC = () => {
getTrProps,
getTdProps,
getExpandedContentTdProps,
getColumnVisibility,
},
expansionDerivedState: { isCellExpanded },
} = tableControls;
Expand All @@ -49,14 +52,30 @@ export const PackageTable: React.FC = () => {
<Thead>
<Tr>
<TableHeaderContentWithControls {...tableControls}>
<Th {...getThProps({ columnKey: "name" })} />
<Th {...getThProps({ columnKey: "namespace" })} />
<Th {...getThProps({ columnKey: "version" })} />
<Th {...getThProps({ columnKey: "type" })} />
<Th {...getThProps({ columnKey: "licenses" })} />
<Th {...getThProps({ columnKey: "path" })} />
<Th {...getThProps({ columnKey: "qualifiers" })} />
<Th {...getThProps({ columnKey: "vulnerabilities" })} />
{getColumnVisibility("name") && (
<Th {...getThProps({ columnKey: "name" })} />
)}
{getColumnVisibility("namespace") && (
<Th {...getThProps({ columnKey: "namespace" })} />
)}
{getColumnVisibility("version") && (
<Th {...getThProps({ columnKey: "version" })} />
)}
{getColumnVisibility("type") && (
<Th {...getThProps({ columnKey: "type" })} />
)}
{getColumnVisibility("licenses") && (
<Th {...getThProps({ columnKey: "licenses" })} />
)}
{getColumnVisibility("path") && (
<Th {...getThProps({ columnKey: "path" })} />
)}
{getColumnVisibility("qualifiers") && (
<Th {...getThProps({ columnKey: "qualifiers" })} />
)}
{getColumnVisibility("vulnerabilities") && (
<Th {...getThProps({ columnKey: "vulnerabilities" })} />
)}
</TableHeaderContentWithControls>
</Tr>
</Thead>
Expand All @@ -77,85 +96,101 @@ export const PackageTable: React.FC = () => {
item={item}
rowIndex={rowIndex}
>
<Td
width={15}
modifier="breakWord"
{...getTdProps({ columnKey: "name" })}
>
<NavLink
to={generatePath(Paths.packageDetails, {
packageId: item.uuid,
{getColumnVisibility("name") && (
<Td
width={15}
modifier="breakWord"
{...getTdProps({ columnKey: "name" })}
>
<NavLink
to={generatePath(Paths.packageDetails, {
packageId: item.uuid,
})}
>
{item.decomposedPurl
? item.decomposedPurl?.name
: item.purl}
</NavLink>
</Td>
)}
{getColumnVisibility("namespace") && (
<Td
width={15}
modifier="truncate"
{...getTdProps({ columnKey: "namespace" })}
>
{item.decomposedPurl?.namespace}
</Td>
)}
{getColumnVisibility("version") && (
<Td
width={10}
modifier="truncate"
{...getTdProps({ columnKey: "version" })}
>
{item.decomposedPurl?.version}
</Td>
)}
{getColumnVisibility("type") && (
<Td
width={10}
modifier="truncate"
{...getTdProps({ columnKey: "type" })}
>
{item.decomposedPurl?.type}
</Td>
)}
{getColumnVisibility("licenses") && (
<Td
width={10}
modifier="truncate"
{...getTdProps({
columnKey: "licenses",
isCompoundExpandToggle: true,
item,
rowIndex,
})}
>
{item.decomposedPurl
? item.decomposedPurl?.name
: item.purl}
</NavLink>
</Td>
<Td
width={15}
modifier="truncate"
{...getTdProps({ columnKey: "namespace" })}
>
{item.decomposedPurl?.namespace}
</Td>
<Td
width={10}
modifier="truncate"
{...getTdProps({ columnKey: "version" })}
>
{item.decomposedPurl?.version}
</Td>
<Td
width={10}
modifier="truncate"
{...getTdProps({ columnKey: "type" })}
>
{item.decomposedPurl?.type}
</Td>
<Td
width={10}
modifier="truncate"
{...getTdProps({
columnKey: "licenses",
isCompoundExpandToggle: true,
item,
rowIndex,
})}
>
<PackageLicenses
pkg={pkg}
isFetching={packageIsFetching}
fetchError={packageFetchError}
/>
</Td>
<Td
width={10}
modifier="truncate"
{...getTdProps({ columnKey: "path" })}
>
{item.decomposedPurl?.path}
</Td>
<Td
width={20}
{...getTdProps({ columnKey: "qualifiers" })}
>
{item.decomposedPurl?.qualifiers && (
<PackageQualifiers
value={item.decomposedPurl?.qualifiers}
<PackageLicenses
pkg={pkg}
isFetching={packageIsFetching}
fetchError={packageFetchError}
/>
)}
</Td>
<Td
width={10}
{...getTdProps({ columnKey: "vulnerabilities" })}
>
<PackageVulnerabilities
pkg={pkg}
isFetching={packageIsFetching}
fetchError={packageFetchError}
/>
</Td>
</Td>
)}
{getColumnVisibility("path") && (
<Td
width={10}
modifier="truncate"
{...getTdProps({ columnKey: "path" })}
>
{item.decomposedPurl?.path}
</Td>
)}
{getColumnVisibility("qualifiers") && (
<Td
width={20}
{...getTdProps({ columnKey: "qualifiers" })}
>
{item.decomposedPurl?.qualifiers && (
<PackageQualifiers
value={item.decomposedPurl?.qualifiers}
/>
)}
</Td>
)}
{getColumnVisibility("vulnerabilities") && (
<Td
width={10}
{...getTdProps({ columnKey: "vulnerabilities" })}
>
<PackageVulnerabilities
pkg={pkg}
isFetching={packageIsFetching}
fetchError={packageFetchError}
/>
</Td>
)}
</TableRowContentWithControls>
</Tr>
{isCellExpanded(item) ? (
Expand Down
Loading