ionicons icon indicating copy to clipboard operation
ionicons copied to clipboard

Improve documentation on how to use Ionicons

Open christian-bromann opened this issue 11 months ago • 3 comments

Current Behavior

Going through the issues I've seen the following theme that mostly indicates a lack of documentation on how to use Ionicons properly:

  • https://github.com/ionic-team/ionicons/issues/877
  • differentiate between lazy build and custom element, maybe remove lazy all together, refs #1441
  • document how to integrate into Angular #1340
  • document how to integrate into Reach https://github.com/ionic-team/ionicons/issues/835
  • document how to integrate into Vue https://github.com/ionic-team/ionicons/issues/1043
  • document how to integate when using esbuild #1435
  • integration into storybook
  • bundling icons for offline use #821
  • Using with a bundle https://github.com/ionic-team/ionicons/issues/1133, https://github.com/ionic-team/ionicons/issues/648, https://github.com/ionic-team/ionicons/issues/774, https://github.com/ionic-team/ionicons/issues/751
  • document how to enable SSR support (https://github.com/ionic-team/ionicons/issues/1404, https://github.com/ionic-team/ionicons/issues/886)
  • usage of custom icons https://github.com/ionic-team/ionicons/issues/535, https://github.com/ionic-team/ionicons/issues/1013, https://github.com/ionic-team/ionicons/issues/589

Expected Behavior

Update the documentation to respect modern stacks and tools. Make changes in necessary to improve the DX.

Steps to Reproduce

n/a

Code Reproduction URL

No response

Additional Information

No response

christian-bromann avatar Apr 16 '25 22:04 christian-bromann

Okay, so... how do we use this in a modern stack? I can't seem to get the icons to render via a JS import, no matter what I try.

dkniffin avatar Sep 30 '25 21:09 dkniffin

@christian-bromann @brandyscarney Any advice here? I'm about to integrate this library into a new project, and I'd really like to not have to point at a CDN if I can help it

dkniffin avatar Oct 31 '25 14:10 dkniffin

Hello @dkniffin! Does this approach work for you? https://stackblitz.com/edit/55byg2fg?file=index.ts

brandyscarney avatar Nov 12 '25 19:11 brandyscarney