@patternfly/react-data-view 5.0.1 → 5.1.1

package/src/DataViewTable/__snapshots__/DataViewTable.test.tsx.snap

@@ -0,0 +1,320 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`DataViewTable component should render correctly 1`] = `
+<div>
+  <table
+    aria-label="Repositories table"
+    class="pf-v5-c-table pf-m-grid-md"
+    data-ouia-component-id="TableExample"
+    data-ouia-component-type="PF5/Table"
+    data-ouia-safe="true"
+    role="grid"
+  >
+    <thead
+      class="pf-v5-c-table__thead"
+      data-ouia-component-id="TableExample-thead"
+    >
+      <tr
+        class="pf-v5-c-table__tr"
+        data-ouia-component-id="TableExample-tr-head"
+        data-ouia-component-type="PF5/TableRow"
+        data-ouia-safe="true"
+      >
+        <th
+          class="pf-v5-c-table__th"
+          data-ouia-component-id="TableExample-th-0"
+          scope="col"
+          tabindex="-1"
+        >
+          Repositories
+        </th>
+        <th
+          class="pf-v5-c-table__th"
+          data-ouia-component-id="TableExample-th-1"
+          scope="col"
+          tabindex="-1"
+        >
+          Branches
+        </th>
+        <th
+          class="pf-v5-c-table__th"
+          data-ouia-component-id="TableExample-th-2"
+          scope="col"
+          tabindex="-1"
+        >
+          Pull requests
+        </th>
+        <th
+          class="pf-v5-c-table__th"
+          data-ouia-component-id="TableExample-th-3"
+          scope="col"
+          tabindex="-1"
+        >
+          Workspaces
+        </th>
+        <th
+          class="pf-v5-c-table__th"
+          data-ouia-component-id="TableExample-th-4"
+          scope="col"
+          tabindex="-1"
+        >
+          Last commit
+        </th>
+      </tr>
+    </thead>
+    <tbody
+      class="pf-v5-c-table__tbody"
+      role="rowgroup"
+    >
+      <tr
+        class="pf-v5-c-table__tr"
+        data-ouia-component-id="TableExample-tr-0"
+        data-ouia-component-type="PF5/TableRow"
+        data-ouia-safe="true"
+      >
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-0-0"
+          tabindex="-1"
+        >
+          one
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-0-1"
+          tabindex="-1"
+        >
+          two
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-0-2"
+          tabindex="-1"
+        >
+          three
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-0-3"
+          tabindex="-1"
+        >
+          four
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-0-4"
+          tabindex="-1"
+        >
+          five
+        </td>
+      </tr>
+      <tr
+        class="pf-v5-c-table__tr"
+        data-ouia-component-id="TableExample-tr-1"
+        data-ouia-component-type="PF5/TableRow"
+        data-ouia-safe="true"
+      >
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-1-0"
+          tabindex="-1"
+        >
+          one - 2
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-1-1"
+          tabindex="-1"
+        />
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-1-2"
+          tabindex="-1"
+        />
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-1-3"
+          tabindex="-1"
+        >
+          four - 2
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-1-4"
+          tabindex="-1"
+        >
+          five - 2
+        </td>
+      </tr>
+      <tr
+        class="pf-v5-c-table__tr"
+        data-ouia-component-id="TableExample-tr-2"
+        data-ouia-component-type="PF5/TableRow"
+        data-ouia-safe="true"
+      >
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-2-0"
+          tabindex="-1"
+        >
+          one - 3
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-2-1"
+          tabindex="-1"
+        >
+          two - 3
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-2-2"
+          tabindex="-1"
+        >
+          three - 3
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-2-3"
+          tabindex="-1"
+        >
+          four - 3
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-2-4"
+          tabindex="-1"
+        >
+          five - 3
+        </td>
+      </tr>
+      <tr
+        class="pf-v5-c-table__tr"
+        data-ouia-component-id="TableExample-tr-3"
+        data-ouia-component-type="PF5/TableRow"
+        data-ouia-safe="true"
+      >
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-3-0"
+          tabindex="-1"
+        >
+          one - 4
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-3-1"
+          tabindex="-1"
+        >
+          two - 4
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-3-2"
+          tabindex="-1"
+        >
+          null
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-3-3"
+          tabindex="-1"
+        >
+          four - 4
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-3-4"
+          tabindex="-1"
+        >
+          five - 4
+        </td>
+      </tr>
+      <tr
+        class="pf-v5-c-table__tr"
+        data-ouia-component-id="TableExample-tr-4"
+        data-ouia-component-type="PF5/TableRow"
+        data-ouia-safe="true"
+      >
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-4-0"
+          tabindex="-1"
+        >
+          one - 5
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-4-1"
+          tabindex="-1"
+        >
+          two - 5
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-4-2"
+          tabindex="-1"
+        >
+          three - 5
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-4-3"
+          tabindex="-1"
+        >
+          four - 5
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-4-4"
+          tabindex="-1"
+        >
+          five - 5
+        </td>
+      </tr>
+      <tr
+        class="pf-v5-c-table__tr"
+        data-ouia-component-id="TableExample-tr-5"
+        data-ouia-component-type="PF5/TableRow"
+        data-ouia-safe="true"
+      >
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-5-0"
+          tabindex="-1"
+        >
+          one - 6
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-5-1"
+          tabindex="-1"
+        >
+          two - 6
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-5-2"
+          tabindex="-1"
+        >
+          three - 6
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-5-3"
+          tabindex="-1"
+        >
+          four - 6
+        </td>
+        <td
+          class="pf-v5-c-table__td"
+          data-ouia-component-id="TableExample-td-5-4"
+          tabindex="-1"
+        >
+          five - 6
+        </td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+`;

