@patternfly/react-data-view 5.5.1 → 5.7.0

package/dist/cjs/DataViewCheckboxFilter/DataViewCheckboxFilter.d.ts

@@ -0,0 +1,29 @@
+import React from 'react';
+import { MenuProps } from '@patternfly/react-core';
+import { DataViewFilterOption } from '../DataViewFilters';
+export declare const isDataViewFilterOption: (obj: unknown) => obj is DataViewFilterOption;
+/** extends MenuProps */
+export interface DataViewCheckboxFilterProps extends Omit<MenuProps, 'onSelect' | 'onChange'> {
+    /** Unique key for the filter attribute */
+    filterId: string;
+    /** Array of current filter values */
+    value?: string[];
+    /** Filter title displayed in the toolbar */
+    title: string;
+    /** Placeholder text of the menu */
+    placeholder?: string;
+    /** Filter options displayed */
+    options: (DataViewFilterOption | string)[];
+    /** Callback for updating when item selection changes. */
+    onChange?: (event?: React.MouseEvent, values?: string[]) => void;
+    /** Controls visibility of the filter in the toolbar */
+    showToolbarItem?: boolean;
+    /** Controls visibility of the filter icon */
+    showIcon?: boolean;
+    /** Controls visibility of the selected items badge */
+    showBadge?: boolean;
+    /** Custom OUIA ID */
+    ouiaId?: string;
+}
+export declare const DataViewCheckboxFilter: React.FC<DataViewCheckboxFilterProps>;
+export default DataViewCheckboxFilter;

package/dist/cjs/DataViewCheckboxFilter/DataViewCheckboxFilter.js

@@ -0,0 +1,70 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataViewCheckboxFilter = exports.isDataViewFilterOption = void 0;
+const react_1 = __importDefault(require("react"));
+const react_core_1 = require("@patternfly/react-core");
+const react_icons_1 = require("@patternfly/react-icons");
+const isToolbarChip = (chip) => typeof chip === 'object' && 'key' in chip;
+const isDataViewFilterOption = (obj) => !!obj &&
+    typeof obj === 'object' &&
+    'label' in obj &&
+    'value' in obj &&
+    typeof obj.value === 'string';
+exports.isDataViewFilterOption = isDataViewFilterOption;
+const DataViewCheckboxFilter = (_a) => {
+    var { filterId, title, value = [], onChange, placeholder, options = [], showToolbarItem, showIcon = !placeholder, showBadge = !placeholder, ouiaId = 'DataViewCheckboxFilter' } = _a, props = __rest(_a, ["filterId", "title", "value", "onChange", "placeholder", "options", "showToolbarItem", "showIcon", "showBadge", "ouiaId"]);
+    const [isOpen, setIsOpen] = react_1.default.useState(false);
+    const toggleRef = react_1.default.useRef(null);
+    const menuRef = react_1.default.useRef(null);
+    const containerRef = react_1.default.useRef(null);
+    const normalizeOptions = react_1.default.useMemo(() => options.map(option => typeof option === 'string'
+        ? { label: option, value: option }
+        : option), [options]);
+    const handleToggleClick = (event) => {
+        event.stopPropagation();
+        setTimeout(() => {
+            var _a;
+            const firstElement = (_a = menuRef.current) === null || _a === void 0 ? void 0 : _a.querySelector('li > button:not(:disabled)');
+            firstElement === null || firstElement === void 0 ? void 0 : firstElement.focus();
+        }, 0);
+        setIsOpen(prev => !prev);
+    };
+    const handleSelect = (event, itemId) => {
+        const activeItem = String(itemId);
+        const isSelected = value.includes(activeItem);
+        onChange === null || onChange === void 0 ? void 0 : onChange(event, isSelected ? value.filter(item => item !== activeItem) : [activeItem, ...value]);
+    };
+    const handleClickOutside = (event) => isOpen &&
+        menuRef.current && toggleRef.current &&
+        !menuRef.current.contains(event.target) && !toggleRef.current.contains(event.target)
+        && setIsOpen(false);
+    react_1.default.useEffect(() => {
+        window.addEventListener('click', handleClickOutside);
+        return () => {
+            window.removeEventListener('click', handleClickOutside);
+        };
+    }, [isOpen]); // eslint-disable-line react-hooks/exhaustive-deps
+    return (react_1.default.createElement(react_core_1.ToolbarFilter, { key: ouiaId, "data-ouia-component-id": ouiaId, chips: value.map(item => {
+            const activeOption = normalizeOptions.find(option => option.value === item);
+            return ({ key: activeOption === null || activeOption === void 0 ? void 0 : activeOption.value, node: activeOption === null || activeOption === void 0 ? void 0 : activeOption.label });
+        }), deleteChip: (_, chip) => onChange === null || onChange === void 0 ? void 0 : onChange(undefined, value.filter(item => item !== (isToolbarChip(chip) ? chip.key : chip))), categoryName: title, showToolbarItem: showToolbarItem },
+        react_1.default.createElement(react_core_1.Popper, { trigger: react_1.default.createElement(react_core_1.MenuToggle, { ouiaId: `${ouiaId}-toggle`, ref: toggleRef, onClick: handleToggleClick, isExpanded: isOpen, icon: showIcon ? react_1.default.createElement(react_icons_1.FilterIcon, null) : undefined, badge: value.length > 0 && showBadge ? react_1.default.createElement(react_core_1.Badge, { "data-ouia-component-id": `${ouiaId}-badge`, isRead: true }, value.length) : undefined, style: { width: '200px' } }, placeholder !== null && placeholder !== void 0 ? placeholder : title), triggerRef: toggleRef, popper: react_1.default.createElement(react_core_1.Menu, Object.assign({ ref: menuRef, ouiaId: `${ouiaId}-menu`, onSelect: handleSelect, selected: value }, props),
+                react_1.default.createElement(react_core_1.MenuContent, null,
+                    react_1.default.createElement(react_core_1.MenuList, null, normalizeOptions.map(option => (react_1.default.createElement(react_core_1.MenuItem, { "data-ouia-component-id": `${ouiaId}-filter-item-${option.value}`, key: option.value, itemId: option.value, isSelected: value.includes(option.value), hasCheckbox: true }, option.label)))))), popperRef: menuRef, appendTo: containerRef.current || undefined, "aria-label": `${title !== null && title !== void 0 ? title : filterId} filter`, isVisible: isOpen })));
+};
+exports.DataViewCheckboxFilter = DataViewCheckboxFilter;
+exports.default = exports.DataViewCheckboxFilter;

