Skip to content

fix(astro): Make user button menu items compiler-safe #8980

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

Open
wobsoriano wants to merge 2 commits into
base: main
Choose a base branch
from
+47 −41
Open

fix(astro): Make user button menu items compiler-safe #8980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2cb4e55
fix(astro): fix user button menu items
wobsoriano Jun 24, 2026
1752f92
Merge branch 'main' into rob/fix-astro-rust-compiler-error
wobsoriano Jun 24, 2026
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 .changeset/fresh-astro-compiler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': patch
---

Fix custom user button menu item rendering for Astro's stricter compiler.
83 changes: 42 additions & 41 deletions packages/astro/src/astro-components/interactive/UserButton/MenuItemRenderer.astro
View file
Open in desktop

@wobsoriano wobsoriano Jun 25, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This is tested here https://github.com/clerk/javascript/blob/1752f9246e157cc0512a732299922b88705db387/integration/tests/astro/components.test.ts#L80,L144

Original file line number Diff line number Diff line change
Expand Up @@ -29,54 +29,55 @@ const isDevMode = import.meta.env.DEV;
`Clerk: <UserButton.MenuItems /> component can only accept <UserButton.Action /> and <UserButton.Link /> as its children. Any other provided component will be ignored.`,
);
}
return;
}
} else {
// Get the user button map from window that we set in the `<InternalUIComponentRenderer />`.
const userButtonComponentMap = window.__astro_clerk_component_props?.get('user-button');

// Get the user button map from window that we set in the `<InternalUIComponentRenderer />`.
const userButtonComponentMap = window.__astro_clerk_component_props.get('user-button');
let userButton;
if (parent) {
userButton = document.querySelector(`[data-clerk-id="clerk-user-button-${parent}"]`);
} else {
userButton = document.querySelector('[data-clerk-id^="clerk-user-button"]');
}

let userButton;
if (parent) {
userButton = document.querySelector(`[data-clerk-id="clerk-user-button-${parent}"]`);
} else {
userButton = document.querySelector('[data-clerk-id^="clerk-user-button"]');
}
const safeId = userButton?.getAttribute('data-clerk-id');
if (userButtonComponentMap && safeId) {
const currentOptions = userButtonComponentMap.get(safeId);

const safeId = userButton.getAttribute('data-clerk-id');
const currentOptions = userButtonComponentMap.get(safeId);
const reorderItemsLabels = ['manageAccount', 'signOut'];
const isReorderItem = reorderItemsLabels.includes(label);

const reorderItemsLabels = ['manageAccount', 'signOut'];
const isReorderItem = reorderItemsLabels.includes(label);
let newMenuItem = {
label,
};

let newMenuItem = {
label,
};
if (!isReorderItem) {
newMenuItem = {
...newMenuItem,
mountIcon: el => {
el.innerHTML = labelIcon;
},
unmountIcon: () => {
/* What to clean up? */
},
};

if (!isReorderItem) {
newMenuItem = {
...newMenuItem,
mountIcon: el => {
el.innerHTML = labelIcon;
},
unmountIcon: () => {
/* What to clean up? */
},
};
if (href) {
newMenuItem.href = href;
} else if (open) {
newMenuItem.open = open.startsWith('/') ? open : `/${open}`;
} else if (clickIdentifier) {
const clickEvent = new CustomEvent('clerk:menu-item-click', { detail: clickIdentifier });
newMenuItem.onClick = () => {
document.dispatchEvent(clickEvent);
};
}
}

if (href) {
newMenuItem.href = href;
} else if (open) {
newMenuItem.open = open.startsWith('/') ? open : `/${open}`;
} else if (clickIdentifier) {
const clickEvent = new CustomEvent('clerk:menu-item-click', { detail: clickIdentifier });
newMenuItem.onClick = () => {
document.dispatchEvent(clickEvent);
};
userButtonComponentMap.set(safeId, {
...currentOptions,
customMenuItems: [...(currentOptions?.customMenuItems ?? []), newMenuItem],
});
}
}

userButtonComponentMap.set(safeId, {
...currentOptions,
customMenuItems: [...(currentOptions?.customMenuItems ?? []), newMenuItem],
});
</script>
Loading