package/src/DataViewTable/index.ts

@@ -0,0 +1,2 @@
+export { default } from './DataViewTable';
+export * from './DataViewTable';

package/src/Hooks/pagination.test.tsx

@@ -49,9 +49,89 @@ describe('useDataViewPagination', () => {
     expect(result.current).toEqual({ 
       onPerPageSelect: expect.any(Function),
       onSetPage: expect.any(Function),
-      page: 3,
+      page: 1,
       perPage: 50
     })
   });
 
+  it('should read pagination state from URL', () => {
+    const mockSearchParams = new URLSearchParams('page=2&perPage=10');
+    const { result } = renderHook(() =>
+      useDataViewPagination({
+        searchParams: mockSearchParams,
+        setSearchParams: jest.fn(),
+        page: 1,
+        perPage: 5,
+      })
+    );
+
+    expect(result.current).toEqual({
+      onPerPageSelect: expect.any(Function),
+      onSetPage: expect.any(Function),
+      page: 2,
+      perPage: 10,
+    });
+  });
+
+  it('should set pagination state in URL when page changes', () => {
+    const mockSetSearchParams = jest.fn();
+    const { result } = renderHook(() =>
+      useDataViewPagination({
+        searchParams: new URLSearchParams(),
+        setSearchParams: mockSetSearchParams,
+        page: 1,
+        perPage: 5,
+      })
+    );
+
+    expect(mockSetSearchParams).toHaveBeenNthCalledWith(
+      1, 
+      new URLSearchParams('page=1&perPage=5')
+    );
+
+    act(() => {
+      result.current.onSetPage(undefined, 4);
+    });
+
+    expect(mockSetSearchParams).toHaveBeenNthCalledWith(
+      2,
+      new URLSearchParams('page=4&perPage=5')
+    );
+  });
+
+  it('should set pagination state in URL when perPage changes', () => {
+    const mockSetSearchParams = jest.fn();
+    const { result } = renderHook(() =>
+      useDataViewPagination({
+        searchParams: new URLSearchParams('page=2'),
+        setSearchParams: mockSetSearchParams,
+        page: 1,
+        perPage: 5,
+      })
+    );
+
+    act(() => {
+      result.current.onPerPageSelect(undefined, 20);
+    });
+
+    expect(mockSetSearchParams).toHaveBeenCalledWith(
+      new URLSearchParams('page=1&perPage=20')
+    );
+  });
+
+  it('should initialize URL with default values if not present', () => {
+    const mockSetSearchParams = jest.fn();
+    renderHook(() =>
+      useDataViewPagination({
+        searchParams: new URLSearchParams(),
+        setSearchParams: mockSetSearchParams,
+        page: 1,
+        perPage: 5,
+      })
+    );
+
+    expect(mockSetSearchParams).toHaveBeenCalledWith(
+      new URLSearchParams('page=1&perPage=5')
+    );
+  });
 });

