@canonical/maas-react-components 2.2.0 → 2.4.0

package/dist/src/lib/components/GenericTable/GenericTable.d.ts

@@ -1,7 +1,7 @@
 import { DetailedHTMLProps, Dispatch, HTMLAttributes, ReactElement, ReactNode, RefObject, SetStateAction } from 'react';
 import { Column, ColumnDef, ColumnSort, Header, Row, SortingState } from '@tanstack/react-table';
 import { PaginationBarProps } from './components/PaginationBar';
-import { SelectionProps, GenericTableData } from './types';
+import { SelectionProps, GenericTableData, ColumnVisibilityProps } from './types';
 type GenericTableProps<T extends GenericTableData> = {
     "aria-label"?: string;
     className?: string;
@@ -15,17 +15,20 @@ type GenericTableProps<T extends GenericTableData> = {
     isLoading: boolean;
     loadingVariant?: "spinner" | "skeleton";
     skeletonRowCount?: number;
+    skeletonGroupCount?: number;
     noData?: ReactNode;
     pagination?: PaginationBarProps;
     pinGroup?: {
         value: string;
         isTop: boolean;
     }[];
+    columnVisibility?: ColumnVisibilityProps;
     sorting?: ColumnSort[];
     selection?: SelectionProps<T>;
     setSorting?: Dispatch<SetStateAction<SortingState>>;
     showChevron?: boolean;
     variant?: "full-height" | "regular";
+    debug?: boolean;
 } & DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>;
 /**
  * GenericTable - A flexible and feature-rich table component for React applications
@@ -39,6 +42,8 @@ type GenericTableProps<T extends GenericTableData> = {
  * @param {Object} props - Component props
  * @param {string} [props.className] - Additional CSS class for the table wrapper
  * @param {ColumnDef<T, Partial<T>>[]} props.columns - Column definitions
+ * @param {ColumnVisibilityProps} [props.columnVisibility] - Controlled column visibility state and setter; when omitted, visibility is managed internally. See {@link ColumnVisibilityProps} for all sub-options
+ *  (columnVisibility, setColumnVisibility).
  * @param {RefObject<HTMLElement | null>} [props.containerRef] - Reference to container for size calculations
  * @param {T[]} props.data - Table data array
  * @param {(row: Row<T>, column: Column<T>) => boolean} [props.filterCells] - Function to filter which cells should be displayed
@@ -47,7 +52,8 @@ type GenericTableProps<T extends GenericTableData> = {
  * @param {string[]} [props.groupBy] - Column IDs to group rows by
  * @param {boolean} props.isLoading - Loading state to display placeholder content
  * @param {"spinner" | "skeleton"} [props.loadingVariant="spinner"] - Loading display style; "spinner" shows a single spinner row, "skeleton" renders skeletonRowCount pulsing skeleton rows using meta.skeleton per column when defined, falling back to a default Placeholder block
- * @param {number} [props.skeletonRowCount=10] - Number of skeleton rows to render when loadingVariant="skeleton"
+ * @param {number} [props.skeletonRowCount=10] - Number of skeleton rows to render per group (or total when ungrouped) when loadingVariant="skeleton"
+ * @param {number} [props.skeletonGroupCount=2] - Number of skeleton group rows to render when loadingVariant="skeleton" and groupBy is set
  * @param {ReactNode} [props.noData] - Content to display when no data is available
  * @param {PaginationBarProps} [props.pagination] - Pagination configuration
  * @param {{ value: string; isTop: boolean }[]} [props.pinGroup] - Group pinning configuration
@@ -57,6 +63,7 @@ type GenericTableProps<T extends GenericTableData> = {
  *   (filterSelectable, disabledSelectionTooltip, rowSelection, rowSelectionLabelKey, setRowSelection).
  * @param {boolean} [props.showChevron=false] - Show group row expansion state chevrons
  * @param {"full-height" | "regular"} [props.variant="full-height"] - Table layout variant
+ * @param {boolean} [props.debug] - React Table debug output
  *
  * @returns {ReactElement} - The rendered table component
  *
@@ -80,5 +87,5 @@ type GenericTableProps<T extends GenericTableData> = {
  *   }}
  * />
  */
-export declare const GenericTable: <T extends GenericTableData>({ "aria-label": tableAriaLabel, className, columns: initialColumns, containerRef, data: initialData, filterCells, filterHeaders, getSubRows, groupBy, isLoading, loadingVariant, skeletonRowCount, noData, pagination, pinGroup, sorting: externalSorting, selection, setSorting: setExternalSorting, showChevron, variant, ...divProps }: GenericTableProps<T>) => ReactElement;
+export declare const GenericTable: <T extends GenericTableData>({ "aria-label": tableAriaLabel, className, columns: initialColumns, columnVisibility: externalColumnVisibility, containerRef, data: initialData, filterCells, filterHeaders, getSubRows, groupBy, isLoading, loadingVariant, skeletonRowCount, skeletonGroupCount, noData, pagination, pinGroup, sorting: externalSorting, selection, setSorting: setExternalSorting, showChevron, variant, debug, ...divProps }: GenericTableProps<T>) => ReactElement;
 export {};

package/dist/src/lib/components/GenericTable/components/TableCheckbox/TableCheckbox.d.ts

@@ -6,10 +6,10 @@ type TableCheckboxProps<T> = Partial<DetailedHTMLProps<InputHTMLAttributes<HTMLI
 };
 declare const TableCheckbox: {
     <T>({ row, disabledTooltip, isNested, ...props }: TableCheckboxProps<T> & {
-        disabledTooltip: string | ((row: Row<T>) => string);
-        isNested: boolean;
+        disabledTooltip?: string | ((row: Row<T>) => string);
+        isNested?: boolean;
     }): ReactElement | null;
     All: <T>({ table, ...props }: TableCheckboxProps<T>) => import("react/jsx-runtime").JSX.Element | null;
-    Group: <T>({ row, ...props }: TableCheckboxProps<T>) => import("react/jsx-runtime").JSX.Element | null;
+    Group: <T>({ row, ...props }: TableCheckboxProps<T>) => import("react/jsx-runtime").JSX.Element;
 };
 export default TableCheckbox;

