Skip to content

feat: getId should accept React.Key type #725

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

Merged
zombieJ merged 1 commit into from
Jan 29, 2026
Merged

feat: getId should accept React.Key type #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions src/hooks/useId.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,13 @@ export function resetUuid() {
* @param key - The key from React element, may contain spaces or invalid characters
* @returns A valid HTML id string
*/
export function getId(prefix: string, key: string): string {
export function getId(prefix: string, key: React.Key): string {
// React.Key can be string | number, convert to string first
const keyStr = String(key);

// Valid id characters: letters, digits, hyphen, underscore, colon, period
// Replace all invalid characters (including spaces) with hyphens to preserve length
const sanitizedKey = key.replace(/[^a-zA-Z0-9_.:-]/g, '-');
const sanitizedKey = keyStr.replace(/[^a-zA-Z0-9_.:-]/g, '-');
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jan 29, 2026

Choose a reason for hiding this comment

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

medium

The current regex allows . and : characters in the generated ID. While valid in HTML IDs, these characters have special meaning in CSS selectors and can cause bugs (e.g., #my.id selects an element with id="my" and class="id").

To create safer IDs that are easier to use with tools like querySelector, I suggest replacing these special characters as well.

Note: This is a potentially breaking change and would require updating tests that expect . and : to be preserved (like on line 675 of tests/hooks.test.tsx). You would also need to update the comment on line 32 to reflect this change.

Suggested change
const sanitizedKey = keyStr.replace(/[^a-zA-Z0-9_.:-]/g, '-');
const sanitizedKey = keyStr.replace(/[^a-zA-Z0-9_-]/g, '-');


return `${prefix}-${sanitizedKey}`;
}
Expand Down
3 changes: 3 additions & 0 deletions tests/hooks.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -675,6 +675,9 @@ describe('hooks', () => {
expect(getId('btn', 'valid-key_123:456.789')).toBe(
'btn-valid-key_123:456.789',
);
expect(getId('item', 1)).toBe('item-1');
expect(getId('tab', 123)).toBe('tab-123');
expect(getId('panel', 0)).toBe('panel-0');
});
});

Expand Down
Loading