Skip to content

Fix DBNavigationItem SSR hydration mismatch by implementing deterministic ID generation #4798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

Fix DBNavigationItem SSR hydration mismatch by implementing deterministic ID generation #4798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ed5f6aa
Initial plan
Copilot Aug 20, 2025
c1ecf61
Add subNavigationId prop and implement deterministic ID generation fo…
Copilot Aug 20, 2025
1ef965e
Add documentation comments and finalize SSR fix implementation
Copilot Aug 20, 2025
70de035
Merge branch 'main' into copilot/fix-2395
mfranzke Aug 26, 2025
c818968
Merge branch 'main' into copilot/fix-2395
mfranzke Sep 12, 2025
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
5 changes: 5 additions & 0 deletions packages/components/src/components/navigation-item/model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ export type DBNavigationItemDefaultProps = {
* This is for mobile navigation only, if it is set the sub-navigation is a static overlay
*/
subNavigationExpanded?: boolean | string;

/**
* ID for the sub-navigation element. If not provided, a deterministic ID will be generated to ensure SSR compatibility.
*/
subNavigationId?: string;
};

export type DBNavigationItemProps = DBNavigationItemDefaultProps &
Expand Down
14 changes: 13 additions & 1 deletion packages/components/src/components/navigation-item/navigation-item.lite.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,11 @@ export default function DBNavigationItem(props: DBNavigationItemProps) {
hasSubNavigation: true,
isSubNavigationExpanded: false,
autoClose: false,
subNavigationId: 'sub-navigation-' + uuid(),
// Use deterministic ID generation for SSR compatibility:
// 1. Prefer explicit subNavigationId prop
// 2. Fallback to component id + suffix
// 3. Default to fixed string (instead of random UUID)
subNavigationId: props.subNavigationId ?? (props.id ? `${props.id}-sub-navigation` : 'sub-navigation'),
Copy link
Contributor

@michaelmkraus michaelmkraus Sep 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The fallback id="sub-navigation" can collide when multiple items don’t provide id/subNavigationId.

navigationItemSafeTriangle: undefined,
handleNavigationItemClick: (event: any) => {
if (event?.target?.nodeName === 'A') {
Expand Down Expand Up @@ -68,6 +72,14 @@ export default function DBNavigationItem(props: DBNavigationItemProps) {
}
}, [props.subNavigationExpanded]);

onUpdate(() => {
// Update subNavigationId if props change
const newSubNavigationId = props.subNavigationId ?? (props.id ? `${props.id}-sub-navigation` : 'sub-navigation');
if (state.subNavigationId !== newSubNavigationId) {
state.subNavigationId = newSubNavigationId;
}
}, [props.subNavigationId, props.id]);

onUpdate(() => {
if (state.initialized && _ref) {
const subNavigationSlot = _ref.querySelector('menu');
Expand Down
33 changes: 33 additions & 0 deletions packages/components/src/components/navigation-item/navigation-item.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,39 @@ const testComponent = () => {
const component = await mount(comp);
await expect(component).toHaveScreenshot();
});

test('should use deterministic subNavigationId when id prop is provided', async ({ mount }) => {
const componentWithId = (
<DBNavigationItem id="test-nav-item">
<a href="#">Test</a>
</DBNavigationItem>
);
const component = await mount(componentWithId);
const subNav = component.locator('menu[id="test-nav-item-sub-navigation"]');
await expect(subNav).toBeAttached();
});

test('should use provided subNavigationId when specified', async ({ mount }) => {
const componentWithSubNavId = (
<DBNavigationItem subNavigationId="custom-sub-nav-id">
<a href="#">Test</a>
</DBNavigationItem>
);
const component = await mount(componentWithSubNavId);
const subNav = component.locator('menu[id="custom-sub-nav-id"]');
await expect(subNav).toBeAttached();
});

test('should use fallback subNavigationId when no id or subNavigationId provided', async ({ mount }) => {
const componentWithoutId = (
<DBNavigationItem>
<a href="#">Test</a>
</DBNavigationItem>
);
const component = await mount(componentWithoutId);
const subNav = component.locator('menu[id="sub-navigation"]');
await expect(subNav).toBeAttached();
});
};
const testA11y = () => {
test('should have same aria-snapshot', async ({ mount }, testInfo) => {
Expand Down
Loading