package/src/Hooks/pagination.ts

@@ -1,31 +1,87 @@
-import { useState } from "react";
+import { useState, useEffect } from "react";
+
+export enum PaginationParams {
+  PAGE = 'page',
+  PER_PAGE = 'perPage'
+}
 
 export interface UseDataViewPaginationProps {
   /** Initial page */
   page?: number;
   /** Items per page */
   perPage: number;
+  /** Current search parameters as a string */
+  searchParams?: URLSearchParams;
+  /** Function to set search parameters */
+  setSearchParams?: (params: URLSearchParams) => void;
+  /** Custom URL parameter name for page */
+  pageParam?: string;
+  /** Custom URL parameter name for per page */
+  perPageParam?: string;
 }
 
 export interface DataViewPaginationProps extends UseDataViewPaginationProps {
   /** Current page number */
-    page: number;
+  page: number;
 }
 
-export const useDataViewPagination = ({ page = 1, perPage }: UseDataViewPaginationProps) => { 
-  const [ state, setState ] = useState({ page, perPage });
-  
-  const onPerPageSelect = (_event: React.MouseEvent | React.KeyboardEvent | MouseEvent | undefined, newPerPage: number) => {
-    setState(prev => ({ ...prev, perPage: newPerPage }));
-  }
-  
-  const onSetPage = (_event: React.MouseEvent | React.KeyboardEvent | MouseEvent | undefined, newPage: number) => {
+export const useDataViewPagination = ({
+  page = 1,
+  perPage,
+  searchParams,
+  setSearchParams,
+  pageParam = PaginationParams.PAGE,
+  perPageParam = PaginationParams.PER_PAGE,
+}: UseDataViewPaginationProps) => {
+  const [ state, setState ] = useState({
+    page: parseInt(searchParams?.get(pageParam) || `${page}`),
+    perPage: parseInt(searchParams?.get(perPageParam) || `${perPage}`),
+  });
+
+  const updateSearchParams = (page: number, perPage: number) => {
+    if (searchParams && setSearchParams) {
+      const params = new URLSearchParams(searchParams);
+      params.set(pageParam, `${page}`);
+      params.set(perPageParam, `${perPage}`);
+      setSearchParams(params);
+    }
+  };
+
+  useEffect(() => {
+    // Make sure search params are loaded or set if not present on mount
+    updateSearchParams(state.page, state.perPage);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+
+  useEffect(() => {
+    // Listen on URL params changes
+    const currentPage = parseInt(searchParams?.get(pageParam) || `${state.page}`);
+    const currentPerPage = parseInt(searchParams?.get(perPageParam) || `${state.perPage}`);
+    if (currentPage !== state.page || currentPerPage !== state.perPage) {
+      setState({ page: currentPage, perPage: currentPerPage });
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [ searchParams?.toString() ]);
+
+  const onPerPageSelect = (
+    _event: React.MouseEvent | React.KeyboardEvent | MouseEvent | undefined,
+    newPerPage: number
+  ) => {
+    updateSearchParams(1, newPerPage);
+    setState({ perPage: newPerPage, page: 1 });
+  };
+
+  const onSetPage = (
+    _event: React.MouseEvent | React.KeyboardEvent | MouseEvent | undefined,
+    newPage: number
+  ) => {
+    updateSearchParams(newPage, state.perPage);
     setState(prev => ({ ...prev, page: newPage }));
-  }
-  
+  };
+
   return {
     ...state,
     onPerPageSelect,
-    onSetPage
-  }
-}
+    onSetPage,
+  };
+};

package/src/Hooks/selection.test.tsx

@@ -4,7 +4,7 @@ import { useDataViewSelection } from './selection';
 
 describe('useDataViewSelection', () => {
   it('should get initial state correctly - no initialSelected', () => {
-    const { result } = renderHook(() => useDataViewSelection({}))
+    const { result } = renderHook(() => useDataViewSelection({ matchOption: (a, b) => a.id === b.id }))
     expect(result.current).toEqual({ 
       selected: [],
       onSelect: expect.any(Function),
@@ -14,7 +14,7 @@ describe('useDataViewSelection', () => {
 
   it('should get initial state correctly - with initialSelected', () => {
     const initialSelected = [ { id: 1, name: 'test1' } ];
-    const { result } = renderHook(() => useDataViewSelection({ initialSelected }))
+    const { result } = renderHook(() => useDataViewSelection({ initialSelected, matchOption: (a, b) => a.id === b.id }))
     expect(result.current).toEqual({ 
       selected: initialSelected,
       onSelect: expect.any(Function),
@@ -24,7 +24,7 @@ describe('useDataViewSelection', () => {
 
   it('should select items correctly - objects', async () => {
     const initialSelected = [ { id: 1, name: 'test1' } ];
-    const { result } = renderHook(() => useDataViewSelection({ initialSelected }))
+    const { result } = renderHook(() => useDataViewSelection({ initialSelected, matchOption: (a, b) => a.id === b.id }))
     
     await act(async () => {
       result.current.onSelect(true, { id: 2, name: 'test2' });
@@ -34,7 +34,7 @@ describe('useDataViewSelection', () => {
 
   it('should deselect items correctly - strings', async () => {
     const initialSelected = [ 'test1', 'test2' ];
-    const { result } = renderHook(() => useDataViewSelection({ initialSelected }))
+    const { result } = renderHook(() => useDataViewSelection({ initialSelected, matchOption: (a, b) => a === b }))
     
     await act(async () => {
       result.current.onSelect(false, 'test2');
@@ -44,7 +44,7 @@ describe('useDataViewSelection', () => {
 
   it('should check if item is selected correctly - objects', () => {
     const initialSelected = [ { id: 1, name: 'test1' }, { id: 2, name: 'test2' } ];
-    const { result } = renderHook(() => useDataViewSelection({ initialSelected, matchOption: (a,b) => a.id === b.id }))
+    const { result } = renderHook(() => useDataViewSelection({ initialSelected, matchOption: (a, b) => a.id === b.id }))
     
     expect(result.current.isSelected({ id: 1, name: 'test1' })).toBe(true);
     expect(result.current.isSelected({ id: 3, name: 'test2' })).toBe(false);

package/src/Hooks/selection.ts

@@ -2,18 +2,17 @@
 import { useState } from "react";
 
 export interface UseDataViewSelectionProps {
+  /** Function to compare items when checking if item is selected */
+  matchOption: (item: any, another: any) => boolean;
   /** Array of initially selected entries */
   initialSelected?: (any)[];
-  /** Function to compare items when checking if entry is selected */
-  matchOption?: (item: any, another: any) => boolean;
 }
 
-export const useDataViewSelection = (props: UseDataViewSelectionProps) => {
-  const [ selected, setSelected ] = useState<any[]>(props.initialSelected ?? []);
-  const matchOption = props.matchOption ? props.matchOption : (option, another) => (option === another);
+export const useDataViewSelection = ({ matchOption, initialSelected = [] }: UseDataViewSelectionProps) => {
+  const [ selected, setSelected ] = useState<any[]>(initialSelected);
 
   const onSelect = (isSelecting: boolean, items?: any[] | any) => {
-    isSelecting ?
+    isSelecting && items ?
       setSelected(prev => {
         const newSelectedItems = [ ...prev ];
         (Array.isArray(items) ? items : [ items ]).forEach(newItem => !prev.some(prevItem => matchOption(prevItem, newItem)) && newSelectedItems.push(newItem));
@@ -22,7 +21,7 @@ export const useDataViewSelection = (props: UseDataViewSelectionProps) => {
       : setSelected(items ? prev => prev.filter(prevSelected => !(Array.isArray(items) ? items : [ items ]).some(item => matchOption(item, prevSelected))) : []);
   };
   
-  const isSelected = (item: any): boolean => props?.matchOption ? Boolean(selected.find(selected => matchOption(selected, item))) : selected.includes(item);
+  const isSelected = (item: any): boolean => Boolean(selected.find(selected => matchOption(selected, item)));
 
   return {
     selected,

package/src/InternalContext/InternalContext.test.tsx

@@ -0,0 +1,88 @@
+import React from 'react';
+import { render, fireEvent } from '@testing-library/react';
+import '@testing-library/jest-dom'; 
+import { InternalContextProvider, useInternalContext, DataViewSelection } from './InternalContext';
+
+describe('InternalContext', () => {
+  const mockSelection: DataViewSelection = {
+    onSelect: jest.fn(),
+    isSelected: jest.fn(),
+    isSelectDisabled: jest.fn(),
+  };
+
+  test('should provide context value and allow consuming it', () => {
+    const TestComponent = () => {
+      const { selection } = useInternalContext();
+      
+      return (
+        <div>
+          <button onClick={() => selection?.onSelect(true, [ 'item1' ])}>Select item</button>
+          <span>{selection?.isSelected('item1') ? 'Selected' : 'Not selected'}</span>
+        </div>
+      );
+    };
+
+    const { getByText } = render(
+      <InternalContextProvider selection={mockSelection}>
+        <TestComponent />
+      </InternalContextProvider>
+    );
+
+    fireEvent.click(getByText('Select item'));
+    expect(mockSelection.onSelect).toHaveBeenCalledWith(true, [ 'item1' ]);
+  });
+
+  test('should handle selection state correctly', () => {
+    const mockSelectionState = {
+      ...mockSelection,
+      isSelected: jest.fn((item) => item === 'item1'),
+    };
+
+    const TestComponent = () => {
+      const { selection } = useInternalContext();
+
+      return (
+        <div>
+          <span>{selection?.isSelected('item1') ? 'Item 1 is selected' : 'Item 1 is not selected'}</span>
+          <span>{selection?.isSelected('item2') ? 'Item 2 is selected' : 'Item 2 is not selected'}</span>
+        </div>
+      );
+    };
+
+    const { getByText } = render(
+      <InternalContextProvider selection={mockSelectionState}>
+        <TestComponent />
+      </InternalContextProvider>
+    );
+
+    expect(getByText('Item 1 is selected')).toBeInTheDocument();
+    expect(getByText('Item 2 is not selected')).toBeInTheDocument();
+  });
+
+  test('should handle selection disabled correctly', () => {
+    const mockSelectionWithDisabled = {
+      ...mockSelection,
+      isSelectDisabled: jest.fn((item) => item === 'item3'),
+    };
+
+    const TestComponent = () => {
+      const { selection } = useInternalContext();
+
+      return (
+        <div>
+          <span>{selection?.isSelectDisabled?.('item3') ? 'Item 3 is disabled' : 'Item 3 is enabled'}</span>
+          <span>{selection?.isSelectDisabled?.('item1') ? 'Item 1 is disabled' : 'Item 1 is enabled'}</span>
+        </div>
+      );
+    };
+
+    const { getByText } = render(
+      <InternalContextProvider selection={mockSelectionWithDisabled}>
+        <TestComponent />
+      </InternalContextProvider>
+    );
+
+    expect(getByText('Item 3 is disabled')).toBeInTheDocument();
+    expect(getByText('Item 1 is enabled')).toBeInTheDocument();
+  });
+});