[LG-3416] feat: Icon - added title element #3245
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 2ef518f The changes in this PR will be included in the next version bump. This PR includes changesets to release 73 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
|
Size Change: +176 kB (+10.86%) Total Size: 1.8 MB
ℹ️ View Unchanged
|
adamrasheed
changed the title
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR implements native tooltip support for icons by adding a <title> SVG element when a title prop is provided, improving accessibility in accordance with LG-3416.
Key changes:
- Icons now render a
<title>element inside the SVG when thetitleprop is passed - Accessibility handling updated to use
aria-labelledbyreferencing the title element's ID instead of the HTMLtitleattribute - Build system refactored to generate icon components directly rather than wrapping them with
createGlyphComponent
Reviewed Changes
Copilot reviewed 15 out of 200 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/icon/src/glyphCommon.ts | Updated accessibility prop generation to handle title element with ID and aria-labelledby |
| packages/icon/src/Icon.spec.tsx | Added tests for title element rendering and aria-labelledby behavior |
| packages/icon/scripts/prebuild/svgrTemplate.ts | Modified template to inject title element and useIdAllocator hook into generated components |
| packages/icon/src/glyphs/index.ts | Removed dynamic component creation, now exports raw SVG components |
| packages/icon/scripts/prebuild/indexTemplate.ts | Added new template for generated component exports |
| packages/icon/scripts/prebuild/index.ts | Added generation of index file for component exports |
| packages/icon/src/Icon.tsx | Changed import to use generated components directly |
| packages/icon/src/createGlyphComponent.tsx | Marked as deprecated, updated to support new title functionality |
| packages/icon/scripts/build/compare-checksum.ts | Excluded index file from icon name collection |
| packages/icon-button/src/IconButton/IconButton.spec.tsx | Updated test to verify title element instead of title attribute |
| packages/icon/package.json | Added @leafygreen-ui/hooks dependency |
| packages/icon/tsconfig.json | Added hooks package reference |
| packages/icon/src/Icon.stories.tsx | Exposed title control in Storybook |
| .changeset/puny-paws-yell.md | Documented the feature addition |
| packages/emotion/src/version.ts | Version bump |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
shaneeza
reviewed
Oct 29, 2025
shaneeza
reviewed
Oct 29, 2025
shaneeza
reviewed
Oct 29, 2025
shaneeza
reviewed
Oct 29, 2025
shaneeza
reviewed
Oct 29, 2025
shaneeza
reviewed
Oct 29, 2025
shaneeza
reviewed
Oct 29, 2025
shaneeza
reviewed
Oct 29, 2025
shaneeza
reviewed
Oct 30, 2025
shaneeza
reviewed
Oct 30, 2025
shaneeza
reviewed
Oct 30, 2025
| import { LGGlyph, SVGR } from './types'; | ||
|
|
||
| /** | ||
| * @deprecated - No longer needed for icon generation. Keeping it for backwards compatibility. |
Collaborator
There was a problem hiding this comment.
I just remembered that this is being used in other components and by consumers, so I'm not sure if we want to deprecate it. If you check out the readme, we encourage consumers to use this util to create a custom glyph that behaves like a leafygreen icon.
Collaborator
There was a problem hiding this comment.
Might be worth bringing this up in slack with the team to see if we want to continue to support this.
Collaborator
Author
There was a problem hiding this comment.
Will do! I originally synced with @TheSonOfThomp before he went on PTO and we agreed that we can mark this as deprecated. I wasn't aware we were encourage consumers to actively use it. But good idea, I'll bring it up with the team :)
Collaborator
There was a problem hiding this comment.
That's a good callout @shaneeza. The reason we initially decided to deprecate was because this is doing the same thing as the prebuild step, but differently (notably, we don't inject the <title> element in this function)
I agree with Shaneeza that we should probably keep this un-deprecated for now, and look into ways to consolidate and DRY the prebuild steps and this function.
@adamrasheed I don't think DRY-ing should hold back this PR. Could you open a ticket and replace the @deprecated with a note on how this differs from prebuild + a link to that ticket?
TheSonOfThomp
approved these changes
Nov 3, 2025
Contributor
|
Coverage after merging ar/LG-3416-icon-title into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✍️ Proposed changes
🎟 Jira ticket: Add native tooltip on icons
This PR updates the icon component to include a
<title>element inside the SVG when a title prop value is passed in✅ Checklist
For new components
For bug fixes, new features & breaking changes
pnpm changesetand documented my changes🧪 How to test changes