fix(ExpandableSection): made animation opt-in for detached variant

Eric Olkowski · Eric Olkowski · commit e0972f3b2348 · 2025-05-28T10:19:04.000-04:00
diff --git a/packages/react-core/src/components/ExpandableSection/ExpandableSection.tsx b/packages/react-core/src/components/ExpandableSection/ExpandableSection.tsx
@@ -32,7 +32,7 @@ export interface ExpandableSectionProps extends Omit<React.HTMLProps<HTMLDivElem
   toggleId?: string;
   /** Display size variant. Set to "lg" for disclosure styling. */
   displaySize?: 'default' | 'lg';
-  /** Indicates the expandable section has a detached toggle. */
+  /** Flag indicating that the expandable section and expandable toggle are detached from one another. */
   isDetached?: boolean;
   /** Flag to indicate if the content is expanded. */
   isExpanded?: boolean;
@@ -64,6 +64,10 @@ export interface ExpandableSectionProps extends Omit<React.HTMLProps<HTMLDivElem
    * variant, the expandable content will be truncated after 3 lines by default.
    */
   variant?: 'default' | 'truncate';
+  /** Sets the direction of the expandable animation when isDetached is true. If this prop is not passed,
+   * animation will not occur.
+   */
+  direction?: 'up' | 'down';
 }
 
 interface ExpandableSectionState {
@@ -198,6 +202,7 @@ class ExpandableSection extends Component<ExpandableSectionProps, ExpandableSect
       variant,
       // eslint-disable-next-line @typescript-eslint/no-unused-vars
       truncateMaxLines,
+      direction,
       ...props
     } = this.props;
 
@@ -258,6 +263,8 @@ class ExpandableSection extends Component<ExpandableSectionProps, ExpandableSect
           displaySize === 'lg' && styles.modifiers.displayLg,
           isWidthLimited && styles.modifiers.limitWidth,
           isIndented && styles.modifiers.indented,
+          isDetached && 'pf-m-detached',
+          isDetached && direction && (direction === 'up' ? styles.modifiers.expandTop : 'pf-m-expand-bottom'),
           variant === ExpandableSectionVariant.truncate && styles.modifiers.truncate,
           className
         )}
diff --git a/packages/react-core/src/components/ExpandableSection/ExpandableSectionToggle.tsx b/packages/react-core/src/components/ExpandableSection/ExpandableSectionToggle.tsx
@@ -28,6 +28,8 @@ export interface ExpandableSectionToggleProps extends Omit<React.HTMLProps<HTMLD
   isExpanded?: boolean;
   /** Callback function to toggle the expandable content. */
   onToggle?: (isExpanded: boolean) => void;
+  /** Flag indicating that the expandable section and expandable toggle are detached from one another. */
+  isDetached?: boolean;
 }
 
 export const ExpandableSectionToggle: React.FunctionComponent<ExpandableSectionToggleProps> = ({
@@ -39,12 +41,14 @@ export const ExpandableSectionToggle: React.FunctionComponent<ExpandableSectionT
   toggleId,
   direction = 'down',
   hasTruncatedContent = false,
+  isDetached = true,
   ...props
 }: ExpandableSectionToggleProps) => (
   <div
     className={css(
       styles.expandableSection,
       isExpanded && styles.modifiers.expanded,
+      isDetached && 'pf-m-detached',
       hasTruncatedContent && styles.modifiers.truncate,
       className
     )}
@@ -63,7 +67,7 @@ export const ExpandableSectionToggle: React.FunctionComponent<ExpandableSectionT
             <span
               className={css(
                 styles.expandableSectionToggleIcon,
-                isExpanded && direction === 'up' && styles.modifiers.expandTop
+                isExpanded && direction === 'up' && styles.modifiers.expandTop // TODO: next breaking change move this class to the outter styles.expandableSection wrapper
               )}
             >
               <AngleRightIcon />
diff --git a/packages/react-core/src/components/ExpandableSection/__tests__/ExpandableSection.test.tsx b/packages/react-core/src/components/ExpandableSection/__tests__/ExpandableSection.test.tsx
@@ -1,9 +1,8 @@
-import { Fragment } from 'react';
 import { render, screen } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 
 import { ExpandableSection, ExpandableSectionVariant } from '../ExpandableSection';
-import { ExpandableSectionToggle } from '../ExpandableSectionToggle';
+import styles from '@patternfly/react-styles/css/components/ExpandableSection/expandable-section';
 
 const props = { contentId: 'content-id', toggleId: 'toggle-id' };
 
@@ -22,7 +21,7 @@ test('Renders ExpandableSection expanded', () => {
   expect(asFragment()).toMatchSnapshot();
 });
 
-test('ExpandableSection onToggle called', async () => {
+test('Calls onToggle when clicked', async () => {
   const mockfn = jest.fn();
   const user = userEvent.setup();
 
@@ -32,6 +31,21 @@ test('ExpandableSection onToggle called', async () => {
   expect(mockfn.mock.calls).toHaveLength(1);
 });
 
+test('Does not call onToggle when not clicked', async () => {
+  const mockfn = jest.fn();
+  const user = userEvent.setup();
+
+  render(
+    <>
+      <ExpandableSection onToggle={mockfn}> test </ExpandableSection>
+      <button onClick={() => {}}>Test clicker</button>
+    </>
+  );
+
+  await user.click(screen.getByRole('button', { name: 'Test clicker' }));
+  expect(mockfn).not.toHaveBeenCalled();
+});
+
 test('Renders Uncontrolled ExpandableSection', () => {
   const { asFragment } = render(
     <ExpandableSection {...props} toggleText="Show More">
@@ -42,20 +56,6 @@ test('Renders Uncontrolled ExpandableSection', () => {
   expect(asFragment()).toMatchSnapshot();
 });
 
-test('Detached ExpandableSection renders successfully', () => {
-  const { asFragment } = render(
-    <Fragment>
-      <ExpandableSection isExpanded isDetached {...props}>
-        test
-      </ExpandableSection>
-      <ExpandableSectionToggle isExpanded direction="up" {...props}>
-        Toggle text
-      </ExpandableSectionToggle>
-    </Fragment>
-  );
-  expect(asFragment()).toMatchSnapshot();
-});
-
 test('Disclosure ExpandableSection', () => {
   const { asFragment } = render(
     <ExpandableSection {...props} displaySize="lg" isWidthLimited>
@@ -75,22 +75,22 @@ test('Renders ExpandableSection indented', () => {
   expect(asFragment()).toMatchSnapshot();
 });
 
-test('Does not render with pf-m-truncate class when variant is not passed', () => {
+test(`Does not render with ${styles.modifiers.truncate} class when variant is not passed`, () => {
   render(<ExpandableSection>test</ExpandableSection>);
 
-  expect(screen.getByText('test').parentElement).not.toHaveClass('pf-m-truncate');
+  expect(screen.getByText('test').parentElement).not.toHaveClass(styles.modifiers.truncate);
 });
 
-test('Does not render with pf-m-truncate class when variant is not truncate', () => {
+test(`Does not render with ${styles.modifiers.truncate} class when variant is not truncate`, () => {
   render(<ExpandableSection variant={ExpandableSectionVariant.default}>test</ExpandableSection>);
 
-  expect(screen.getByText('test').parentElement).not.toHaveClass('pf-m-truncate');
+  expect(screen.getByText('test').parentElement).not.toHaveClass(styles.modifiers.truncate);
 });
 
-test('Renders with pf-m-truncate class when variant is truncate', () => {
+test(`Renders with ${styles.modifiers.truncate} class when variant is truncate`, () => {
   render(<ExpandableSection variant={ExpandableSectionVariant.truncate}>test</ExpandableSection>);
 
-  expect(screen.getByText('test').parentElement).toHaveClass('pf-m-truncate');
+  expect(screen.getByText('test').parentElement).toHaveClass(styles.modifiers.truncate);
 });
 
 test('Renders with value passed to contentId', () => {
@@ -129,3 +129,61 @@ test('Renders with ARIA attributes when contentId and toggleId are passed', () =
   expect(wrapper).toContainHTML('aria-labelledby="toggle-id"');
   expect(wrapper).toContainHTML('aria-controls="content-id"');
 });
+
+test(`Does not render with class pf-m-detached by default`, () => {
+  render(<ExpandableSection>Test content</ExpandableSection>);
+
+  expect(screen.getByText('Test content').parentElement).not.toHaveClass('pf-m-detached');
+});
+
+test(`Renders with class pf-m-detached when isDetached is true`, () => {
+  render(<ExpandableSection isDetached>Test content</ExpandableSection>);
+
+  expect(screen.getByText('Test content').parentElement).toHaveClass('pf-m-detached');
+});
+
+test(`Does not render with classes pf-m-expand-top nor pf-m-expand-bottom by default`, () => {
+  render(<ExpandableSection>Test content</ExpandableSection>);
+
+  expect(screen.getByText('Test content').parentElement).not.toHaveClass('pf-m-expand-top');
+  expect(screen.getByText('Test content').parentElement).not.toHaveClass('pf-m-expand-bottom');
+});
+
+test(`Does not render with classes pf-m-expand-top nor pf-m-expand-bottom when only isDetached is true`, () => {
+  render(<ExpandableSection isDetached>Test content</ExpandableSection>);
+
+  expect(screen.getByText('Test content').parentElement).not.toHaveClass('pf-m-expand-top');
+  expect(screen.getByText('Test content').parentElement).not.toHaveClass('pf-m-expand-bottom');
+});
+
+test(`Does not render with class pf-m-expand-top when only direction="up"`, () => {
+  render(<ExpandableSection direction="up">Test content</ExpandableSection>);
+
+  expect(screen.getByText('Test content').parentElement).not.toHaveClass('pf-m-expand-top');
+});
+
+test(`Does not render with class pf-m-expand-bottom when only direction="down"`, () => {
+  render(<ExpandableSection direction="down">Test content</ExpandableSection>);
+
+  expect(screen.getByText('Test content').parentElement).not.toHaveClass('pf-m-expand-bottom');
+});
+
+test(`Renders with class pf-m-expand-top when isDetached is true and direction="up"`, () => {
+  render(
+    <ExpandableSection isDetached direction="up">
+      Test content
+    </ExpandableSection>
+  );
+
+  expect(screen.getByText('Test content').parentElement).toHaveClass('pf-m-expand-top');
+});
+
+test(`Renders with class pf-m-expand-bottom when isDetached is true and direction="down"`, () => {
+  render(
+    <ExpandableSection isDetached direction="down">
+      Test content
+    </ExpandableSection>
+  );
+
+  expect(screen.getByText('Test content').parentElement).toHaveClass('pf-m-expand-bottom');
+});
diff --git a/packages/react-core/src/components/ExpandableSection/__tests__/ExpandableSectionToggle.test.tsx b/packages/react-core/src/components/ExpandableSection/__tests__/ExpandableSectionToggle.test.tsx
@@ -0,0 +1,32 @@
+import { render, screen } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import { ExpandableSectionToggle } from '../ExpandableSectionToggle';
+import styles from '@patternfly/react-styles/css/components/ExpandableSection/expandable-section';
+
+test('Renders without children', () => {
+  render(<ExpandableSectionToggle></ExpandableSectionToggle>);
+
+  expect(screen.getByRole('button')).toBeInTheDocument();
+});
+
+test('Renders with children', () => {
+  render(<ExpandableSectionToggle>Toggle test</ExpandableSectionToggle>);
+
+  expect(screen.getByRole('button')).toHaveTextContent('Toggle test');
+});
+
+test('Renders with class pf-m-detached by default', () => {
+  render(<ExpandableSectionToggle data-testid="section-wrapper">Toggle test</ExpandableSectionToggle>);
+
+  expect(screen.getByTestId('section-wrapper')).toHaveClass('pf-m-detached');
+});
+
+test('Does not render with class pf-m-detached when isDetached is false', () => {
+  render(
+    <ExpandableSectionToggle isDetached={false} data-testid="section-wrapper">
+      Toggle test
+    </ExpandableSectionToggle>
+  );
+
+  expect(screen.getByTestId('section-wrapper')).not.toHaveClass('pf-m-detached');
+});
diff --git a/packages/react-core/src/components/ExpandableSection/__tests__/__snapshots__/ExpandableSection.test.tsx.snap b/packages/react-core/src/components/ExpandableSection/__tests__/__snapshots__/ExpandableSection.test.tsx.snap
@@ -1,67 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`Detached ExpandableSection renders successfully 1`] = `
-<DocumentFragment>
-  <div
-    class="pf-v6-c-expandable-section pf-m-expanded"
-  >
-    <div
-      aria-labelledby="toggle-id"
-      class="pf-v6-c-expandable-section__content"
-      id="content-id"
-      role="region"
-    >
-      test
-    </div>
-  </div>
-  <div
-    class="pf-v6-c-expandable-section pf-m-expanded"
-  >
-    <div
-      class="pf-v6-c-expandable-section__toggle"
-    >
-      <button
-        aria-controls="content-id"
-        aria-expanded="true"
-        class="pf-v6-c-button pf-m-link"
-        data-ouia-component-id="OUIA-Generated-Button-link-5"
-        data-ouia-component-type="PF6/Button"
-        data-ouia-safe="true"
-        id="toggle-id"
-        type="button"
-      >
-        <span
-          class="pf-v6-c-button__icon pf-m-start"
-        >
-          <span
-            class="pf-v6-c-expandable-section__toggle-icon pf-m-expand-top"
-          >
-            <svg
-              aria-hidden="true"
-              class="pf-v6-svg"
-              fill="currentColor"
-              height="1em"
-              role="img"
-              viewBox="0 0 256 512"
-              width="1em"
-            >
-              <path
-                d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34z"
-              />
-            </svg>
-          </span>
-        </span>
-        <span
-          class="pf-v6-c-button__text"
-        >
-          Toggle text
-        </span>
-      </button>
-    </div>
-  </div>
-</DocumentFragment>
-`;
-
 exports[`Disclosure ExpandableSection 1`] = `
 <DocumentFragment>
   <div
@@ -285,7 +223,7 @@ exports[`Renders Uncontrolled ExpandableSection 1`] = `
       <button
         aria-controls="content-id"
         class="pf-v6-c-button pf-m-link"
-        data-ouia-component-id="OUIA-Generated-Button-link-4"
+        data-ouia-component-id="OUIA-Generated-Button-link-5"
         data-ouia-component-type="PF6/Button"
         data-ouia-safe="true"
         id="toggle-id"
diff --git a/packages/react-core/src/components/ExpandableSection/examples/ExpandableSection.md b/packages/react-core/src/components/ExpandableSection/examples/ExpandableSection.md
@@ -32,6 +32,8 @@ import CheckCircleIcon from '@patternfly/react-icons/dist/esm/icons/check-circle
 
 When passing the `isDetached` property into `<ExpandableSection>`, you must also manually pass in the same `toggleId` and `contentId` properties to both `<ExpandableSection>` and `<ExpandableSectionToggle>`. This will link the content to the toggle via ARIA attributes.
 
+By default animations will not be enabled for a detached `<ExpandableSection>`. You must manually pass the `direction` property with an appropriate value based on where the expandable content is rendered. If the expandable content is above the expandable toggle, `direction="up"` must be passed like in this example.
+
 ```ts file="ExpandableSectionDetached.tsx"
 
 ```
diff --git a/packages/react-core/src/components/ExpandableSection/examples/ExpandableSectionDetached.tsx b/packages/react-core/src/components/ExpandableSection/examples/ExpandableSectionDetached.tsx
@@ -13,7 +13,7 @@ export const ExpandableSectionDetached: React.FunctionComponent = () => {
   return (
     <Stack hasGutter>
       <StackItem>
-        <ExpandableSection isExpanded={isExpanded} isDetached toggleId={toggleId} contentId={contentId}>
+        <ExpandableSection isExpanded={isExpanded} isDetached direction="up" toggleId={toggleId} contentId={contentId}>
           This content is visible only when the component is expanded.
         </ExpandableSection>
       </StackItem>
