Skip to content
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.

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

Improved accuracy of IconProps interface #3848

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Conversation

amcclain
Copy link
Member

  • Use the IconName and IconPrefix types provided by FontAwesome.
  • Define a ResolvedIconProps interface, for specific usages where we know iconName and prefix have been applied and will be present.

Hoist P/R Checklist

Pull request authors: Review and check off the below. Items that do not apply can also be
checked off to indicate they have been considered. If unclear if a step is relevant, please leave
unchecked and note in comments.

  • Caught up with develop branch as of last change.
  • Added CHANGELOG entry, or determined not required.
  • Reviewed for breaking changes, added breaking-change label + CHANGELOG if so.
  • Updated doc comments / prop-types, or determined not required.
  • Reviewed and tested on Mobile, or determined not required.
  • Created Toolbox branch / PR, or determined not required.

If your change is still a WIP, please use the "Create draft pull request" option in the split
button below to indicate it is not ready yet for a final review.

Pull request reviewers: when merging this P/R, please consider using a squash commit to
collapse multiple intermediate commits into a single commit representing the overall feature
change. This helps keep the commit log clean and easy to scan across releases. PRs containing a
single commit should be rebased when possible.

- Use the `IconName` and `IconPrefix` types provided by FontAwesome.
- Define a `ResolvedIconProps` interface, for specific usages where we know `iconName` and `prefix` have been applied and will be present.
@amcclain amcclain requested a review from ghsolomon December 10, 2024 00:04
@amcclain
Copy link
Member Author

I started looking at this due to warnings being thrown around icons that turned out were actually caused by 9435122

But I had started tightening things up and still there is some utility in taking these changes. My only concern is that the use of the IconName exported type from FA might flag false-positive warnings of some kind, or require apps that are passing icon names as vars to more precisely type them. Not sure that would happen in practice though, or be a blocker - could be helpful...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant