@patternfly/react-data-view 6.4.0-prerelease.2 → 6.4.0-prerelease.3

package/src/DataViewTh/DataViewTh.tsx

@@ -0,0 +1,342 @@
+import {
+  FC,
+  useState,
+  MouseEvent as ReactMouseEvent,
+  TouchEvent as ReactTouchEvent,
+  KeyboardEvent as ReactKeyboardEvent,
+  ReactNode,
+  useCallback,
+  useRef,
+  useEffect,
+  Fragment
+} from 'react';
+import { Th, ThProps } from '@patternfly/react-table';
+import { Button, getLanguageDirection } from '@patternfly/react-core';
+import { createUseStyles } from 'react-jss';
+
+import tableCellPaddingBlockEnd from '@patternfly/react-tokens/dist/esm/c_table_cell_PaddingBlockEnd';
+import tableCellPaddingInlineEnd from '@patternfly/react-tokens/dist/esm/c_table_cell_PaddingInlineEnd';
+import globalFontSizeBodyDefault from '@patternfly/react-tokens/dist/esm/t_global_font_size_body_default';
+
+const ResizeIcon = () => (
+  <svg
+    className="pf-v6-svg"
+    viewBox="0 0 1024 1024"
+    fill="currentColor"
+    aria-hidden="true"
+    role="img"
+    width="1em"
+    height="1em"
+  >
+    <path
+      fillRule="evenodd"
+      d="M52.7,529.8l190.5,161.9c18.6,15.9,50.5,4.7,50.5-17.8v-324c0-22.4-31.8-33.6-50.5-17.8L52.7,494.2c-11.5,9.8-11.5,25.8,0,35.6ZM480.8,12.9h62.4v998.3h-62.4V12.9ZM971.3,529.8l-190.5,161.9c-18.6,15.9-50.5,4.7-50.5-17.8v-324c0-22.4,31.8-33.6,50.5-17.8l190.5,161.9c11.5,9.8,11.5,25.8,0,35.6Z"
+    />
+  </svg>
+);
+
+const useStyles = createUseStyles({
+  dataViewResizeableTh: {
+    [tableCellPaddingInlineEnd.name]: `calc(${globalFontSizeBodyDefault.var} * 2)`
+  },
+  dataViewResizableButton: {
+    position: 'absolute',
+    insetInlineEnd: `calc(${globalFontSizeBodyDefault.var} / 2)`,
+    insetBlockEnd: tableCellPaddingBlockEnd.var,
+    cursor: 'grab',
+    '&:active': {
+      cursor: 'grabbing'
+    }
+  }
+});
+export interface DataViewThResizableProps {
+  /** Whether the column is resizable */
+  isResizable?: boolean;
+  /** Callback after the column is resized. Returns the triggering event, the column id passed in via cell props, and the new width of the column. */
+  onResize?: (
+    event: ReactMouseEvent | MouseEvent | ReactKeyboardEvent | KeyboardEvent | TouchEvent,
+    id: string | number | undefined,
+    width: number
+  ) => void;
+  /** Width of the column */
+  width?: number;
+  /** Minimum width of the column */
+  minWidth?: number;
+  /** Increment for keyboard navigation */
+  increment?: number;
+  /** Increment for keyboard navigation while shift is held */
+  shiftIncrement?: number;
+  /** Provides an accessible name for the resizable column via a human readable string. */
+  resizeButtonAriaLabel?: string;
+  /** Screenreader text that gets announced when the column is resized. */
+  screenReaderText?: string;
+}
+export interface DataViewThProps {
+  /** Cell content */
+  content: ReactNode;
+  /** Resizable props */
+  resizableProps?: DataViewThResizableProps;
+  /** @hide Indicates whether the table has resizable columns */
+  hasResizableColumns?: boolean;
+  /** Props passed to Th */
+  thProps?: ThProps;
+}
+
+export const DataViewTh: FC<DataViewThProps> = ({
+  content,
+  resizableProps = {},
+  hasResizableColumns = false,
+  thProps,
+  ...props
+}: DataViewThProps) => {
+  const thRef = useRef<HTMLTableCellElement>(null);
+
+  const [width, setWidth] = useState(resizableProps?.width ? resizableProps.width : 0);
+  // Tracks the current column width for the onResize callback, because the width state is not updated until after the resize is complete
+  const trackedWidth = useRef(0);
+  const classes = useStyles();
+
+  const isResizable = resizableProps?.isResizable || false;
+  const increment = resizableProps?.increment || 5;
+  const shiftIncrement = resizableProps?.shiftIncrement || 25;
+  const resizeButtonAriaLabel = resizableProps?.resizeButtonAriaLabel;
+  const onResize = resizableProps?.onResize || undefined;
+  const screenReaderText = resizableProps?.screenReaderText || `Column ${width.toFixed(0)} pixels`;
+  const dataViewThClassName = isResizable ? classes.dataViewResizeableTh : undefined;
+
+  const resizeButtonRef = useRef<HTMLButtonElement>(null);
+  const setInitialVals = useRef(true);
+  const dragOffset = useRef(0);
+  const isResizing = useRef(false);
+  const isInView = useRef(true);
+
+  if (isResizable && !resizeButtonAriaLabel) {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'DataViewTh: Missing resizeButtonAriaLabel. An aria label must be passed to each resizable column to provide a context specific label for its resize button.'
+    );
+  }
+
+  useEffect(() => {
+    if (!isResizable) {
+      return;
+    }
+
+    const observed = resizeButtonRef.current;
+    const observer = new IntersectionObserver(
+      ([entry]) => {
+        isInView.current = entry.isIntersecting;
+      },
+      { threshold: 0.3 }
+    );
+
+    if (observed) {
+      observer.observe(observed);
+    }
+
+    return () => {
+      if (observed) {
+        observer.unobserve(observed);
+      }
+    };
+  }, []);
+
+  useEffect(() => {
+    if ((isResizable || hasResizableColumns) && setInitialVals.current && width === 0) {
+      setWidth(thRef.current?.getBoundingClientRect().width || 0);
+      setInitialVals.current = false;
+    }
+  }, [isResizable, hasResizableColumns, setInitialVals]);
+
+  const setDragOffset = (e: ReactMouseEvent | ReactTouchEvent) => {
+    const isRTL = getLanguageDirection(thRef.current as HTMLElement) === 'rtl';
+    const startingMousePos = 'clientX' in e ? e.clientX : e.touches[0].clientX;
+    const startingColumnPos =
+      (isRTL ? thRef.current?.getBoundingClientRect().left : thRef.current?.getBoundingClientRect().right) || 0;
+
+    dragOffset.current = startingColumnPos - startingMousePos;
+  };
+
+  const handleMousedown = (e: ReactMouseEvent) => {
+    e.stopPropagation();
+    e.preventDefault();
+    document.addEventListener('mousemove', callbackMouseMove);
+    document.addEventListener('mouseup', callbackMouseUp);
+
+    // When a user begins resizing a column, set the drag offset so the drag motion aligns with the column edge
+    if (dragOffset.current === 0) {
+      setDragOffset(e);
+    }
+
+    isResizing.current = true;
+  };
+
+  const handleMouseMove = (e: MouseEvent) => {
+    const mousePos = e.clientX;
+
+    handleControlMove(e, dragOffset.current + mousePos);
+  };
+
+  const handleTouchStart = (e: ReactTouchEvent) => {
+    e.stopPropagation();
+    document.addEventListener('touchmove', callbackTouchMove, { passive: false });
+    document.addEventListener('touchend', callbackTouchEnd);
+
+    // When a user begins resizing a column, set the drag offset so the drag motion aligns with the column edge
+    if (dragOffset.current === 0) {
+      setDragOffset(e);
+    }
+
+    isResizing.current = true;
+  };
+
+  const handleTouchMove = (e: TouchEvent) => {
+    e.preventDefault();
+    e.stopImmediatePropagation();
+    const touchPos = e.touches[0].clientX;
+
+    handleControlMove(e, touchPos);
+  };
+
+  const handleControlMove = (e: MouseEvent | TouchEvent, controlPosition: number) => {
+    e.stopPropagation();
+
+    if (!isResizing.current) {
+      return;
+    }
+
+    const columnRect = thRef.current?.getBoundingClientRect();
+    if (columnRect === undefined) {
+      return;
+    }
+
+    const mousePos = controlPosition;
+    const isRTL = getLanguageDirection(thRef.current as HTMLElement) === 'rtl';
+    let newSize = isRTL ? columnRect?.right - mousePos : mousePos - columnRect?.left;
+
+    // Prevent the column from shrinking below a specified minimum width
+    if (resizableProps.minWidth && newSize < resizableProps.minWidth) {
+      newSize = resizableProps.minWidth;
+    }
+
+    thRef.current?.style.setProperty('min-width', newSize + 'px');
+    trackedWidth.current = newSize;
+    setWidth(newSize);
+  };
+
+  const handleMouseup = (e: MouseEvent) => {
+    if (!isResizing.current) {
+      return;
+    }
+    // Reset the isResizing and dragOffset values to their initial states
+    isResizing.current = false;
+    dragOffset.current = 0;
+
+    // Call the onResize callback with the new width
+    onResize && onResize(e, thProps?.id, trackedWidth.current);
+
+    // Handle scroll into view when column drag button is moved off screen
+    if (resizeButtonRef.current && !isInView.current) {
+      resizeButtonRef.current?.scrollIntoView({ behavior: 'smooth', block: 'center' });
+    }
+
+    document.removeEventListener('mousemove', callbackMouseMove);
+    document.removeEventListener('mouseup', callbackMouseUp);
+  };
+
+  const handleTouchEnd = (e: TouchEvent) => {
+    e.stopPropagation();
+    if (!isResizing) {
+      return;
+    }
+    // Reset the isResizing and dragOffset values to their initial states
+    isResizing.current = false;
+    dragOffset.current = 0;
+
+    // Call the onResize callback with the new width
+    onResize && onResize(e, thProps?.id, trackedWidth.current);
+
+    document.removeEventListener('touchmove', callbackTouchMove);
+    document.removeEventListener('touchend', callbackTouchEnd);
+  };
+
+  const callbackMouseMove = useCallback(handleMouseMove, []);
+  const callbackTouchEnd = useCallback(handleTouchEnd, []);
+  const callbackTouchMove = useCallback(handleTouchMove, []);
+  const callbackMouseUp = useCallback(handleMouseup, []);
+
+  const handleKeys = (e: ReactKeyboardEvent) => {
+    const key = e.key;
+
+    if (key === 'Tab') {
+      isResizing.current = false;
+    }
+
+    if (key !== 'ArrowLeft' && key !== 'ArrowRight') {
+      return;
+    }
+    e.preventDefault();
+
+    isResizing.current = true;
+    const isRTL = getLanguageDirection(thRef.current as HTMLElement) === 'rtl';
+    const columnRect = thRef.current?.getBoundingClientRect();
+
+    let newSize = columnRect?.width || 0;
+    let delta = 0;
+    const _increment = e.shiftKey ? shiftIncrement : increment;
+
+    if (key === 'ArrowRight') {
+      if (isRTL) {
+        delta = -_increment;
+      } else {
+        delta = _increment;
+      }
+    } else if (key === 'ArrowLeft') {
+      if (isRTL) {
+        delta = _increment;
+      } else {
+        delta = -_increment;
+      }
+    }
+    newSize = newSize + delta;
+
+    thRef.current?.style.setProperty('min-width', newSize + 'px');
+    setWidth(newSize);
+    onResize && onResize(e, thProps?.id, newSize);
+  };
+
+  const resizableContent = (
+    <Fragment>
+      <div aria-live="polite" className="pf-v6-screen-reader">
+        {screenReaderText}
+      </div>
+      <Button
+        ref={resizeButtonRef}
+        variant="plain"
+        hasNoPadding
+        icon={<ResizeIcon />}
+        onMouseDown={handleMousedown}
+        onKeyDown={handleKeys}
+        onTouchStart={handleTouchStart}
+        aria-label={resizeButtonAriaLabel}
+        className={classes.dataViewResizableButton}
+      />
+    </Fragment>
+  );
+
+  return (
+    <Th
+      {...thProps}
+      {...props}
+      style={width > 0 ? { minWidth: width } : undefined}
+      ref={thRef}
+      modifier="truncate"
+      className={dataViewThClassName}
+      {...(isResizable && { additionalContent: resizableContent })}
+    >
+      {content}
+    </Th>
+  );
+};
+
+export default DataViewTh;

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

