@patternfly/react-data-view 6.1.0-prerelease.1 → 6.2.0

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

@@ -0,0 +1,154 @@
+---
+# Sidenav top-level section
+# should be the same for all markdown files
+section: extensions
+subsection: Data view
+# Sidenav secondary level section
+# should be the same for all markdown files
+id: Toolbar
+title: Data view toolbar
+# Tab (react | react-demos | html | html-demos | design-guidelines | accessibility)
+source: react
+# If you use typescript, the name of the interface to display props for
+# These are found through the sourceProps function provided in patternfly-docs.source.js
+sortValue: 2
+propComponents: ['DataViewToolbar', 'DataViewFilters', 'DataViewTextFilter', 'DataViewCheckboxFilter']
+sourceLink: https://github.com/patternfly/react-data-view/blob/main/packages/module/patternfly-docs/content/extensions/data-view/examples/Toolbar/Toolbar.md
+---
+import { useMemo, useState, useEffect } from 'react';
+import { BrowserRouter, useSearchParams } from 'react-router-dom';
+import { Pagination, ToggleGroup, ToggleGroupItem } from '@patternfly/react-core';
+import { useDataViewPagination, useDataViewSelection, useDataViewFilters } from '@patternfly/react-data-view/dist/dynamic/Hooks';
+import { DataView } from '@patternfly/react-data-view/dist/dynamic/DataView';
+import { BulkSelect, BulkSelectValue, ErrorState, ResponsiveAction, ResponsiveActions, SkeletonTableHead, SkeletonTableBody } from '@patternfly/react-component-groups';
+import { DataViewToolbar } from '@patternfly/react-data-view/dist/dynamic/DataViewToolbar';
+import { DataViewTable } from '@patternfly/react-data-view/dist/dynamic/DataViewTable';
+import { DataViewFilters } from '@patternfly/react-data-view/dist/dynamic/DataViewFilters';
+import { DataViewTextFilter } from '@patternfly/react-data-view/dist/dynamic/DataViewTextFilter';
+import { DataViewCheckboxFilter } from '@patternfly/react-data-view/dist/dynamic/DataViewCheckboxFilter';
+
+The **data view toolbar** component renders a default opinionated data view toolbar above or below the data section. 
+
+Data view toolbar can contain pagination, bulk select, filters, actions, or other custom child content. To pass child items to the toolbar, use the [toolbar item](/components/toolbar#toolbar-items) component or predefined `<DataViewToolbar>` props for specific use cases.
+
+You can further customize toolbar interactions by referring to the additional documentation: 
+- [Actions](#toolbar-actions)
+- [Pagination](#pagination)
+- [Selection](#selection)
+- [Filters](#filters)
+
+### Toolbar example
+
+```js file="./DataViewToolbarExample.tsx"
+
+```
+
+## Toolbar actions
+To support additional user needs, you can pass relevant actions to the toolbar via `actions`. Add standard PatternFly actions (like buttons) or choose predefined [responsive actions](/component-groups/responsive-actions) which ensure the responsive behavior of multiple actions in 1 toolbar.
+
+### Actions example
+
+```js file="./DataViewToolbarActionsExample.tsx"
+
+```
+
+## Pagination
+
+To help users navigate data records that span multiple pages, add pagination support to your toolbar.
+
+The data view toolbar can display a pagination using the `pagination` prop. You can also pass a custom `ouiaId` to the toolbar for testing purposes. You can also persist pagination values in the URL to make it easier to share or bookmark specific pages of your data.
+
+### Pagination state
+
+The `useDataViewPagination` hook manages the pagination state of the data view. 
+
+**Initial values:**
+- `perPage` initial value.
+- Optional `page` initial value.
+- Optional `searchParams` object.
+- Optional `setSearchParams` function.
+
+While the hook works seamlessly with the [React Router](https://reactrouter.com/) library, you do not need to use it to take advantage of URL persistence. The `searchParams` and `setSearchParams` props can be managed using native browser APIs (`URLSearchParams` and `window.history.pushState`) or any other routing library of your choice. If you don't pass these two props, the pagination state will be stored internally without the URL usage.
+
+You can also pass custom `pageParam` or `perPageParam` names, renaming the pagination parameters in the URL.
+
+The retrieved values are named to match the PatternFly pagination component props.
+
+**Return values:**
+- Current `page` number.
+- `onSetPage` to modify current page.
+- Items `perPage` value.
+- `onPerPageSelect` to modify per page value.
+
+### Pagination example
+This example uses the URL to persist the pagination state.
+
+```js file="./PaginationExample.tsx"
+
+```
+
+## Selection
+To allow users to select data records inside the data view, add selection support that displays a row's selection state.
+
+The data view toolbar can display a bulk selection component by using the predefined [component group extension bulk select](/extensions/component-groups/bulk-select) component.
+
+### Selection state
+
+The `useDataViewSelection` hook manages the selection state of the data view. 
+
+**Initial values:**
+- Optional `initialSelected` array of record's identifiers selected by default.
+- `matchOption` function to check if the record is selected.
+    - When no `matchOption` is passed, the `Array.prototype.includes()` operation is performed on the `selected` array.
+
+**Return values:**
+- `selected` array of currently selected records.
+- `isSelected` function returning the selection state for the record.
+- `onSelect` callback to modify the selection state. This accepts the `isSelecting` flag (indicates if records are being selected or deselected) and `items` (affected records).
+
+### Selection example
+
+```js file="./SelectionExample.tsx"
+
+```
+
+## Filters
+To allow users to filter data records in the data view, add filtering support that displays the applied filter chips.
+
+The data view toolbar can include a set of filters by passing a React node to the `filters` property. You can use the predefined components `<DataViewFilters>`, `<DataViewTextFilter>`, and `<DataViewCheckboxFilter>` to customize and handle filtering directly in the toolbar. The `<DataViewFilters>` component is a wrapper that allows conditional filtering using multiple attributes. If you need just a single filter, you can use `<DataViewTextFilter>`, `<DataViewCheckboxFilter>`, or a different filter component alone. Props of these filter components are listed in the [props section of this page](#props).
+
+You can either pass a `value` and `onChange` event to every filter separately, or you can pass `values` and `onChange` to the `<DataViewFilters>` wrapper, which makes them available to its children. Props directly passed to child filters have a higher priority than the "inherited" ones. 
+
+### Filters state
+
+The `useDataViewFilters` hook manages the filter state of the data view. It allows you to define default filter values, synchronize filter state with URL parameters, and handle filter changes efficiently.
+
+**Initial values:**
+- `initialFilters` object with default filter values (if the filter param allows multiple values, pass an array).
+- Optional `searchParams` object for managing URL-based filter state.
+- Optional `setSearchParams` function to update the URL when filters are modified.
+
+The `useDataViewFilters` hook works well with the [React Router](https://reactrouter.com/) library to support URL-based filtering. Alternatively, you can manage the filter state in the URL using `URLSearchParams` and `window.history.pushState` APIs, or other routing libraries. If no URL parameters are provided, the filter state is managed internally.
+
+**Return values:**
+- `filters` object representing the current filter values.
+- `onSetFilters` function to update the filter state.
+- `clearAllFilters` function to reset all filters to their initial values.
+
+### Filtering example
+This example demonstrates the setup and usage of filters within the data view. It includes text filters for different attributes, the ability to clear all filters, and persistence of filter state in the URL.
+
+```js file="./FiltersExample.tsx"
+
+```
+
+
+## All/selected data switch
+All/selected data switch allows users to toggle between displaying the entire table (All) and only the rows they have selected (Selected). If the user deselects the last selected row, the filter automatically switches back to All, displaying all table rows again. Until at least one row is selected, a tooltip with guidance is displayed, and the Selected button does not perform any action. The Selected button is intentionally not disabled for accessibility reasons but instead has `aria-disabled` set.
+
+### All/selected example
+This example demonstrates the setup and usage of All/selected row switch.
+
+```js file="./AllSelectedExample.tsx"
+
+```

package/patternfly-docs/pages/index.js

@@ -10,7 +10,7 @@ const centerStyle = {
 
 const IndexPage = () => {
   return (
-    <PageSection style={centerStyle}>
+    <PageSection hasBodyWrapper={false} style={centerStyle}>
       <div style={{ flex: 'none', textAlign: 'center' }}>
         <Title size="4xl" headingLevel="h1">
           My extension docs

package/release.config.js

@@ -10,5 +10,5 @@ module.exports = {
     '@semantic-release/npm'
   ],
   tagFormat: 'prerelease-v${version}',
-  dryRun: false
+  dryRun: true
 };

package/src/DataView/DataView.tsx

@@ -1,16 +1,33 @@
 import React from 'react';
-import { Stack, StackItem } from '@patternfly/react-core';
-export interface DataViewProps {
+import { Stack, StackItem, StackProps } from '@patternfly/react-core';
+import { DataViewSelection, InternalContextProvider } from '../InternalContext';
+
+export const DataViewState = {
+  empty: 'empty',
+  loading: 'loading',
+  error: 'error'
+} as const;
+
+export type DataViewState = typeof DataViewState[keyof typeof DataViewState];
+
+/** extends StackProps */
+export interface DataViewProps extends StackProps {
   /** Content rendered inside the data view */
   children: React.ReactNode;
   /** Custom OUIA ID */
   ouiaId?: string;
+  /** Selection context configuration */
+  selection?: DataViewSelection;
+  /** Currently active state */
+  activeState?: DataViewState | string;
 }
 
-export const DataView: React.FC<DataViewProps> = ({
+export type DataViewImpementationProps = Omit<DataViewProps, 'onSelect' | 'isItemSelected' | 'isItemSelectDisabled'>;
+
+const DataViewImplementation: React.FC<DataViewImpementationProps> = ({
   children, ouiaId = 'DataView', ...props
-}: DataViewProps) => (
-  <Stack data-ouia-component-id={`${ouiaId}-stack}`} {...props}>
+}: DataViewImpementationProps) => (
+  <Stack data-ouia-component-id={`${ouiaId}-stack`} {...props}>
     {React.Children.map(children, (child, index) => (
       <StackItem data-ouia-component-id={`${ouiaId}-stack-item-${index}`}>
         {child}
@@ -19,4 +36,10 @@ export const DataView: React.FC<DataViewProps> = ({
   </Stack>
 )
 
+export const DataView: React.FC<DataViewProps> = ({ children, selection, activeState, ...props }: DataViewProps) => (
+  <InternalContextProvider selection={selection} activeState={activeState} >
+    <DataViewImplementation {...props}>{children}</DataViewImplementation>
+  </InternalContextProvider>
+);
+
 export default DataView;

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

@@ -7,7 +7,7 @@ exports[`DataView component should render correctly 1`] = `
     <div>
       <div
         class="pf-v6-l-stack"
-        data-ouia-component-id="DataView-stack}"
+        data-ouia-component-id="DataView-stack"
       >
         <div
           class="pf-v6-l-stack__item"
@@ -45,7 +45,7 @@ exports[`DataView component should render correctly 1`] = `
   "container": <div>
     <div
       class="pf-v6-l-stack"
-      data-ouia-component-id="DataView-stack}"
+      data-ouia-component-id="DataView-stack"
     >
       <div
         class="pf-v6-l-stack__item"

package/src/DataViewCheckboxFilter/DataViewCheckboxFilter.test.tsx

@@ -0,0 +1,24 @@
+import React from 'react';
+import { render } from '@testing-library/react';
+import DataViewCheckboxFilter, { DataViewCheckboxFilterProps } from './DataViewCheckboxFilter';
+import DataViewToolbar from '../DataViewToolbar';
+
+describe('DataViewCheckboxFilter component', () => {
+  const defaultProps: DataViewCheckboxFilterProps = {
+    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(
+      <DataViewToolbar filters={<DataViewCheckboxFilter {...defaultProps} />} />
+    );
+    expect(container).toMatchSnapshot();
+  });
+});

package/src/DataViewCheckboxFilter/DataViewCheckboxFilter.tsx

@@ -0,0 +1,175 @@
+import React from 'react';
+import {
+  Badge,
+  Menu,
+  MenuContent,
+  MenuItem,
+  MenuList,
+  MenuProps,
+  MenuToggle,
+  Popper,
+  ToolbarLabel,
+  ToolbarFilter,
+} from '@patternfly/react-core';
+import { FilterIcon } from '@patternfly/react-icons';
+import { DataViewFilterOption } from '../DataViewFilters';
+
+const isToolbarLabel = (label: string | ToolbarLabel): label is ToolbarLabel =>
+  typeof label === 'object' && 'key' in label;
+
+export const isDataViewFilterOption = (obj: unknown): obj is DataViewFilterOption =>
+  !!obj &&
+  typeof obj === 'object' &&
+  'label' in obj &&
+  'value' in obj &&
+  typeof (obj as DataViewFilterOption).value === 'string';
+
+/** 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 const DataViewCheckboxFilter: React.FC<DataViewCheckboxFilterProps> = ({
+  filterId,
+  title,
+  value = [],
+  onChange,
+  placeholder,
+  options = [],
+  showToolbarItem,
+  showIcon = !placeholder,
+  showBadge = !placeholder,
+  ouiaId = 'DataViewCheckboxFilter',
+  ...props
+}: DataViewCheckboxFilterProps) => {
+  const [ isOpen, setIsOpen ] = React.useState(false);
+  const toggleRef = React.useRef<HTMLButtonElement>(null);
+  const menuRef = React.useRef<HTMLDivElement>(null);
+  const containerRef = React.useRef<HTMLDivElement>(null);
+
+  const normalizeOptions = React.useMemo(
+    () =>
+      options.map(option =>
+        typeof option === 'string'
+          ? { label: option, value: option }
+          : option
+      ),
+    [ options ]
+  );
+
+  const handleToggleClick = (event: React.MouseEvent) => {
+    event.stopPropagation();
+    setTimeout(() => {
+      const firstElement = menuRef.current?.querySelector('li > button:not(:disabled)') as HTMLElement;
+      firstElement?.focus();
+    }, 0);
+    setIsOpen(prev => !prev);
+  };
+
+  const handleSelect = (event?: React.MouseEvent, itemId?: string | number) => {
+    const activeItem = String(itemId);
+    const isSelected = value.includes(activeItem);
+
+    onChange?.(
+      event,
+      isSelected ? value.filter(item => item !== activeItem) : [ activeItem, ...value ]
+    );
+  };
+
+  const handleClickOutside = (event: MouseEvent) => 
+    isOpen &&
+    menuRef.current && toggleRef.current &&
+    !menuRef.current.contains(event.target as Node) && !toggleRef.current.contains(event.target as Node)
+    && setIsOpen(false);
+
+
+  React.useEffect(() => {
+    window.addEventListener('click', handleClickOutside);
+    return () => {
+      window.removeEventListener('click', handleClickOutside);
+    };
+  }, [ isOpen ]);  // eslint-disable-line react-hooks/exhaustive-deps
+
+  return (
+    <ToolbarFilter
+      key={ouiaId}
+      data-ouia-component-id={ouiaId}
+      labels={value.map(item => {
+        const activeOption = normalizeOptions.find(option => option.value === item);
+        return ({ key: activeOption?.value as string, node: activeOption?.label })
+      })}
+      deleteLabel={(_, label) =>
+        onChange?.(undefined, value.filter(item => item !== (isToolbarLabel(label) ? label.key : label)))
+      }
+      categoryName={title}
+      showToolbarItem={showToolbarItem}
+    >
+      <Popper
+        trigger={
+          <MenuToggle
+            ouiaId={`${ouiaId}-toggle`}
+            ref={toggleRef}
+            onClick={handleToggleClick}
+            isExpanded={isOpen}
+            icon={showIcon ? <FilterIcon /> : undefined}
+            badge={value.length > 0 && showBadge ? <Badge data-ouia-component-id={`${ouiaId}-badge`} isRead>{value.length}</Badge> : undefined}
+            style={{ width: '200px' }}
+          >
+            {placeholder ?? title}
+          </MenuToggle>
+        }
+        triggerRef={toggleRef}
+        popper={
+          <Menu
+            ref={menuRef}
+            ouiaId={`${ouiaId}-menu`}
+            onSelect={handleSelect}
+            selected={value}
+            {...props}
+          >
+            <MenuContent>
+              <MenuList>
+                {normalizeOptions.map(option => (
+                  <MenuItem
+                    data-ouia-component-id={`${ouiaId}-filter-item-${option.value}`}
+                    key={option.value}
+                    itemId={option.value}
+                    isSelected={value.includes(option.value)}
+                    hasCheckbox
+                  >
+                    {option.label}
+                  </MenuItem>
+                ))}
+              </MenuList>
+            </MenuContent>
+          </Menu>
+        }
+        popperRef={menuRef}
+        appendTo={containerRef.current || undefined}
+        aria-label={`${title ?? filterId} filter`}
+        isVisible={isOpen}
+      />
+    </ToolbarFilter>
+  );
+};
+
+export default DataViewCheckboxFilter;

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

@@ -0,0 +1,197 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`DataViewCheckboxFilter component should render correctly 1`] = `
+<div>
+  <div
+    class="pf-v6-c-toolbar"
+    data-ouia-component-id="DataViewToolbar"
+    data-ouia-component-type="PF6/Toolbar"
+    data-ouia-safe="true"
+    id="pf-random-id-0"
+  >
+    <div
+      class="pf-v6-c-toolbar__content"
+    >
+      <div
+        class="pf-v6-c-toolbar__content-section"
+      >
+        <div
+          class="pf-v6-c-toolbar__item"
+        >
+          <div
+            class="pf-v6-c-toolbar__item"
+            data-ouia-component-id="DataViewCheckboxFilter"
+          >
+            <button
+              aria-expanded="false"
+              class="pf-v6-c-menu-toggle"
+              data-ouia-component-id="DataViewCheckboxFilter-toggle"
+              data-ouia-component-type="PF6/MenuToggle"
+              data-ouia-safe="true"
+              style="width: 200px;"
+              type="button"
+            >
+              <span
+                class="pf-v6-c-menu-toggle__icon"
+              >
+                <svg
+                  aria-hidden="true"
+                  class="pf-v6-svg"
+                  fill="currentColor"
+                  height="1em"
+                  role="img"
+                  viewBox="0 0 512 512"
+                  width="1em"
+                >
+                  <path
+                    d="M487.976 0H24.028C2.71 0-8.047 25.866 7.058 40.971L192 225.941V432c0 7.831 3.821 15.17 10.237 19.662l80 55.98C298.02 518.69 320 507.493 320 487.98V225.941l184.947-184.97C520.021 25.896 509.338 0 487.976 0z"
+                  />
+                </svg>
+              </span>
+              <span
+                class="pf-v6-c-menu-toggle__text"
+              >
+                Test Checkbox Filter
+              </span>
+              <span
+                class="pf-v6-c-menu-toggle__count"
+              >
+                <span
+                  class="pf-v6-c-badge pf-m-read"
+                  data-ouia-component-id="DataViewCheckboxFilter-badge"
+                >
+                  1
+                </span>
+              </span>
+              <span
+                class="pf-v6-c-menu-toggle__controls"
+              >
+                <span
+                  class="pf-v6-c-menu-toggle__toggle-icon"
+                >
+                  <svg
+                    aria-hidden="true"
+                    class="pf-v6-svg"
+                    fill="currentColor"
+                    height="1em"
+                    role="img"
+                    viewBox="0 0 320 512"
+                    width="1em"
+                  >
+                    <path
+                      d="M31.3 192h257.3c17.8 0 26.7 21.5 14.1 34.1L174.1 354.8c-7.8 7.8-20.5 7.8-28.3 0L17.2 226.1C4.6 213.5 13.5 192 31.3 192z"
+                    />
+                  </svg>
+                </span>
+              </span>
+            </button>
+          </div>
+        </div>
+      </div>
+    </div>
+    <div
+      class="pf-v6-c-toolbar__content"
+    >
+      <div
+        class="pf-v6-c-toolbar__group"
+      >
+        <div
+          class="pf-v6-c-toolbar__item pf-m-label-group pf-m-label-group"
+        >
+          <div
+            class="pf-v6-c-label-group pf-m-category"
+          >
+            <div
+              class="pf-v6-c-label-group__main"
+            >
+              <span
+                aria-hidden="true"
+                class="pf-v6-c-label-group__label"
+                id="pf-random-id-1"
+              >
+                Test Checkbox Filter
+              </span>
+              <ul
+                aria-labelledby="pf-random-id-1"
+                class="pf-v6-c-label-group__list"
+                role="list"
+              >
+                <li
+                  class="pf-v6-c-label-group__list-item"
+                >
+                  <span
+                    class="pf-v6-c-label pf-m-filled"
+                  >
+                    <span
+                      class="pf-v6-c-label__content"
+                    >
+                      <span
+                        class="pf-v6-c-label__text"
+                      >
+                        Workspace one
+                      </span>
+                    </span>
+                    <span
+                      class="pf-v6-c-label__actions"
+                    >
+                      <button
+                        aria-disabled="false"
+                        aria-label="Close Workspace one"
+                        class="pf-v6-c-button pf-m-plain pf-m-no-padding"
+                        data-ouia-component-id="OUIA-Generated-Button-plain-1"
+                        data-ouia-component-type="PF6/Button"
+                        data-ouia-safe="true"
+                        type="button"
+                      >
+                        <span
+                          class="pf-v6-c-button__icon"
+                        >
+                          <svg
+                            aria-hidden="true"
+                            class="pf-v6-svg"
+                            fill="currentColor"
+                            height="1em"
+                            role="img"
+                            viewBox="0 0 352 512"
+                            width="1em"
+                          >
+                            <path
+                              d="M242.72 256l100.07-100.07c12.28-12.28 12.28-32.19 0-44.48l-22.24-22.24c-12.28-12.28-32.19-12.28-44.48 0L176 189.28 75.93 89.21c-12.28-12.28-32.19-12.28-44.48 0L9.21 111.45c-12.28 12.28-12.28 32.19 0 44.48L109.28 256 9.21 356.07c-12.28 12.28-12.28 32.19 0 44.48l22.24 22.24c12.28 12.28 32.2 12.28 44.48 0L176 322.72l100.07 100.07c12.28 12.28 32.2 12.28 44.48 0l22.24-22.24c12.28-12.28 12.28-32.19 0-44.48L242.72 256z"
+                            />
+                          </svg>
+                        </span>
+                      </button>
+                    </span>
+                  </span>
+                </li>
+              </ul>
+            </div>
+          </div>
+        </div>
+      </div>
+      <div
+        class="pf-v6-c-toolbar__group pf-m-action-group-inline"
+      >
+        <div
+          class="pf-v6-c-toolbar__item"
+        >
+          <button
+            aria-disabled="false"
+            class="pf-v6-c-button pf-m-link pf-m-inline"
+            data-ouia-component-id="DataViewToolbar-clear-all-filters"
+            data-ouia-component-type="PF6/Button"
+            data-ouia-safe="true"
+            type="button"
+          >
+            <span
+              class="pf-v6-c-button__text"
+            >
+              Clear filters
+            </span>
+          </button>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+`;

package/src/DataViewCheckboxFilter/index.ts

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