package/dist/cjs/DataViewCheckboxFilter/DataViewCheckboxFilter.test.d.ts

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

package/dist/cjs/DataViewCheckboxFilter/DataViewCheckboxFilter.test.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const react_2 = require("@testing-library/react");
+const DataViewCheckboxFilter_1 = __importDefault(require("./DataViewCheckboxFilter"));
+const DataViewToolbar_1 = __importDefault(require("../DataViewToolbar"));
+describe('DataViewCheckboxFilter component', () => {
+    const defaultProps = {
+        filterId: 'test-checkbox-filter',
+        title: 'Test Checkbox Filter',
+        value: ['workspace-one'],
+        options: [
+            { label: 'Workspace one', value: 'workspace-one' },
+            { label: 'Workspace two', value: 'workspace-two' },
+            { label: 'Workspace three', value: 'workspace-three' },
+        ],
+    };
+    it('should render correctly', () => {
+        const { container } = (0, react_2.render)(react_1.default.createElement(DataViewToolbar_1.default, { filters: react_1.default.createElement(DataViewCheckboxFilter_1.default, Object.assign({}, defaultProps)) }));
+        expect(container).toMatchSnapshot();
+    });
+});

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

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

package/dist/cjs/DataViewCheckboxFilter/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = void 0;
+var DataViewCheckboxFilter_1 = require("./DataViewCheckboxFilter");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(DataViewCheckboxFilter_1).default; } });
+__exportStar(require("./DataViewCheckboxFilter"), exports);

package/dist/cjs/DataViewFilters/DataViewFilters.d.ts

@@ -1,5 +1,11 @@
-import React from 'react';
+import React, { ReactNode } from 'react';
 import { ToolbarToggleGroupProps } from '@patternfly/react-core';
