feat(TreeView): enabled opt-in animations (#11842)

* feat(TreeView): enabled opt-in animations

* Fixed failing tests

Author: thatblindgeye

packages/react-core/src/components/TreeView/TreeView.tsx

@@ -103,6 +103,11 @@ export interface TreeViewProps {
   useMemo?: boolean;
   /** Variant presentation styles for the tree view. */
   variant?: 'default' | 'compact' | 'compactNoBackground';
+  /** Flag indicating whether a tree view has animations. This will always render
+   * nested tree view items rather than dynamically rendering them. This prop will be removed in
+   * the next breaking change release in favor of defaulting to always-rendered items.
+   */
+  hasAnimations?: boolean;
 }
 
 export const TreeView: React.FunctionComponent<TreeViewProps> = ({
@@ -130,6 +135,7 @@ export const TreeView: React.FunctionComponent<TreeViewProps> = ({
   useMemo,
   'aria-label': ariaLabel,
   'aria-labelledby': ariaLabelledby,
+  hasAnimations,
   ...props
 }: TreeViewProps) => {
   const treeViewList = (
@@ -139,11 +145,13 @@ export const TreeView: React.FunctionComponent<TreeViewProps> = ({
       isMultiSelectable={isMultiSelectable}
       aria-label={ariaLabel}
       aria-labelledby={ariaLabelledby}
+      {...props}
     >
       {data.map((item) => (
         <TreeViewListItem
           key={item.id?.toString() || item.name?.toString()}
           name={item.name}
+          hasAnimations={hasAnimations}
           title={item.title}
           id={item.id}
           isExpanded={allExpanded}
@@ -172,6 +180,7 @@ export const TreeView: React.FunctionComponent<TreeViewProps> = ({
               <TreeView
                 data={item.children}
                 isNested
+                hasAnimations={hasAnimations}
                 parentItem={item}
                 hasCheckboxes={hasCheckboxes}
                 hasBadges={hasBadges}

packages/react-core/src/components/TreeView/TreeViewListItem.tsx

@@ -1,4 +1,4 @@
-import { memo, useState, useEffect } from 'react';
+import { memo, useState, useEffect, Children, isValidElement, cloneElement } from 'react';
 import { css } from '@patternfly/react-styles';
 import styles from '@patternfly/react-styles/css/components/TreeView/tree-view';
 import AngleRightIcon from '@patternfly/react-icons/dist/esm/icons/angle-right-icon';
@@ -68,6 +68,11 @@ export interface TreeViewListItemProps {
    * every node in the selected item's path.
    */
   useMemo?: boolean;
+  /** Flag indicating whether a tree view has animations. This will always render
+   * nested tree view items rather than dynamically rendering them. This prop will be removed in
+   * the next breaking change release in favor of defaulting to always-rendered items.
+   */
+  hasAnimations?: boolean;
 }
 
 const TreeViewListItemBase: React.FunctionComponent<TreeViewListItemProps> = ({
@@ -97,6 +102,7 @@ const TreeViewListItemBase: React.FunctionComponent<TreeViewListItemProps> = ({
   expandedIcon,
   action,
   compareItems,
+  hasAnimations,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   useMemo
 }: TreeViewListItemProps) => {
@@ -203,6 +209,15 @@ const TreeViewListItemBase: React.FunctionComponent<TreeViewListItemProps> = ({
     activeItems.length > 0 &&
     activeItems.some((item) => compareItems && item && compareItems(item, itemData));
 
+  const clonedChildren = Children.map(
+    children,
+    (child) =>
+      isValidElement(child) &&
+      cloneElement(child as React.ReactElement<any>, {
+        inert: internalIsExpanded ? undefined : ''
+      })
+  );
+
   return (
     <li
       id={id}
@@ -247,7 +262,7 @@ const TreeViewListItemBase: React.FunctionComponent<TreeViewListItemProps> = ({
         </GenerateId>
         {action && <div className={css(styles.treeViewAction)}>{action}</div>}
       </div>
-      {internalIsExpanded && children}
+      {(internalIsExpanded || hasAnimations) && clonedChildren}
     </li>
   );
 };

packages/react-core/src/components/TreeView/TreeViewRoot.tsx

@@ -72,7 +72,7 @@ class TreeViewRoot extends Component<TreeViewRootProps> {
     const activeElement = document.activeElement;
     const key = event.key;
     const treeItems = Array.from(this.treeRef.current?.getElementsByClassName(styles.treeViewNode)).filter(
-      (el) => !el.classList.contains('pf-m-disabled')
+      (el) => !el.classList.contains('pf-m-disabled') && !el.closest(`.${styles.treeViewList}[inert]`)
     );
 
     if (key === KeyTypes.Space) {
@@ -138,7 +138,9 @@ class TreeViewRoot extends Component<TreeViewRootProps> {
       event.preventDefault();
     }
 
-    const treeNodes = Array.from(this.treeRef.current?.getElementsByClassName(styles.treeViewNode));
+    const treeNodes = Array.from(this.treeRef.current?.getElementsByClassName(styles.treeViewNode)).filter(
+      (el) => !el.closest(`.${styles.treeViewList}[inert]`)
+    );
 
     handleArrows(
       event,

packages/react-core/src/components/TreeView/__tests__/TreeView.test.tsx

@@ -47,7 +47,8 @@ jest.mock('../TreeViewListItem', () => ({
     onCollapse,
     parentItem,
     title,
-    useMemo
+    useMemo,
+    hasAnimations
   }) => (
     <div data-testid="TreeViewListItem-mock">
       <p>{`TreeViewListItem action: ${action}`}</p>
@@ -69,6 +70,7 @@ jest.mock('../TreeViewListItem', () => ({
       <p>{`TreeViewListItem parentItem: ${parentItem?.name}`}</p>
       <p>{`TreeViewListItem title: ${title}`}</p>
       <p>{`TreeViewListItem useMemo: ${useMemo}`}</p>
+      <p>{`TreeViewListItem hasAnimations: ${hasAnimations}`}</p>
       <button onClick={compareItems}>compareItems clicker</button>
       <button onClick={onCheck}>onCheck clicker</button>
       <button onClick={onSelect}>onSelect clicker</button>
@@ -286,6 +288,11 @@ test('Passes useMemo to TreeViewListItem', () => {
 
   expect(screen.getByText('TreeViewListItem useMemo: true')).toBeVisible();
 });
+test('Passes hasAnimations to TreeViewListItem', () => {
+  render(<TreeView data={[basicData]} hasAnimations={true} />);
+
+  expect(screen.getByText('TreeViewListItem hasAnimations: true')).toBeVisible();
+});
 test('Passes data.children to TreeViewListItem', () => {
   render(<TreeView data={[{ ...basicData, children: [{ name: 'Child 1' }] }]} />);
 

packages/react-core/src/components/TreeView/__tests__/TreeViewList.test.tsx

@@ -1,5 +1,7 @@
 import { render, screen } from '@testing-library/react';
 import { TreeViewList } from '../TreeViewList';
+import { TreeViewListItem } from '../TreeViewListItem';
+import { TreeView } from '../TreeView';
 import styles from '@patternfly/react-styles/css/components/TreeView/tree-view';
 
 test(`Renders with class ${styles.treeView}__list by default`, () => {
@@ -84,6 +86,43 @@ test(`Does not render toolbar content when toolbar prop is not passed`, () => {
   expect(screen.queryByRole('separator')).not.toBeInTheDocument();
 });
 
+test('Renders with inert attribute by default when TreeView is passed hasAnimations', () => {
+  const options = [
+    {
+      name: 'Parent 1',
+      id: 'parent-1',
+      children: [
+        {
+          name: 'Child 1',
+          id: 'child-1'
+        }
+      ]
+    }
+  ];
+  render(<TreeView hasAnimations data={options} />);
+
+  expect(screen.getByRole('group')).toHaveAttribute('inert', '');
+});
+
+test('Does not render with inert attribute when expanded and TreeView is passed hasAnimations', () => {
+  const options = [
+    {
+      name: 'Parent 1',
+      id: 'parent-1',
+      defaultExpanded: true,
+      children: [
+        {
+          name: 'Child 1',
+          id: 'child-1'
+        }
+      ]
+    }
+  ];
+  render(<TreeView hasAnimations data={options} />);
+
+  expect(screen.getByRole('group')).not.toHaveAttribute('inert');
+});
+
 test('Matches snapshot by default', () => {
   const { asFragment } = render(<TreeViewList>Content</TreeViewList>);
 

packages/react-core/src/components/TreeView/__tests__/TreeViewListItem.test.tsx

@@ -28,7 +28,7 @@ test(`Does not render children by default`, () => {
 test(`Renders children if defaultExpanded is true`, () => {
   render(
     <TreeViewListItem defaultExpanded={true} {...requiredProps}>
-      Content
+      <div>Content</div>
     </TreeViewListItem>
   );
 
@@ -38,7 +38,7 @@ test(`Renders children if defaultExpanded is true`, () => {
 test(`Renders children if isExpanded is true`, () => {
   render(
     <TreeViewListItem isExpanded={true} {...requiredProps}>
-      Content
+      <div>Content</div>
     </TreeViewListItem>
   );
 
@@ -47,7 +47,11 @@ test(`Renders children if isExpanded is true`, () => {
 
 test(`Renders children when toggle is clicked`, async () => {
   const user = userEvent.setup();
-  render(<TreeViewListItem {...requiredProps}>Content</TreeViewListItem>);
+  render(
+    <TreeViewListItem {...requiredProps}>
+      <div>Content</div>
+    </TreeViewListItem>
+  );
 
   await user.click(screen.getByRole('button', { name: requiredProps.name }));
 

packages/react-core/src/components/TreeView/__tests__/__snapshots__/TreeView.test.tsx.snap

@@ -104,6 +104,9 @@ exports[`Matches snapshot 1`] = `
             <p>
               TreeViewListItem useMemo: undefined
             </p>
+            <p>
+              TreeViewListItem hasAnimations: undefined
+            </p>
             <button>
               compareItems clicker
             </button>

packages/react-core/src/components/TreeView/examples/TreeViewCompact.tsx

@@ -54,5 +54,5 @@ export const TreeViewCompact: React.FunctionComponent = () => {
       ]
     }
   ];
-  return <TreeView aria-label="Tree View compact example" data={options} variant="compact" />;
+  return <TreeView hasAnimations aria-label="Tree View compact example" data={options} variant="compact" />;
 };

packages/react-core/src/components/TreeView/examples/TreeViewCompactNoBackground.tsx

@@ -54,5 +54,12 @@ export const TreeViewCompactNoBackground: React.FunctionComponent = () => {
       ]
     }
   ];
-  return <TreeView aria-label="Tree View compact no background example" data={options} variant="compactNoBackground" />;
+  return (
+    <TreeView
+      hasAnimations
+      aria-label="Tree View compact no background example"
+      data={options}
+      variant="compactNoBackground"
+    />
+  );
 };

packages/react-core/src/components/TreeView/examples/TreeViewGuides.tsx

@@ -60,5 +60,5 @@ export const GuidesTreeView: React.FunctionComponent = () => {
       children: [{ name: 'Application 5', id: 'example8-App5' }]
     }
   ];
-  return <TreeView aria-label="Tree View guides example" data={options} hasGuides={true} />;
+  return <TreeView hasAnimations aria-label="Tree View guides example" data={options} hasGuides={true} />;
 };