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

Improve typing and docs recommendation #245

Merged
merged 8 commits into from
Feb 11, 2025

Conversation

mkszepp
Copy link
Collaborator

@mkszepp mkszepp commented Feb 9, 2025

During some tests inside my app, i think its better to hold the app.ts file cleaner and moving setups to an extra file like we did before.

In additional we need to allow passing IconDefinition as @icon to component.
We have already a use case for that inside test-app and maybe peoples were already using it.
Passing IconDefinition is very interesting, when consumer apps are using template-tag (strict mode) in ember (which is part of polaris edition and can be used already), because this make at the end the font-awesome.ts nearly unnecessary (just the setup for faConfig.autoAddCss = false; is needed.
Its more a choise for consumer apps, if they want register icons and consume with string or importing icon directly at each point.

Changes in this PR:

  • Improve typing inside icon component
  • allow passing IconDefinition
  • Update docs setup and apply changes to test-app
  • Add note for passing IconDefinition

@mkszepp
Copy link
Collaborator Author

mkszepp commented Feb 9, 2025

@robmadole these are the final changes. Once this is merged, we’ll be ready for release.

Before merging, I’ll update the release date in the changelog.

Let me know if you’d like to add or change anything before we proceed with the release.

@mkszepp
Copy link
Collaborator Author

mkszepp commented Feb 11, 2025

Added installation for using inside .gjs/.gts and marked as recommended installation way, as there was someone asking how it works with v2 #246

@mkszepp mkszepp merged commit c83fa27 into 3.x Feb 11, 2025
16 checks passed
@mkszepp mkszepp deleted the improve-typing-and-docs-recommendation branch February 11, 2025 06:49
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.

2 participants