Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/pluggableWidgets/accordion-web/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## [Unreleased]

### Fixed

- We fixed an issue where the content of an accordion group could be cut off or jump when its height changed, for example when validation messages appeared. Groups set to load content when expanded now also show their content from the start of the expand animation.

## [2.3.6] - 2026-09-15

### Fixed
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
import classNames from "classnames";
import { Key, KeyboardEvent, ReactElement, ReactNode, useCallback, useEffect, useRef, useState } from "react";
import {
Key,
KeyboardEvent,
ReactElement,
ReactNode,
TransitionEvent,
useCallback,
useEffect,
useRef,
useState
} from "react";
import { LoadContentEnum } from "typings/AccordionProps";
import { CallResizeObserver, useDebouncedResizeObserver } from "../utils/resizeObserver";
import "../ui/accordion-main.scss";

export const enum Target {
Expand Down Expand Up @@ -35,62 +44,67 @@
const { animateContent, changeFocus, showHeaderIcon, toggleCollapsed, onToggleCompletion, loadContent } = props;

const [renderCollapsed, setRenderCollapsed] = useState(props.collapsed);
const previousRenderCollapsed = useRef(renderCollapsed);

Check warning on line 47 in packages/pluggableWidgets/accordion-web/src/components/AccordionGroup.tsx

View workflow job for this annotation

GitHub Actions / Run code quality check

A ref identifier must be named 'ref' or ending in 'Ref'
const animatingContent = useRef<boolean>(false);

Check warning on line 48 in packages/pluggableWidgets/accordion-web/src/components/AccordionGroup.tsx

View workflow job for this annotation

GitHub Actions / Run code quality check

A ref identifier must be named 'ref' or ending in 'Ref'
const fallbackTimerRef = useRef<ReturnType<typeof setTimeout>>(undefined);

const rootRef = useRef<HTMLDivElement>(null);
const contentWrapperRef = useRef<HTMLDivElement>(null);
const contentRef = useRef<HTMLDivElement>(null);
const renderContent = useRef(loadContent === "always");

Check warning on line 52 in packages/pluggableWidgets/accordion-web/src/components/AccordionGroup.tsx

View workflow job for this annotation

GitHub Actions / Run code quality check

A ref identifier must be named 'ref' or ending in 'Ref'

renderContent.current ||= !renderCollapsed;
useDebouncedResizeObserver(CallResizeObserver, { renderCollapsed, contentWrapperRef, contentRef });
// Render content as soon as expanding starts, so it is present during the whole animation.
renderContent.current ||= !props.collapsed || !renderCollapsed;

const clearFallbackTimer = useCallback((): void => {
clearTimeout(fallbackTimerRef.current);
fallbackTimerRef.current = undefined;
}, []);

useEffect(() => clearFallbackTimer, [clearFallbackTimer]);

const completeTransitioning = useCallback((): void => {
if (contentWrapperRef.current && rootRef.current && animatingContent.current) {
if (rootRef.current && animatingContent.current) {
clearFallbackTimer();
if (!renderCollapsed) {
rootRef.current.classList.add("widget-accordion-group-collapsed");
rootRef.current.classList.remove("widget-accordion-group-collapsing");
setRenderCollapsed(true);
} else {
rootRef.current.classList.remove("widget-accordion-group-expanding");
contentWrapperRef.current.style.height = "";
setRenderCollapsed(false);
}

animatingContent.current = false;
}
}, [renderCollapsed]);
}, [renderCollapsed, clearFallbackTimer]);

const onTransitionEnd = useCallback(
(event: TransitionEvent<HTMLElement>): void => {
// Ignore transitions bubbling up from the header icon or the content.
if (event.target === event.currentTarget && event.propertyName === "grid-template-rows") {
completeTransitioning();
}
},
[completeTransitioning]
);

useEffect(() => {
if (
props.collapsed !== renderCollapsed &&
rootRef.current &&
contentWrapperRef.current &&
contentRef.current &&
animateContent
) {
if (props.collapsed !== renderCollapsed && rootRef.current && animateContent) {
animatingContent.current = true;
if (props.collapsed) {
contentWrapperRef.current.style.height = `${contentRef.current.getBoundingClientRect().height}px`;
rootRef.current.classList.add("widget-accordion-group-collapsing");

setTimeout(() => {
if (contentWrapperRef.current) {
contentWrapperRef.current.style.height = "";
}
}, 50);
} else {
rootRef.current.classList.add("widget-accordion-group-expanding");
rootRef.current.classList.remove("widget-accordion-group-collapsed");
}

setTimeout(() => {
if (contentWrapperRef.current && contentRef.current) {
contentWrapperRef.current.style.height = `${
contentRef.current.getBoundingClientRect().height
}px`;
}
}, 50);
// transitionend does not fire when there is no transition (prefers-reduced-motion, a theme
// override, an unsupported browser) or when the group is not rendered (for example in a hidden tab).
const transitionTime = getTransitionTime(rootRef.current);
clearFallbackTimer();
if (transitionTime === 0) {
completeTransitioning();
} else {
fallbackTimerRef.current = setTimeout(completeTransitioning, transitionTime + 100);

Check warning on line 107 in packages/pluggableWidgets/accordion-web/src/components/AccordionGroup.tsx

View workflow job for this annotation

GitHub Actions / Run code quality check

A 'setTimeout' created in 'useEffect' must be cleared with 'clearTimeout' in the cleanup function
}
} else if (props.collapsed !== renderCollapsed && (!animateContent || !props.visible)) {
setRenderCollapsed(props.collapsed);
Expand All @@ -104,7 +118,7 @@
completeTransitioning();
}
}
}, [props.collapsed, props.visible, renderCollapsed, animateContent, completeTransitioning]);
}, [props.collapsed, props.visible, renderCollapsed, animateContent, completeTransitioning, clearFallbackTimer]);

useEffect(() => {
if (renderCollapsed !== previousRenderCollapsed.current) {
Expand Down Expand Up @@ -159,6 +173,7 @@
},
props.dynamicClassName
)}
onTransitionEnd={onTransitionEnd}
>
<header className={"widget-accordion-group-header"}>
<div
Expand Down Expand Up @@ -186,18 +201,30 @@
</div>
</header>
<div
ref={contentWrapperRef}
id={`${props.id}ContentWrapper`}
className={"widget-accordion-group-content-wrapper"}
data-focusindex={0}
onTransitionEnd={completeTransitioning}
role="region"
aria-labelledby={`${props.id}HeaderButton`}
>
<div ref={contentRef} className={"widget-accordion-group-content"}>
{renderContent.current && props.content}
</div>
<div className={"widget-accordion-group-content"}>{renderContent.current && props.content}</div>
</div>
</section>
);
}

/** Longest transition (duration + delay) in milliseconds currently applied to the element. */
function getTransitionTime(element: HTMLElement): number {
const style = window.getComputedStyle(element);
const toMs = (value: string): number[] =>
value.split(",").map(time => {
const parsed = parseFloat(time);
if (Number.isNaN(parsed)) {
return 0;
}
return time.trim().endsWith("ms") ? parsed : parsed * 1000;
});
const durations = toMs(style.transitionDuration);
const delays = toMs(style.transitionDelay);
return Math.max(0, ...durations.map((duration, i) => duration + (delays[i % delays.length] ?? 0)));
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@ import { act, render, RenderResult } from "@testing-library/react";
import userEvent, { UserEvent } from "@testing-library/user-event";
import { Accordion, AccordionProps } from "../Accordion";

global.ResizeObserver = jest.fn().mockImplementation(() => ({
observe: jest.fn(),
unobserve: jest.fn(),
disconnect: jest.fn()
}));

describe("Accordion", () => {
let defaultProps: AccordionProps;
let user: UserEvent;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
import "@testing-library/jest-dom";
import { act, render, RenderResult } from "@testing-library/react";
import { act, createEvent, fireEvent, render, RenderResult } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import { AccordionGroup, AccordionGroupProps, Target } from "../AccordionGroup";

global.ResizeObserver = jest.fn().mockImplementation(() => ({
observe: jest.fn(),
unobserve: jest.fn(),
disconnect: jest.fn()
}));

describe("AccordionGroup", () => {
const defaultAccordionGroupProps: AccordionGroupProps = {
id: "id",
Expand Down Expand Up @@ -390,4 +384,141 @@ describe("AccordionGroup", () => {
expect(accordionGroup.queryByText("Widgets")).toBeInTheDocument();
});
});

describe("animated", () => {
const animatedProps: AccordionGroupProps = {
...defaultAccordionGroupProps,
animateContent: true,
collapsible: true,
toggleCollapsed: jest.fn()
};

function mockTransitionDuration(duration: string): void {
const original = window.getComputedStyle;
jest.spyOn(window, "getComputedStyle").mockImplementation(element => {
const style = original(element);
return { ...style, transitionDuration: duration, transitionDelay: "0s" } as CSSStyleDeclaration;
});
}

function getGroup(result: RenderResult): HTMLElement {
return result.container.querySelector(".widget-accordion-group") as HTMLElement;
}

function fireTransitionEnd(element: Element, propertyName = "grid-template-rows"): void {
const event = createEvent.transitionEnd(element);
Object.defineProperty(event, "propertyName", { value: propertyName });
fireEvent(element, event);
}

beforeEach(() => {
jest.useFakeTimers();
});

afterEach(() => {
jest.restoreAllMocks();
jest.useRealTimers();
});

it("expands with a transition and completes on transitionend", () => {
mockTransitionDuration("0.2s");
const onToggleCompletion = jest.fn();
const result = render(<AccordionGroup {...animatedProps} onToggleCompletion={onToggleCompletion} />);

result.rerender(
<AccordionGroup {...animatedProps} collapsed={false} onToggleCompletion={onToggleCompletion} />
);
const group = getGroup(result);
expect(group).toHaveClass("widget-accordion-group-expanding");
expect(group).not.toHaveClass("widget-accordion-group-collapsed");
expect(onToggleCompletion).not.toHaveBeenCalled();

act(() => fireTransitionEnd(group));

expect(group).not.toHaveClass("widget-accordion-group-expanding");
expect(onToggleCompletion).toHaveBeenCalledTimes(1);
expect(onToggleCompletion).toHaveBeenCalledWith(false);

act(() => jest.runAllTimers());
expect(onToggleCompletion).toHaveBeenCalledTimes(1);
});

it("collapses with a transition and completes on transitionend", () => {
mockTransitionDuration("0.2s");
const onToggleCompletion = jest.fn();
const result = render(
<AccordionGroup {...animatedProps} collapsed={false} onToggleCompletion={onToggleCompletion} />
);

result.rerender(<AccordionGroup {...animatedProps} collapsed onToggleCompletion={onToggleCompletion} />);
const group = getGroup(result);
expect(group).toHaveClass("widget-accordion-group-collapsing");
expect(group).not.toHaveClass("widget-accordion-group-collapsed");

act(() => fireTransitionEnd(group));

expect(group).toHaveClass("widget-accordion-group-collapsed");
expect(group).not.toHaveClass("widget-accordion-group-collapsing");
expect(onToggleCompletion).toHaveBeenCalledTimes(1);
expect(onToggleCompletion).toHaveBeenCalledWith(true);
});

it("ignores transitionend events from other properties and from the content", () => {
mockTransitionDuration("0.2s");
const onToggleCompletion = jest.fn();
const result = render(<AccordionGroup {...animatedProps} onToggleCompletion={onToggleCompletion} />);
result.rerender(
<AccordionGroup {...animatedProps} collapsed={false} onToggleCompletion={onToggleCompletion} />
);
const group = getGroup(result);

act(() => {
fireTransitionEnd(group, "border-radius");
fireTransitionEnd(result.getByText("content"));
});

expect(group).toHaveClass("widget-accordion-group-expanding");
expect(onToggleCompletion).not.toHaveBeenCalled();
});

it("completes when transitionend does not fire", () => {
mockTransitionDuration("0.2s");
const onToggleCompletion = jest.fn();
const result = render(<AccordionGroup {...animatedProps} onToggleCompletion={onToggleCompletion} />);
result.rerender(
<AccordionGroup {...animatedProps} collapsed={false} onToggleCompletion={onToggleCompletion} />
);

act(() => jest.advanceTimersByTime(400));

expect(getGroup(result)).not.toHaveClass("widget-accordion-group-expanding");
expect(onToggleCompletion).toHaveBeenCalledTimes(1);
});

it("completes immediately when there is no transition, such as with reduced motion", () => {
mockTransitionDuration("0s");
const onToggleCompletion = jest.fn();
const result = render(
<AccordionGroup {...animatedProps} collapsed={false} onToggleCompletion={onToggleCompletion} />
);

result.rerender(<AccordionGroup {...animatedProps} collapsed onToggleCompletion={onToggleCompletion} />);

const group = getGroup(result);
expect(group).toHaveClass("widget-accordion-group-collapsed");
expect(group).not.toHaveClass("widget-accordion-group-collapsing");
expect(onToggleCompletion).toHaveBeenCalledTimes(1);
});

it("renders content from the start of expanding when loading content when expanded", () => {
mockTransitionDuration("0.2s");
const result = render(<AccordionGroup {...animatedProps} loadContent="whenExpanded" />);
expect(result.queryByText("content")).not.toBeInTheDocument();

result.rerender(<AccordionGroup {...animatedProps} loadContent="whenExpanded" collapsed={false} />);

expect(getGroup(result)).toHaveClass("widget-accordion-group-expanding");
expect(result.getByText("content")).toBeInTheDocument();
});
});
});
Loading
Loading