@patternfly/react-data-view 5.6.0 → 5.7.0

package/dist/cjs/Hooks/index.d.ts

@@ -1,3 +1,4 @@
 export * from './pagination';
 export * from './selection';
 export * from './filters';
+export * from './sort';

package/dist/cjs/Hooks/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./pagination"), exports);
 __exportStar(require("./selection"), exports);
 __exportStar(require("./filters"), exports);
+__exportStar(require("./sort"), exports);

package/dist/cjs/Hooks/sort.d.ts

@@ -0,0 +1,32 @@
+import { ISortBy } from "@patternfly/react-table";
+export declare enum DataViewSortParams {
+    SORT_BY = "sortBy",
+    DIRECTION = "direction"
+}
+export interface DataViewSortConfig {
+    /** Attribute to sort the entries by */
+    sortBy: string | undefined;
+    /** Sort direction */
+    direction: ISortBy['direction'];
+}
+export interface UseDataViewSortProps {
+    /** Initial sort config */
+    initialSort?: DataViewSortConfig;
+    /** Current search parameters as a string */
+    searchParams?: URLSearchParams;
+    /** Function to set search parameters */
+    setSearchParams?: (params: URLSearchParams) => void;
+    /** Default direction */
+    defaultDirection?: ISortBy['direction'];
+    /** Sort by URL param name */
+    sortByParam?: string;
+    /** Direction URL param name */
+    directionParam?: string;
+}
+export declare const useDataViewSort: (props?: UseDataViewSortProps) => {
+    onSort: (_event: React.MouseEvent | React.KeyboardEvent | MouseEvent | undefined, newSortBy: string, newSortDirection: ISortBy['direction']) => void;
+    /** Attribute to sort the entries by */
+    sortBy: string | undefined;
+    /** Sort direction */
+    direction: ISortBy['direction'];
+};

