@rdlabo/ionic-angular-collect-icons

What is this?

This library is used to uniquely group the ionIcons in a project, and generate for export ionIcons file. In small projects, it is difficult to manage addIcons() of ionIcons each time, so we automated it.

• development: Stress-free development by add all icons at addIcons.
• Production: Automatically collect and update the ionIcon used in the template prior to build.

Of course, to maximize bundle size reduction, it is important to load a minimum number of icons at each Component lazy loading. This is a compromise to speed up development.

This project is based ionic-team/ionic-angular-standalone-codemods .

Requirements

• Node.js >= 22
• Ionic Angular >= 9.0.0
• Angular >= 18.0.0
• TypeScript >= 5.4.0
• ionicons >= 8.0.0
• @angular-eslint/template-parser 21 or 22

Quick start

After Installation, initialize addIcons and collect icons before production builds:

npx @rdlabo/ionic-angular-collect-icons --initialize true

Details: Initialize and Usage.

Migrating from Ionic Angular 8

Commit the consuming application's current changes, then run Ionic's official migration tool from the application root:

npx @ionic/migrate

It applies safe automatic changes and reports items that require manual review. After it finishes, update this package and follow the Ionic Angular 9 migration guide for the remaining checks.

Installation

npm install --save-dev \
  @rdlabo/ionic-angular-collect-icons \
  @angular-eslint/template-parser@^21

Use @angular-eslint/template-parser@^22 instead when the consuming project uses Angular ESLint 22. The parser is a peer dependency so the collector uses the same Angular template parser major as the consuming project.

Documentation

Start with Installation, then Initialize and Usage.

• Initialize — wire addIcons automatically or by hand.
• Usage — run the collector before production builds.
• Migration — migrate an existing project to Ionic Angular 9.
• CLI Options — --dry-run, --initialize, paths.
• FAQ — tests, binding, and main.ts.

Full documentation: https://docs.rdlabo.dev/projects/ionic-angular-collect-icons

License

This project is licensed under the MIT License.