+export interface DataViewFilterOption {
+    /** Filter option label */
+    label: ReactNode;
+    /** Filter option value */
+    value: string;
+}
 /** extends ToolbarToggleGroupProps */
 export interface DataViewFiltersProps<T extends object> extends Omit<ToolbarToggleGroupProps, 'toggleIcon' | 'breakpoint' | 'onChange'> {
     /** Content rendered inside the data view */

package/dist/cjs/DataViewFilters/DataViewFilters.js

@@ -52,6 +52,19 @@ const DataViewFilters = (_a) => {
     (0, react_1.useEffect)(() => {
         filterItems.length > 0 && setActiveAttributeMenu(filterItems[0].title);
     }, [filterItems]);
+    const handleClickOutside = (event) => {
+        var _a, _b;
+        return isAttributeMenuOpen &&
+            !((_a = attributeMenuRef.current) === null || _a === void 0 ? void 0 : _a.contains(event.target)) &&
+            !((_b = attributeToggleRef.current) === null || _b === void 0 ? void 0 : _b.contains(event.target))
+            && setIsAttributeMenuOpen(false);
+    };
+    (0, react_1.useEffect)(() => {
+        window.addEventListener('click', handleClickOutside);
+        return () => {
+            window.removeEventListener('click', handleClickOutside);
+        };
+    }, [isAttributeMenuOpen]); // eslint-disable-line react-hooks/exhaustive-deps
     const attributeToggle = (react_1.default.createElement(react_core_1.MenuToggle, { ref: attributeToggleRef, onClick: () => setIsAttributeMenuOpen(!isAttributeMenuOpen), isExpanded: isAttributeMenuOpen, icon: toggleIcon }, activeAttributeMenu));
     const attributeMenu = (react_1.default.createElement(react_core_1.Menu, { ref: attributeMenuRef, onSelect: (_ev, itemId) => {
             const selectedItem = filterItems.find(item => item.filterId === itemId);
@@ -64,7 +77,9 @@ const DataViewFilters = (_a) => {
         react_1.default.createElement(react_core_1.ToolbarGroup, { variant: "filter-group" },
             react_1.default.createElement("div", { ref: attributeContainerRef },
                 react_1.default.createElement(react_core_1.Popper, { trigger: attributeToggle, triggerRef: attributeToggleRef, popper: attributeMenu, popperRef: attributeMenuRef, appendTo: attributeContainerRef.current || undefined, isVisible: isAttributeMenuOpen })),
-            react_1.default.Children.map(children, (child) => (react_1.default.isValidElement(child) ? (react_1.default.cloneElement(child, Object.assign({ showToolbarItem: activeAttributeMenu === child.props.title, onChange: (event, value) => onChange === null || onChange === void 0 ? void 0 : onChange(event, { [child.props.filterId]: value }), value: values === null || values === void 0 ? void 0 : values[child.props.filterId] }, child.props))) : child)))));
+            react_1.default.Children.map(children, (child) => react_1.default.isValidElement(child)
+                ? react_1.default.cloneElement(child, Object.assign({ showToolbarItem: activeAttributeMenu === child.props.title, onChange: (event, value) => onChange === null || onChange === void 0 ? void 0 : onChange(event, { [child.props.filterId]: value }), value: values === null || values === void 0 ? void 0 : values[child.props.filterId] }, child.props))
+                : child))));
 };
 exports.DataViewFilters = DataViewFilters;
 exports.default = exports.DataViewFilters;

package/dist/cjs/DataViewTextFilter/DataViewTextFilter.js

@@ -19,7 +19,7 @@ const react_1 = __importDefault(require("react"));
 const react_core_1 = require("@patternfly/react-core");
 const DataViewTextFilter = (_a) => {
     var { filterId, title, value = '', onChange, onClear = () => onChange === null || onChange === void 0 ? void 0 : onChange(undefined, ''), showToolbarItem, trimValue = true, ouiaId = 'DataViewTextFilter' } = _a, props = __rest(_a, ["filterId", "title", "value", "onChange", "onClear", "showToolbarItem", "trimValue", "ouiaId"]);
-    return (react_1.default.createElement(react_core_1.ToolbarFilter, { "data-ouia-component-id": ouiaId, chips: value.length > 0 ? [{ key: title, node: value }] : [], deleteChip: () => onChange === null || onChange === void 0 ? void 0 : onChange(undefined, ''), categoryName: title, showToolbarItem: showToolbarItem },
+    return (react_1.default.createElement(react_core_1.ToolbarFilter, { key: ouiaId, "data-ouia-component-id": ouiaId, chips: value.length > 0 ? [{ key: title, node: value }] : [], deleteChip: () => onChange === null || onChange === void 0 ? void 0 : onChange(undefined, ''), categoryName: title, showToolbarItem: showToolbarItem },
         react_1.default.createElement(react_core_1.SearchInput, Object.assign({ searchInputId: filterId, value: value, onChange: (e, inputValue) => onChange === null || onChange === void 0 ? void 0 : onChange(e, trimValue ? inputValue.trim() : inputValue), onClear: onClear, placeholder: `Filter by ${title}`, "aria-label": `${title !== null && title !== void 0 ? title : filterId} filter`, "data-ouia-component-id": `${ouiaId}-input` }, props))));
 };
 exports.DataViewTextFilter = DataViewTextFilter;

package/dist/cjs/Hooks/filters.js

@@ -5,25 +5,24 @@ const react_1 = require("react");
 ;
 const useDataViewFilters = ({ initialFilters = {}, searchParams, setSearchParams, }) => {
     const isUrlSyncEnabled = (0, react_1.useMemo)(() => searchParams && !!setSearchParams, [searchParams, setSearchParams]);
-    const getInitialFilters = (0, react_1.useCallback)(() => isUrlSyncEnabled ? Object.keys(initialFilters).reduce((loadedFilters, key) => {
-        const urlValue = searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(key);
-        loadedFilters[key] = urlValue
-            ? urlValue
-            : initialFilters[key];
-        return loadedFilters;
-        // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, Object.assign({}, initialFilters)) : initialFilters, [isUrlSyncEnabled, JSON.stringify(initialFilters), searchParams === null || searchParams === void 0 ? void 0 : searchParams.toString()]);
+    const getInitialFilters = (0, react_1.useCallback)(() => isUrlSyncEnabled
+        ? Object.keys(initialFilters).reduce((loadedFilters, key) => {
+            const urlValue = searchParams === null || searchParams === void 0 ? void 0 : searchParams.get(key);
+            const isArrayFilter = Array.isArray(initialFilters[key]);
+            // eslint-disable-next-line no-nested-ternary
+            loadedFilters[key] = urlValue
+                ? (isArrayFilter && !Array.isArray(urlValue) ? [urlValue] : urlValue)
+                : initialFilters[key];
+            return loadedFilters;
+        }, Object.assign({}, initialFilters))
+        : initialFilters, [isUrlSyncEnabled, initialFilters, searchParams]);
     const [filters, setFilters] = (0, react_1.useState)(getInitialFilters());
     const updateSearchParams = (0, react_1.useCallback)((newFilters) => {
         if (isUrlSyncEnabled) {
             const params = new URLSearchParams(searchParams);
             Object.entries(newFilters).forEach(([key, value]) => {
-                if (value) {
-                    params.set(key, Array.isArray(value) ? value.join(',') : value);
-                }
-                else {
-                    params.delete(key);
-                }
+                params.delete(key);
+                (Array.isArray(value) ? value : [value]).forEach((val) => value && params.append(key, val));
             });
             setSearchParams === null || setSearchParams === void 0 ? void 0 : setSearchParams(params);
         }

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/cjs/index.d.ts

@@ -15,5 +15,7 @@ export { default as DataViewTable } from './DataViewTable';
 export * from './DataViewTable';
 export { default as DataViewEventsContext } from './DataViewEventsContext';
 export * from './DataViewEventsContext';
+export { default as DataViewCheckboxFilter } from './DataViewCheckboxFilter';
+export * from './DataViewCheckboxFilter';
 export { default as DataView } from './DataView';
 export * from './DataView';

package/dist/cjs/index.js

@@ -18,7 +18,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataView = exports.DataViewEventsContext = exports.DataViewTable = exports.DataViewTableBasic = exports.DataViewTableHead = exports.DataViewTableTree = exports.DataViewTextFilter = exports.DataViewToolbar = exports.InternalContext = void 0;
+exports.DataView = exports.DataViewCheckboxFilter = exports.DataViewEventsContext = exports.DataViewTable = exports.DataViewTableBasic = exports.DataViewTableHead = exports.DataViewTableTree = exports.DataViewTextFilter = exports.DataViewToolbar = exports.InternalContext = void 0;
 var InternalContext_1 = require("./InternalContext");
 Object.defineProperty(exports, "InternalContext", { enumerable: true, get: function () { return __importDefault(InternalContext_1).default; } });
 __exportStar(require("./InternalContext"), exports);
@@ -44,6 +44,9 @@ __exportStar(require("./DataViewTable"), exports);
 var DataViewEventsContext_1 = require("./DataViewEventsContext");
 Object.defineProperty(exports, "DataViewEventsContext", { enumerable: true, get: function () { return __importDefault(DataViewEventsContext_1).default; } });
 __exportStar(require("./DataViewEventsContext"), exports);
+var DataViewCheckboxFilter_1 = require("./DataViewCheckboxFilter");
+Object.defineProperty(exports, "DataViewCheckboxFilter", { enumerable: true, get: function () { return __importDefault(DataViewCheckboxFilter_1).default; } });
+__exportStar(require("./DataViewCheckboxFilter"), exports);
 var DataView_1 = require("./DataView");
 Object.defineProperty(exports, "DataView", { enumerable: true, get: function () { return __importDefault(DataView_1).default; } });
 __exportStar(require("./DataView"), exports);

package/dist/dynamic/DataViewCheckboxFilter/package.json

@@ -0,0 +1 @@
+{"main":"../../cjs/DataViewCheckboxFilter/index.js","module":"../../esm/DataViewCheckboxFilter/index.js","typings":"../../esm/DataViewCheckboxFilter/index.d.ts"}

package/dist/esm/DataViewCheckboxFilter/DataViewCheckboxFilter.d.ts

@@ -0,0 +1,29 @@
+import React from 'react';
+import { MenuProps } from '@patternfly/react-core';
+import { DataViewFilterOption } from '../DataViewFilters';
+export declare const isDataViewFilterOption: (obj: unknown) => obj is DataViewFilterOption;
+/** extends MenuProps */
+export interface DataViewCheckboxFilterProps extends Omit<MenuProps, 'onSelect' | 'onChange'> {
+    /** Unique key for the filter attribute */
+    filterId: string;
+    /** Array of current filter values */
+    value?: string[];
+    /** Filter title displayed in the toolbar */
+    title: string;
+    /** Placeholder text of the menu */
+    placeholder?: string;
+    /** Filter options displayed */
+    options: (DataViewFilterOption | string)[];
+    /** Callback for updating when item selection changes. */
+    onChange?: (event?: React.MouseEvent, values?: string[]) => void;
+    /** Controls visibility of the filter in the toolbar */
+    showToolbarItem?: boolean;
+    /** Controls visibility of the filter icon */
+    showIcon?: boolean;
+    /** Controls visibility of the selected items badge */
+    showBadge?: boolean;
+    /** Custom OUIA ID */
+    ouiaId?: string;
+}
+export declare const DataViewCheckboxFilter: React.FC<DataViewCheckboxFilterProps>;
+export default DataViewCheckboxFilter;

package/dist/esm/DataViewCheckboxFilter/DataViewCheckboxFilter.js

@@ -0,0 +1,62 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import React from 'react';
+import { Badge, Menu, MenuContent, MenuItem, MenuList, MenuToggle, Popper, ToolbarFilter, } from '@patternfly/react-core';
+import { FilterIcon } from '@patternfly/react-icons';
+const isToolbarChip = (chip) => typeof chip === 'object' && 'key' in chip;
+export const isDataViewFilterOption = (obj) => !!obj &&
+    typeof obj === 'object' &&
+    'label' in obj &&
+    'value' in obj &&
+    typeof obj.value === 'string';
+export const DataViewCheckboxFilter = (_a) => {
+    var { filterId, title, value = [], onChange, placeholder, options = [], showToolbarItem, showIcon = !placeholder, showBadge = !placeholder, ouiaId = 'DataViewCheckboxFilter' } = _a, props = __rest(_a, ["filterId", "title", "value", "onChange", "placeholder", "options", "showToolbarItem", "showIcon", "showBadge", "ouiaId"]);
+    const [isOpen, setIsOpen] = React.useState(false);
+    const toggleRef = React.useRef(null);
+    const menuRef = React.useRef(null);
+    const containerRef = React.useRef(null);
+    const normalizeOptions = React.useMemo(() => options.map(option => typeof option === 'string'
+        ? { label: option, value: option }
+        : option), [options]);
+    const handleToggleClick = (event) => {
+        event.stopPropagation();
+        setTimeout(() => {
+            var _a;
+            const firstElement = (_a = menuRef.current) === null || _a === void 0 ? void 0 : _a.querySelector('li > button:not(:disabled)');
+            firstElement === null || firstElement === void 0 ? void 0 : firstElement.focus();
+        }, 0);
+        setIsOpen(prev => !prev);
+    };
+    const handleSelect = (event, itemId) => {
+        const activeItem = String(itemId);
+        const isSelected = value.includes(activeItem);
+        onChange === null || onChange === void 0 ? void 0 : onChange(event, isSelected ? value.filter(item => item !== activeItem) : [activeItem, ...value]);
+    };
+    const handleClickOutside = (event) => isOpen &&
+        menuRef.current && toggleRef.current &&
+        !menuRef.current.contains(event.target) && !toggleRef.current.contains(event.target)
+        && setIsOpen(false);
+    React.useEffect(() => {
+        window.addEventListener('click', handleClickOutside);
+        return () => {
+            window.removeEventListener('click', handleClickOutside);
+        };
+    }, [isOpen]); // eslint-disable-line react-hooks/exhaustive-deps
+    return (React.createElement(ToolbarFilter, { key: ouiaId, "data-ouia-component-id": ouiaId, chips: value.map(item => {
+            const activeOption = normalizeOptions.find(option => option.value === item);
+            return ({ key: activeOption === null || activeOption === void 0 ? void 0 : activeOption.value, node: activeOption === null || activeOption === void 0 ? void 0 : activeOption.label });
+        }), deleteChip: (_, chip) => onChange === null || onChange === void 0 ? void 0 : onChange(undefined, value.filter(item => item !== (isToolbarChip(chip) ? chip.key : chip))), categoryName: title, showToolbarItem: showToolbarItem },
+        React.createElement(Popper, { trigger: React.createElement(MenuToggle, { ouiaId: `${ouiaId}-toggle`, ref: toggleRef, onClick: handleToggleClick, isExpanded: isOpen, icon: showIcon ? React.createElement(FilterIcon, null) : undefined, badge: value.length > 0 && showBadge ? React.createElement(Badge, { "data-ouia-component-id": `${ouiaId}-badge`, isRead: true }, value.length) : undefined, style: { width: '200px' } }, placeholder !== null && placeholder !== void 0 ? placeholder : title), triggerRef: toggleRef, popper: React.createElement(Menu, Object.assign({ ref: menuRef, ouiaId: `${ouiaId}-menu`, onSelect: handleSelect, selected: value }, props),
+                React.createElement(MenuContent, null,
+                    React.createElement(MenuList, null, normalizeOptions.map(option => (React.createElement(MenuItem, { "data-ouia-component-id": `${ouiaId}-filter-item-${option.value}`, key: option.value, itemId: option.value, isSelected: value.includes(option.value), hasCheckbox: true }, option.label)))))), popperRef: menuRef, appendTo: containerRef.current || undefined, "aria-label": `${title !== null && title !== void 0 ? title : filterId} filter`, isVisible: isOpen })));
+};
+export default DataViewCheckboxFilter;

package/dist/esm/DataViewCheckboxFilter/DataViewCheckboxFilter.test.d.ts

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

package/dist/esm/DataViewCheckboxFilter/DataViewCheckboxFilter.test.js

@@ -0,0 +1,20 @@
+import React from 'react';
+import { render } from '@testing-library/react';
+import DataViewCheckboxFilter from './DataViewCheckboxFilter';
+import DataViewToolbar from '../DataViewToolbar';
+describe('DataViewCheckboxFilter component', () => {
+    const defaultProps = {
+        filterId: 'test-checkbox-filter',
+        title: 'Test Checkbox Filter',
+        value: ['workspace-one'],
+        options: [
+            { label: 'Workspace one', value: 'workspace-one' },
+            { label: 'Workspace two', value: 'workspace-two' },
+            { label: 'Workspace three', value: 'workspace-three' },
+        ],
+    };
+    it('should render correctly', () => {
+        const { container } = render(React.createElement(DataViewToolbar, { filters: React.createElement(DataViewCheckboxFilter, Object.assign({}, defaultProps)) }));
+        expect(container).toMatchSnapshot();
+    });
+});

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

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

package/dist/esm/DataViewCheckboxFilter/index.js

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

package/dist/esm/DataViewFilters/DataViewFilters.d.ts

@@ -1,5 +1,11 @@
-import React from 'react';
+import React, { ReactNode } from 'react';
 import { ToolbarToggleGroupProps } from '@patternfly/react-core';
+export interface DataViewFilterOption {
+    /** Filter option label */
+    label: ReactNode;
+    /** Filter option value */
+    value: string;
+}
 /** extends ToolbarToggleGroupProps */
 export interface DataViewFiltersProps<T extends object> extends Omit<ToolbarToggleGroupProps, 'toggleIcon' | 'breakpoint' | 'onChange'> {
     /** Content rendered inside the data view */