package/dist/src/lib/components/GenericTable/types.d.ts

@@ -1,5 +1,5 @@
 import { Dispatch, ReactNode, SetStateAction } from 'react';
-import { Row, RowData, RowSelectionState } from '@tanstack/react-table';
+import { Row, RowData, RowSelectionState, VisibilityState } from '@tanstack/react-table';
 declare module "@tanstack/react-table" {
     interface ColumnMeta<TData extends RowData, TValue = unknown> {
         /** Custom loading skeleton renderer. Overrides the default shimmer for this column. */
@@ -25,3 +25,7 @@ export type SelectionProps<T extends GenericTableData> = {
     rowSelection?: RowSelectionState;
     setRowSelection?: Dispatch<SetStateAction<RowSelectionState>>;
 };
+export type ColumnVisibilityProps = {
+    columnVisibility: VisibilityState;
+    setColumnVisibility: Dispatch<SetStateAction<VisibilityState>>;
+};

package/dist/src/lib/components/GenericTable/utils/processColumnDefs.d.ts

@@ -1,9 +1,8 @@
 import { ColumnDef } from '@tanstack/react-table';
 import { SelectionProps, GenericTableData } from '../types';
-export declare const processColumnDefs: <T extends GenericTableData>({ canSelect, initialColumns, isLoading, groupBy, getSubRows, selection, showChevron, }: {
+export declare const processColumnDefs: <T extends GenericTableData>({ canSelect, initialColumns, groupBy, getSubRows, selection, showChevron, }: {
     canSelect: boolean;
     initialColumns: ColumnDef<T, Partial<T>>[];
-    isLoading: boolean;
     groupBy: string[] | undefined;
     getSubRows?: (originalRow: T, index: number) => T[] | undefined;
     selection?: SelectionProps<T>;

package/dist/src/lib/components/GenericTable/utils/renderLoadingRows.d.ts

@@ -1,9 +1,11 @@
-import { ColumnDef, Header, Table } from '@tanstack/react-table';
+import { Column, ColumnDef, Header, Row, Table } from '@tanstack/react-table';
 import { GenericTableData } from '../types';
-export declare const renderLoadingRows: <T extends GenericTableData>({ table, columns, filterHeaders, loadingVariant, skeletonRowCount, }: {
+export declare const renderLoadingRows: <T extends GenericTableData>({ table, columns, filterHeaders, filterCells, loadingVariant, skeletonRowCount, skeletonGroupCount, }: {
     table: Table<T>;
     columns: ColumnDef<T, Partial<T>>[];
     filterHeaders: (header: Header<T, unknown>) => boolean;
+    filterCells: (row: Row<T>, column: Column<T>) => boolean;
     loadingVariant?: "skeleton" | "spinner";
     skeletonRowCount: number;
+    skeletonGroupCount: number;
 }) => import("react/jsx-runtime").JSX.Element | import("react/jsx-runtime").JSX.Element[];

package/dist/src/lib/sections/Navigation/Link/Link.stories.d.ts

@@ -0,0 +1,19 @@
+import { Meta } from '@storybook/react';
+import { Navigation } from '../Navigation';
+declare const meta: Meta<typeof Navigation.Link>;
+export default meta;
+export declare const Example: {
+    args: {
+        as: string;
+        href: string;
+        "aria-current": string;
+        children: import("react/jsx-runtime").JSX.Element;
+    };
+};
+export declare const ButtonExample: {
+    args: {
+        as: <P>({ appearance, children, className, dense, disabled, element: Component, hasIcon, inline, onClick, small, ...buttonProps }: import('@canonical/react-components').ButtonProps<P>) => React.JSX.Element;
+        appearance: string;
+        children: import("react/jsx-runtime").JSX.Element;
+    };
+};

package/dist/src/lib/sections/SidePanel/SidePanel.d.ts

@@ -0,0 +1,37 @@
+import { ReactElement } from 'react';
+/**
+ * Slide-in aside panel rendered at the edge of the page.
+ *
+ * Reads all state from the nearest `SidePanelContextProvider` via `useSidePanel`.
+ * The panel has no props of its own — open it by calling `openSidePanel` from the hook.
+ *
+ * Behaviour:
+ * - Collapses automatically when the current route changes
+ * - Closes when the Escape key is pressed
+ * - Resets its size to `"regular"` on unmount
+ *
+ * Size variants (set via `openSidePanel` or `setSidePanelSize`):
+ * - `"narrow"` — adds the `is-narrow` CSS modifier
+ * - `"regular"` — default, no modifier class
+ * - `"wide"` — adds the `is-wide` CSS modifier
+ * - `"large"` — adds the `is-large` CSS modifier
+ *
+ * @requires SidePanelContextProvider — must be present higher in the tree
+ * @requires A React Router context — must be rendered inside a Router
+ *
+ * @example
+ * ```tsx
+ * // In your app root:
+ * <SidePanelContextProvider>
+ *   <Router>
+ *     <main>…</main>
+ *     <SidePanel />
+ *   </Router>
+ * </SidePanelContextProvider>
+ *
+ * // Anywhere in the tree:
+ * const { openSidePanel } = useSidePanel();
+ * openSidePanel({ component: EditForm, title: "Edit item", size: "wide" });
+ * ```
+ */
+export declare const SidePanel: () => ReactElement;

package/dist/src/lib/sections/SidePanel/SidePanel.stories.d.ts

@@ -0,0 +1,10 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { SidePanel } from './SidePanel';
+declare const meta: Meta<typeof SidePanel>;
+export default meta;
+type Story = StoryObj<typeof SidePanel>;
+export declare const Interactive: Story;
+export declare const Default: Story;
+export declare const NarrowSize: Story;
+export declare const WideSize: Story;
+export declare const LargeSize: Story;

package/dist/src/lib/sections/SidePanel/SidePanel.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/lib/sections/SidePanel/SidePanelContextProvider/SidePanelContextProvider.d.ts

@@ -0,0 +1,95 @@
+import { ComponentType, PropsWithChildren, ReactElement } from 'react';
+type SidePanelSize = "large" | "narrow" | "regular" | "wide";
+interface SidePanelState<TProps = Record<string, unknown>> {
+    isOpen: boolean;
+    title: string;
+    size: SidePanelSize;
+    component: ComponentType<TProps> | null;
+    props: TProps;
+}
+export interface SidePanelActions {
+    openSidePanel: <TProps extends Record<string, unknown> = Record<string, unknown>>(params: {
+        component: ComponentType<TProps>;
+        title: string;
+        props?: TProps;
+        size?: SidePanelSize;
+    }) => void;
+    closeSidePanel: () => void;
+    setSidePanelSize: (size: SidePanelSize) => void;
+}
+type SidePanelContextValue = SidePanelActions & SidePanelState;
+/**
+ * Hook for managing side panel state and actions.
+ *
+ * Provides methods to open/close side panels with React components and manages
+ * panel size and visibility state.
+ *
+ * @returns Object containing:
+ *   - `isOpen`: Boolean indicating if the side panel is currently open
+ *   - `title`: Current panel title string
+ *   - `size`: Current panel size ('narrow' | 'regular' | 'wide' | 'large')
+ *   - `component`: Currently rendered component
+ *   - `props`: Props passed to the current component
+ *   - `openSidePanel({component, title, props?, size?})`: Opens panel with given component
+ *   - `closeSidePanel()`: Closes the panel and resets state
+ *   - `setSidePanelSize(size)`: Changes the panel width
+ *
+ * @throws Error when used outside SidePanelProvider
+ *
+ * @example
+ * ```tsx
+ * const { open, close, isOpen } = useSidePanel();
+ *
+ * // Open a panel with a form component
+ * const handleEdit = (userId: number) => {
+ *   open(EditUserForm, 'Edit User', { userId }, 'wide');
+ * };
+ *
+ * // Close the panel
+ * const handleCancel = () => {
+ *   close();
+ * };
+ * ```
+ */
+export declare const useSidePanel: () => SidePanelContextValue;
+/**
+ * Provider component for managing side panel state and actions.
+ *
+ * Wraps your application or subtree to provide side panel context to all child
+ * components. Child components can use the `useSidePanel` hook to access and
+ * control the side panel.
+ *
+ * @param children - React elements to render within the provider
+ *
+ * @returns A React element wrapping children with SidePanelContext
+ *
+ * @example
+ * ```tsx
+ * function App() {
+ *   return (
+ *     <SidePanelContextProvider>
+ *       <MainLayout />
+ *     </SidePanelContextProvider>
+ *   );
+ * }
+ *
+ * function MainLayout() {
+ *   const { openSidePanel, closeSidePanel, isOpen } = useSidePanel();
+ *
+ *   return (
+ *     <>
+ *       <button onClick={() => openSidePanel({
+ *         component: UserForm,
+ *         title: 'Create User',
+ *         size: 'wide'
+ *       })}>
+ *         New User
+ *       </button>
+ *       {isOpen && <SidePanel />}
+ *     </>
+ *   );
+ * }
+ * ```
+ */
+export declare const SidePanelContextProvider: ({ children, }: PropsWithChildren) => ReactElement;
+export {};

package/dist/src/lib/sections/SidePanel/index.d.ts

@@ -0,0 +1,2 @@
+export { SidePanel } from './SidePanel';
+export { SidePanelContextProvider, useSidePanel } from './SidePanelContextProvider/SidePanelContextProvider';

package/dist/src/lib/sections/index.d.ts

@@ -1,5 +1,6 @@
-export * from './Navigation';
-export * from './InputGroup';
+export * from './ContentSection';
 export * from './FormSection';
+export * from './InputGroup';
 export * from './MainToolbar';
-export * from './ContentSection';
+export * from './Navigation';
+export * from './SidePanel';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@canonical/maas-react-components",
   "description": "React components for use in MAAS UI projects.",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/canonical/maas-react-components.git"
@@ -93,7 +93,7 @@
     "vitest": "^3.0.8"
   },
   "peerDependencies": {
-    "@canonical/react-components": "^2.2.0",
+    "@canonical/react-components": "^4.5.0",
     "@tanstack/react-table": "^8.15.3",
     "@types/react": "^19.1.2",
     "@types/react-dom": "^19.1.3",
@@ -101,6 +101,7 @@
     "react": "19.1.0",
     "react-dom": "19.1.0",
     "react-dropzone": "14.3.8",
+    "react-router": "^6.0.0",
     "react-router-dom": "^6.0.0",
     "vanilla-framework": "^4.10.0"
   }