ionic-team / ionic-team/ionicons
docs: document addIcons usage
- Dominant language
- TypeScript
- Stars
- 18.2k
- Forks
- 2.1k
- PR merge metrics
- No merged PRs in 30d
Description
Some users have expressed an interest in using functionality provided by addIcons, so it would be good to document its usage.
Use Case: https://github.com/ionic-team/ionic-framework/issues/22181 A developer wants to dynamically show an icon based upon results from a server. They could do `(result) ? heart : heartOutline`, but they do not want to have to continually import each icon. In this case, it would be helpful for them to add the icon globally via `addIcons`.
Contributor guide
Research direction
Start by locating the addIcons entry point and the existing Ionicons usage documentation. Document how users can register icons globally for dynamic use, including the server-driven use case described in the issue; done means the addIcons workflow is explained clearly enough to follow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100