package/dist/cjs/Hooks/sort.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useDataViewSort = exports.DataViewSortParams = void 0;
+const react_1 = require("react");
+var DataViewSortParams;
+(function (DataViewSortParams) {
+    DataViewSortParams["SORT_BY"] = "sortBy";
+    DataViewSortParams["DIRECTION"] = "direction";
+})(DataViewSortParams || (exports.DataViewSortParams = DataViewSortParams = {}));
+;
+const validateDirection = (direction, defaultDirection) => (direction === 'asc' || direction === 'desc' ? direction : defaultDirection);
+;
+;
+const useDataViewSort = (props) => {
+    var _a;
+    const { initialSort, searchParams, setSearchParams, defaultDirection = 'asc', sortByParam = DataViewSortParams.SORT_BY, directionParam = DataViewSortParams.DIRECTION } = props !== null && props !== void 0 ? props : {};
+    const isUrlSyncEnabled = (0, react_1.useMemo)(() => searchParams && !!setSearchParams, [searchParams, setSearchParams]);
+    const [state, setState] = (0, react_1.useState)({
+        sortBy: (_a = searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(sortByParam)) !== null && _a !== void 0 ? _a : initialSort === null || initialSort === void 0 ? void 0 : initialSort.sortBy,
+        direction: validateDirection(searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(directionParam), initialSort === null || initialSort === void 0 ? void 0 : initialSort.direction),
+    });
+    const updateSearchParams = (sortBy, direction) => {
+        if (isUrlSyncEnabled && sortBy) {
+            const params = new URLSearchParams(searchParams);
+            params.set(sortByParam, `${sortBy}`);
+            params.set(directionParam, `${direction}`);
+            setSearchParams === null || setSearchParams === void 0 ? void 0 : setSearchParams(params);
+        }
+    };
+    (0, react_1.useEffect)(() => {
+        state.sortBy && state.direction && updateSearchParams(state.sortBy, state.direction);
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, []);
+    (0, react_1.useEffect)(() => {
+        const currentSortBy = (searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(sortByParam)) || state.sortBy;
+        const currentDirection = (searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(directionParam)) || state.direction;
+        const validDirection = validateDirection(currentDirection, defaultDirection);
+        currentSortBy !== state.sortBy || validDirection !== state.direction && setState({ sortBy: currentSortBy, direction: validDirection });
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [searchParams === null || searchParams === void 0 ? void 0 : searchParams.toString()]);
+    const onSort = (_event, newSortBy, newSortDirection) => {
+        setState({ sortBy: newSortBy, direction: newSortDirection });
+        updateSearchParams(newSortBy, newSortDirection);
+    };
+    return Object.assign(Object.assign({}, state), { onSort });
+};
+exports.useDataViewSort = useDataViewSort;

package/dist/cjs/Hooks/sort.test.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/dist/cjs/Hooks/sort.test.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("@testing-library/jest-dom");
+const react_1 = require("@testing-library/react");
+const sort_1 = require("./sort");
+describe('useDataViewSort', () => {
+    const initialSort = { sortBy: 'name', direction: 'asc' };
+    it('should initialize with provided initial sort config', () => {
+        const { result } = (0, react_1.renderHook)(() => (0, sort_1.useDataViewSort)({ initialSort }));
+        expect(result.current).toEqual(expect.objectContaining(initialSort));
+    });
+    it('should initialize with empty sort config if no initialSort is provided', () => {
+        const { result } = (0, react_1.renderHook)(() => (0, sort_1.useDataViewSort)());
+        expect(result.current).toEqual(expect.objectContaining({ sortBy: undefined, direction: 'asc' }));
+    });
+    it('should update sort state when onSort is called', () => {
+        const { result } = (0, react_1.renderHook)(() => (0, sort_1.useDataViewSort)({ initialSort }));
+        (0, react_1.act)(() => {
+            result.current.onSort(undefined, 'age', 'desc');
+        });
+        expect(result.current).toEqual(expect.objectContaining({ sortBy: 'age', direction: 'desc' }));
+    });
+    it('should sync with URL search params if isUrlSyncEnabled', () => {
+        const searchParams = new URLSearchParams();
+        const setSearchParams = jest.fn();
+        const props = {
+            initialSort,
+            searchParams,
+            setSearchParams,
+        };
+        const { result } = (0, react_1.renderHook)(() => (0, sort_1.useDataViewSort)(props));
+        expect(setSearchParams).toHaveBeenCalledTimes(1);
+        expect(result.current).toEqual(expect.objectContaining(initialSort));
+    });
+    it('should validate direction and fallback to default direction if invalid direction is provided', () => {
+        const searchParams = new URLSearchParams();
+        searchParams.set(sort_1.DataViewSortParams.SORT_BY, 'name');
+        searchParams.set(sort_1.DataViewSortParams.DIRECTION, 'invalid-direction');
+        const { result } = (0, react_1.renderHook)(() => (0, sort_1.useDataViewSort)({ searchParams, defaultDirection: 'desc' }));
+        expect(result.current).toEqual(expect.objectContaining({ sortBy: 'name', direction: 'desc' }));
+    });
+    it('should update search params when URL sync is enabled and sort changes', () => {
+        const searchParams = new URLSearchParams();
+        const setSearchParams = jest.fn();
+        const props = {
+            initialSort,
+            searchParams,
+            setSearchParams,
+        };
+        const { result } = (0, react_1.renderHook)(() => (0, sort_1.useDataViewSort)(props));
+        (0, react_1.act)(() => {
+            expect(setSearchParams).toHaveBeenCalledTimes(1);
+            result.current.onSort(undefined, 'priority', 'desc');
+        });
+        expect(setSearchParams).toHaveBeenCalledTimes(2);
+        expect(result.current).toEqual(expect.objectContaining({ sortBy: 'priority', direction: 'desc' }));
+    });
+    it('should prioritize searchParams values', () => {
+        const searchParams = new URLSearchParams();
+        searchParams.set(sort_1.DataViewSortParams.SORT_BY, 'category');
+        searchParams.set(sort_1.DataViewSortParams.DIRECTION, 'desc');
+        const { result } = (0, react_1.renderHook)((props) => (0, sort_1.useDataViewSort)(props), { initialProps: { initialSort, searchParams } });
+        expect(result.current).toEqual(expect.objectContaining({
+            sortBy: 'category',
+            direction: 'desc',
+        }));
+    });
+});

package/dist/esm/Hooks/index.d.ts

@@ -1,3 +1,4 @@
 export * from './pagination';
 export * from './selection';
 export * from './filters';
+export * from './sort';

package/dist/esm/Hooks/index.js

@@ -1,3 +1,4 @@
 export * from './pagination';
 export * from './selection';
 export * from './filters';
+export * from './sort';

package/dist/esm/Hooks/sort.d.ts

@@ -0,0 +1,32 @@
+import { ISortBy } from "@patternfly/react-table";
+export declare enum DataViewSortParams {
+    SORT_BY = "sortBy",
+    DIRECTION = "direction"
+}
+export interface DataViewSortConfig {
+    /** Attribute to sort the entries by */
+    sortBy: string | undefined;
+    /** Sort direction */
+    direction: ISortBy['direction'];
+}
+export interface UseDataViewSortProps {
+    /** Initial sort config */
+    initialSort?: DataViewSortConfig;
+    /** Current search parameters as a string */
+    searchParams?: URLSearchParams;
+    /** Function to set search parameters */
+    setSearchParams?: (params: URLSearchParams) => void;
+    /** Default direction */
+    defaultDirection?: ISortBy['direction'];
+    /** Sort by URL param name */
+    sortByParam?: string;
+    /** Direction URL param name */
+    directionParam?: string;
+}
+export declare const useDataViewSort: (props?: UseDataViewSortProps) => {
+    onSort: (_event: React.MouseEvent | React.KeyboardEvent | MouseEvent | undefined, newSortBy: string, newSortDirection: ISortBy['direction']) => void;
+    /** Attribute to sort the entries by */
+    sortBy: string | undefined;
+    /** Sort direction */
+    direction: ISortBy['direction'];
+};

package/dist/esm/Hooks/sort.js

@@ -0,0 +1,43 @@
+import { useState, useEffect, useMemo } from "react";
+export var DataViewSortParams;
+(function (DataViewSortParams) {
+    DataViewSortParams["SORT_BY"] = "sortBy";
+    DataViewSortParams["DIRECTION"] = "direction";
+})(DataViewSortParams || (DataViewSortParams = {}));
+;
+const validateDirection = (direction, defaultDirection) => (direction === 'asc' || direction === 'desc' ? direction : defaultDirection);
+;
+;
+export const useDataViewSort = (props) => {
+    var _a;
+    const { initialSort, searchParams, setSearchParams, defaultDirection = 'asc', sortByParam = DataViewSortParams.SORT_BY, directionParam = DataViewSortParams.DIRECTION } = props !== null && props !== void 0 ? props : {};
+    const isUrlSyncEnabled = useMemo(() => searchParams && !!setSearchParams, [searchParams, setSearchParams]);
+    const [state, setState] = useState({
+        sortBy: (_a = searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(sortByParam)) !== null && _a !== void 0 ? _a : initialSort === null || initialSort === void 0 ? void 0 : initialSort.sortBy,
+        direction: validateDirection(searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(directionParam), initialSort === null || initialSort === void 0 ? void 0 : initialSort.direction),
+    });
+    const updateSearchParams = (sortBy, direction) => {
+        if (isUrlSyncEnabled && sortBy) {
+            const params = new URLSearchParams(searchParams);
+            params.set(sortByParam, `${sortBy}`);
+            params.set(directionParam, `${direction}`);
+            setSearchParams === null || setSearchParams === void 0 ? void 0 : setSearchParams(params);
+        }
+    };
+    useEffect(() => {
+        state.sortBy && state.direction && updateSearchParams(state.sortBy, state.direction);
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, []);
+    useEffect(() => {
+        const currentSortBy = (searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(sortByParam)) || state.sortBy;
+        const currentDirection = (searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(directionParam)) || state.direction;
+        const validDirection = validateDirection(currentDirection, defaultDirection);
+        currentSortBy !== state.sortBy || validDirection !== state.direction && setState({ sortBy: currentSortBy, direction: validDirection });
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [searchParams === null || searchParams === void 0 ? void 0 : searchParams.toString()]);
+    const onSort = (_event, newSortBy, newSortDirection) => {
+        setState({ sortBy: newSortBy, direction: newSortDirection });
+        updateSearchParams(newSortBy, newSortDirection);
+    };
+    return Object.assign(Object.assign({}, state), { onSort });
+};

package/dist/esm/Hooks/sort.test.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/dist/esm/Hooks/sort.test.js

@@ -0,0 +1,66 @@
+import '@testing-library/jest-dom';
+import { renderHook, act } from '@testing-library/react';
+import { useDataViewSort, DataViewSortParams } from './sort';
+describe('useDataViewSort', () => {
+    const initialSort = { sortBy: 'name', direction: 'asc' };
+    it('should initialize with provided initial sort config', () => {
+        const { result } = renderHook(() => useDataViewSort({ initialSort }));
+        expect(result.current).toEqual(expect.objectContaining(initialSort));
+    });
+    it('should initialize with empty sort config if no initialSort is provided', () => {
+        const { result } = renderHook(() => useDataViewSort());
+        expect(result.current).toEqual(expect.objectContaining({ sortBy: undefined, direction: 'asc' }));
+    });
+    it('should update sort state when onSort is called', () => {
+        const { result } = renderHook(() => useDataViewSort({ initialSort }));
+        act(() => {
+            result.current.onSort(undefined, 'age', 'desc');
+        });
+        expect(result.current).toEqual(expect.objectContaining({ sortBy: 'age', direction: 'desc' }));
+    });
+    it('should sync with URL search params if isUrlSyncEnabled', () => {
+        const searchParams = new URLSearchParams();
+        const setSearchParams = jest.fn();
+        const props = {
+            initialSort,
+            searchParams,
+            setSearchParams,
+        };
+        const { result } = renderHook(() => useDataViewSort(props));
+        expect(setSearchParams).toHaveBeenCalledTimes(1);
+        expect(result.current).toEqual(expect.objectContaining(initialSort));
+    });
+    it('should validate direction and fallback to default direction if invalid direction is provided', () => {
+        const searchParams = new URLSearchParams();
+        searchParams.set(DataViewSortParams.SORT_BY, 'name');
+        searchParams.set(DataViewSortParams.DIRECTION, 'invalid-direction');
+        const { result } = renderHook(() => useDataViewSort({ searchParams, defaultDirection: 'desc' }));
+        expect(result.current).toEqual(expect.objectContaining({ sortBy: 'name', direction: 'desc' }));
+    });
+    it('should update search params when URL sync is enabled and sort changes', () => {
+        const searchParams = new URLSearchParams();
+        const setSearchParams = jest.fn();
+        const props = {
+            initialSort,
+            searchParams,
+            setSearchParams,
+        };
+        const { result } = renderHook(() => useDataViewSort(props));
+        act(() => {
+            expect(setSearchParams).toHaveBeenCalledTimes(1);
+            result.current.onSort(undefined, 'priority', 'desc');
+        });
+        expect(setSearchParams).toHaveBeenCalledTimes(2);
+        expect(result.current).toEqual(expect.objectContaining({ sortBy: 'priority', direction: 'desc' }));
+    });
+    it('should prioritize searchParams values', () => {
+        const searchParams = new URLSearchParams();
+        searchParams.set(DataViewSortParams.SORT_BY, 'category');
+        searchParams.set(DataViewSortParams.DIRECTION, 'desc');
+        const { result } = renderHook((props) => useDataViewSort(props), { initialProps: { initialSort, searchParams } });
+        expect(result.current).toEqual(expect.objectContaining({
+            sortBy: 'category',
+            direction: 'desc',
+        }));
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patternfly/react-data-view",
-  "version": "5.6.0",
+  "version": "5.7.0",
   "description": "Data view used for Red Hat projects.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/patternfly-docs/content/extensions/data-view/examples/Functionality/Functionality.md

@@ -16,7 +16,7 @@ sourceLink: https://github.com/patternfly/react-data-view/blob/main/packages/mod
 ---
 import { useMemo } from 'react';
 import { BrowserRouter, useSearchParams } from 'react-router-dom';
-import { useDataViewPagination, useDataViewSelection, useDataViewFilters } from '@patternfly/react-data-view/dist/dynamic/Hooks';
+import { useDataViewPagination, useDataViewSelection, useDataViewFilters, useDataViewSort } from '@patternfly/react-data-view/dist/dynamic/Hooks';
 import { DataView } from '@patternfly/react-data-view/dist/dynamic/DataView';
 import { BulkSelect, BulkSelectValue } from '@patternfly/react-component-groups/dist/dynamic/BulkSelect';
 import { DataViewToolbar } from '@patternfly/react-data-view/dist/dynamic/DataViewToolbar';
@@ -119,3 +119,34 @@ This example demonstrates the setup and usage of filters within the data view. I
 ```js file="./FiltersExample.tsx"
 
 ```
+
+### Sort state
+
+The `useDataViewSort` hook manages the sorting state of a data view. It provides an easy way to handle sorting logic, including synchronization with URL parameters and defining default sorting behavior.
+
+**Initial values:**
+- `initialSort` object to set default `sortBy` and `direction` values:
+  - `sortBy`: key of the initial column to sort.
+  - `direction`: default sorting direction (`asc` or `desc`).
+- Optional `searchParams` object to manage URL-based synchronization of sort state.
+- Optional `setSearchParams` function to update the URL parameters when sorting changes.
+- `defaultDirection` to set the default direction when no direction is specified.
+- Customizable parameter names for the URL:
+  - `sortByParam`: name of the URL parameter for the column key.
+  - `directionParam`: name of the URL parameter for the sorting direction.
+
+The `useDataViewSort` hook integrates seamlessly with React Router to manage sort state via URL parameters. Alternatively, you can use `URLSearchParams` and `window.history.pushState` APIs, or other routing libraries. If URL synchronization is not configured, the sort state is managed internally within the component.
+
+**Return values:**
+- `sortBy`: key of the column currently being sorted.
+- `direction`: current sorting direction (`asc` or `desc`).
+- `onSort`: function to handle sorting changes programmatically or via user interaction.
+
+### Sorting example
+
+This example demonstrates how to set up and use sorting functionality within a data view. The implementation includes dynamic sorting by column with persistence of sort state in the URL using React Router.
+
+
+```js file="./SortingExample.tsx"
+
+```

package/patternfly-docs/content/extensions/data-view/examples/Functionality/SortingExample.tsx

@@ -0,0 +1,87 @@
+/* eslint-disable no-nested-ternary */
+import React, { useMemo } from 'react';
+import { useDataViewSort } from '@patternfly/react-data-view/dist/dynamic/Hooks';
+import { DataViewTable, DataViewTr, DataViewTh } from '@patternfly/react-data-view/dist/dynamic/DataViewTable';
+import { ThProps } from '@patternfly/react-table';
+import { BrowserRouter, useSearchParams } from 'react-router-dom';
+
+interface Repository {
+  name: string;
+  branches: string;
+  prs: string;
+  workspaces: string;
+  lastCommit: string;
+};
+
+const COLUMNS = [
+  { label: 'Repository', key: 'name', index: 0 },
+  { label: 'Branch', key: 'branches', index: 1 },
+  { label: 'Pull request', key: 'prs', index: 2 },
+  { label: 'Workspace', key: 'workspaces', index: 3 },
+  { label: 'Last commit', key: 'lastCommit', index: 4 }
+];
+
+const repositories: Repository[] = [
+  { name: 'Repository one', branches: 'Branch one', prs: 'Pull request one', workspaces: 'Workspace one', lastCommit: 'Timestamp one' },
+  { name: 'Repository two', branches: 'Branch two', prs: 'Pull request two', workspaces: 'Workspace two', lastCommit: 'Timestamp two' },
+  { name: 'Repository three', branches: 'Branch three', prs: 'Pull request three', workspaces: 'Workspace three', lastCommit: 'Timestamp three' },
+  { name: 'Repository four', branches: 'Branch four', prs: 'Pull request four', workspaces: 'Workspace four', lastCommit: 'Timestamp four' },
+  { name: 'Repository five', branches: 'Branch five', prs: 'Pull request five', workspaces: 'Workspace five', lastCommit: 'Timestamp five' },
+  { name: 'Repository six', branches: 'Branch six', prs: 'Pull request six', workspaces: 'Workspace six', lastCommit: 'Timestamp six' }
+];
+
+const sortData = (data: Repository[], sortBy: string | undefined, direction: 'asc' | 'desc' | undefined) =>
+  sortBy && direction
+    ? [ ...data ].sort((a, b) =>
+      direction === 'asc'
+        ? a[sortBy] < b[sortBy] ? -1 : a[sortBy] > b[sortBy] ? 1 : 0
+        : a[sortBy] > b[sortBy] ? -1 : a[sortBy] < b[sortBy] ? 1 : 0
+    )
+    : data;
+
+const ouiaId = 'TableExample';
+
+export const MyTable: React.FunctionComponent = () => {
+  const [ searchParams, setSearchParams ] = useSearchParams();
+  const { sortBy, direction, onSort } = useDataViewSort({ searchParams, setSearchParams });
+  const sortByIndex = useMemo(() => COLUMNS.findIndex(item => item.key === sortBy), [ sortBy ]);
+
+  const getSortParams = (columnIndex: number): ThProps['sort'] => ({
+    sortBy: {
+      index: sortByIndex,
+      direction,
+      defaultDirection: 'asc'
+    },
+    onSort: (_event, index, direction) => onSort(_event, COLUMNS[index].key, direction),
+    columnIndex
+  });
+
+  const columns: DataViewTh[] = COLUMNS.map((column, index) => ({
+    cell: column.label,
+    props: { sort: getSortParams(index) }
+  }));
+
+  const rows: DataViewTr[] = useMemo(() => sortData(repositories, sortBy, direction).map(({ name, branches, prs, workspaces, lastCommit }) => [
+    name,
+    branches,
+    prs,
+    workspaces,
+    lastCommit,
+  ]), [ sortBy, direction ]);
+
+  return (
+    <DataViewTable
+      aria-label="Repositories table"
+      ouiaId={ouiaId}
+      columns={columns}
+      rows={rows}
+    />
+  );
+};
+
+export const BasicExample: React.FunctionComponent = () => (
+  <BrowserRouter>
+    <MyTable/>
+  </BrowserRouter>
+)
+

package/src/Hooks/index.ts

@@ -1,3 +1,4 @@
 export * from './pagination';
 export * from './selection';
 export * from './filters';
+export * from './sort';

package/src/Hooks/sort.test.tsx

@@ -0,0 +1,84 @@
+import '@testing-library/jest-dom';
+import { renderHook, act } from '@testing-library/react';
+import { useDataViewSort, UseDataViewSortProps, DataViewSortConfig, DataViewSortParams } from './sort';
+
+describe('useDataViewSort', () => {
+  const initialSort: DataViewSortConfig = { sortBy: 'name', direction: 'asc' };
+
+  it('should initialize with provided initial sort config', () => {
+    const { result } = renderHook(() => useDataViewSort({ initialSort }));
+    expect(result.current).toEqual(expect.objectContaining(initialSort));
+  });
+
+  it('should initialize with empty sort config if no initialSort is provided', () => {
+    const { result } = renderHook(() => useDataViewSort());
+    expect(result.current).toEqual(expect.objectContaining({ sortBy: undefined, direction: 'asc' }));
+  });
+
+  it('should update sort state when onSort is called', () => {
+    const { result } = renderHook(() => useDataViewSort({ initialSort }));
+    act(() => {
+      result.current.onSort(undefined, 'age', 'desc');
+    });
+    expect(result.current).toEqual(expect.objectContaining({ sortBy: 'age', direction: 'desc' }));
+  });
+
+  it('should sync with URL search params if isUrlSyncEnabled', () => {
+    const searchParams = new URLSearchParams();
+    const setSearchParams = jest.fn();
+    const props: UseDataViewSortProps = {
+      initialSort,
+      searchParams,
+      setSearchParams,
+    };
+
+    const { result } = renderHook(() => useDataViewSort(props));
+
+    expect(setSearchParams).toHaveBeenCalledTimes(1);
+    expect(result.current).toEqual(expect.objectContaining(initialSort));
+  });
+
+  it('should validate direction and fallback to default direction if invalid direction is provided', () => {
+    const searchParams = new URLSearchParams();
+    searchParams.set(DataViewSortParams.SORT_BY, 'name');
+    searchParams.set(DataViewSortParams.DIRECTION, 'invalid-direction');
+    const { result } = renderHook(() => useDataViewSort({ searchParams, defaultDirection: 'desc' }));
+
+    expect(result.current).toEqual(expect.objectContaining({ sortBy: 'name', direction: 'desc' }));
+  });
+
+  it('should update search params when URL sync is enabled and sort changes', () => {
+    const searchParams = new URLSearchParams();
+    const setSearchParams = jest.fn();
+    const props: UseDataViewSortProps = {
+      initialSort,
+      searchParams,
+      setSearchParams,
+    };
+
+    const { result } = renderHook(() => useDataViewSort(props));
+    act(() => {
+      expect(setSearchParams).toHaveBeenCalledTimes(1);
+      result.current.onSort(undefined, 'priority', 'desc');
+    });
+
+    expect(setSearchParams).toHaveBeenCalledTimes(2);
+    expect(result.current).toEqual(expect.objectContaining({ sortBy: 'priority', direction: 'desc' }));
+  });
+
+  it('should prioritize searchParams values', () => {
+    const searchParams = new URLSearchParams();
+    searchParams.set(DataViewSortParams.SORT_BY, 'category');
+    searchParams.set(DataViewSortParams.DIRECTION, 'desc');
+
+    const { result } = renderHook(
+      (props: UseDataViewSortProps) => useDataViewSort(props),
+      { initialProps: { initialSort, searchParams } }
+    );
+
+    expect(result.current).toEqual(expect.objectContaining({
+      sortBy: 'category',
+      direction: 'desc',
+    }));
+  });
+});

package/src/Hooks/sort.ts

@@ -0,0 +1,87 @@
+import { ISortBy } from "@patternfly/react-table";
+import { useState, useEffect, useMemo } from "react";
+
+export enum DataViewSortParams {
+  SORT_BY = 'sortBy',
+  DIRECTION = 'direction'
+};
+
+const validateDirection = (direction: string | null | undefined, defaultDirection: ISortBy['direction']): ISortBy['direction'] => (
+  direction === 'asc' || direction === 'desc' ? direction : defaultDirection
+);
+
+export interface DataViewSortConfig {
+  /** Attribute to sort the entries by */
+  sortBy: string | undefined;
+  /** Sort direction */
+  direction: ISortBy['direction'];
+};
+
+export interface UseDataViewSortProps {
+  /** Initial sort config */
+  initialSort?: DataViewSortConfig;
+  /** Current search parameters as a string */
+  searchParams?: URLSearchParams;
+  /** Function to set search parameters */
+  setSearchParams?: (params: URLSearchParams) => void;
+  /** Default direction */
+  defaultDirection?: ISortBy['direction'];
+  /** Sort by URL param name */
+  sortByParam?: string;
+  /** Direction URL param name */
+  directionParam?: string;
+};
+
+export const useDataViewSort = (props?: UseDataViewSortProps) => {
+  const {
+    initialSort,
+    searchParams,
+    setSearchParams,
+    defaultDirection = 'asc',
+    sortByParam = DataViewSortParams.SORT_BY,
+    directionParam = DataViewSortParams.DIRECTION
+  } = props ?? {};
+
+  const isUrlSyncEnabled = useMemo(() => searchParams && !!setSearchParams, [ searchParams, setSearchParams ]);
+
+  const [ state, setState ] = useState<DataViewSortConfig>({
+    sortBy: searchParams?.get(sortByParam) ?? initialSort?.sortBy,
+    direction: validateDirection(searchParams?.get(directionParam) as ISortBy['direction'], initialSort?.direction),
+  });
+
+  const updateSearchParams = (sortBy: string, direction: ISortBy['direction']) => {
+    if (isUrlSyncEnabled && sortBy) {
+      const params = new URLSearchParams(searchParams);
+      params.set(sortByParam, `${sortBy}`);
+      params.set(directionParam, `${direction}`);
+      setSearchParams?.(params);
+    }
+  };
+
+  useEffect(() => {
+    state.sortBy && state.direction && updateSearchParams(state.sortBy, state.direction);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+
+  useEffect(() => {
+    const currentSortBy = searchParams?.get(sortByParam) || state.sortBy;
+    const currentDirection = searchParams?.get(directionParam) as ISortBy['direction'] || state.direction;
+    const validDirection = validateDirection(currentDirection, defaultDirection);
+    currentSortBy !== state.sortBy || validDirection !== state.direction && setState({ sortBy: currentSortBy, direction: validDirection });
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [ searchParams?.toString() ]);
+
+  const onSort = (
+    _event: React.MouseEvent | React.KeyboardEvent | MouseEvent | undefined,
+    newSortBy: string,
+    newSortDirection: ISortBy['direction']
+  ) => {
+    setState({ sortBy: newSortBy, direction: newSortDirection });
+    updateSearchParams(newSortBy, newSortDirection);
+  };
+
+  return {
+    ...state,
+    onSort
+  };
+};