Skip to content

Document temporary DOM query workaround in ButtonBase useLayoutEffect #7404

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
Copilot wants to merge 2 commits into from
Closed

Document temporary DOM query workaround in ButtonBase useLayoutEffect #7404

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8973924
Initial plan
Copilot Dec 30, 2025
a41d428
Add TODO comment to useLayoutEffect in ButtonBase.tsx
Copilot Dec 30, 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/react/src/Button/ButtonBase.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@ const ButtonBase = forwardRef(({children, as: Component = 'button', ...props}, f
const ariaDescribedByIds = loading ? [loadingAnnouncementID, ariaDescribedBy] : [ariaDescribedBy]

// Check if button contains a keyboard shortcut hint and add data attribute for styling
// TODO: This useLayoutEffect detects [data-kbd-chord] descendants to set data-has-kbd.
// This is a workaround because trailingVisual is opaque and we can't know at render time
// if it contains a KeybindingHint. Ideally, we'd have an explicit prop (e.g., hasKeybindingHint)
// that consumers set, eliminating the need for this runtime DOM query.
// See: https://github.com/primer/react/pull/7402
React.useLayoutEffect(() => {
if (innerRef.current) {
const hasKbd = innerRef.current.querySelector('[data-kbd-chord]') !== null
Expand Down