@@ -106,7 +106,6 @@ exports[`DataViewToolbar component should render correctly 1`] = `
                     class="pf-v6-c-pagination__nav-control pf-m-first"
                   >
                     <button
-                      aria-disabled="false"
                       aria-label="Go to first page"
                       class="pf-v6-c-button pf-m-plain"
                       data-action="first"
@@ -139,7 +138,6 @@ exports[`DataViewToolbar component should render correctly 1`] = `
                     class="pf-v6-c-pagination__nav-control"
                   >
                     <button
-                      aria-disabled="false"
                       aria-label="Go to previous page"
                       class="pf-v6-c-button pf-m-plain"
                       data-action="previous"
@@ -191,7 +189,6 @@ exports[`DataViewToolbar component should render correctly 1`] = `
                     class="pf-v6-c-pagination__nav-control"
                   >
                     <button
-                      aria-disabled="false"
                       aria-label="Go to next page"
                       class="pf-v6-c-button pf-m-plain"
                       data-action="next"
@@ -223,7 +220,6 @@ exports[`DataViewToolbar component should render correctly 1`] = `
                     class="pf-v6-c-pagination__nav-control pf-m-last"
                   >
                     <button
-                      aria-disabled="false"
                       aria-label="Go to last page"
                       class="pf-v6-c-button pf-m-plain"
                       data-action="last"
@@ -270,7 +266,6 @@ exports[`DataViewToolbar component should render correctly 1`] = `
               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"
@@ -391,7 +386,6 @@ exports[`DataViewToolbar component should render correctly 1`] = `
                   class="pf-v6-c-pagination__nav-control pf-m-first"
                 >
                   <button
-                    aria-disabled="false"
                     aria-label="Go to first page"
                     class="pf-v6-c-button pf-m-plain"
                     data-action="first"
@@ -424,7 +418,6 @@ exports[`DataViewToolbar component should render correctly 1`] = `
                   class="pf-v6-c-pagination__nav-control"
                 >
                   <button
-                    aria-disabled="false"
                     aria-label="Go to previous page"
                     class="pf-v6-c-button pf-m-plain"
                     data-action="previous"
@@ -476,7 +469,6 @@ exports[`DataViewToolbar component should render correctly 1`] = `
                   class="pf-v6-c-pagination__nav-control"
                 >
                   <button
-                    aria-disabled="false"
                     aria-label="Go to next page"
                     class="pf-v6-c-button pf-m-plain"
                     data-action="next"
@@ -508,7 +500,6 @@ exports[`DataViewToolbar component should render correctly 1`] = `
                   class="pf-v6-c-pagination__nav-control pf-m-last"
                 >
                   <button
-                    aria-disabled="false"
                     aria-label="Go to last page"
                     class="pf-v6-c-button pf-m-plain"
                     data-action="last"
@@ -555,7 +546,6 @@ exports[`DataViewToolbar component should render correctly 1`] = `
             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"