antfu/unplugin-icons
Unplugin Icons
unplugin-icons is a universal icon component provider and build-time asset optimizer that transforms diverse SVG libraries into a unified cross-framework interface. It functions as an SVG icon pipeline, converting thousands of icons from various sets into on-demand components or raw strings for use across different frontend frameworks.
The tool provides a cross-framework icon library that optimizes bundle sizes by exclusively including the specific icons referenced in the source code. It further simplifies the development workflow through automatic icon importing and the use of aliases to map long collection names to shorter identifiers.
The system manages SVG components by allowing the loading of custom icon sets and the application of global transformations. It also includes visual configuration capabilities to customize icon size and color through global settings or query parameters.
Features
- Cross-Framework Providers - Provides a universal system to transform diverse SVG libraries into on-demand components for multiple frontend frameworks.
- Icon Set Integrations - Integrates thousands of icons from diverse libraries as consistent components across various frontend frameworks.
- Bundle Size Optimization - Reduces bundle size by extracting only the specific icons referenced in the source code.
- SVG Asset Pipelines - Implements a comprehensive pipeline for importing, transforming, and optimizing SVG assets into UI components.
- SVG Icon Components - Converts icons from various sets into reusable components compatible across different UI frameworks.
- Icon Libraries - Provides a unified interface for accessing multiple icon sets as components across different environments.
- Frontend Asset Optimization - Reduces final bundle sizes by loading only the specific icons used in the source code.
- Build-Time Component Generation - Transforms icon data into framework-specific components during the build process based on import statements.
- SVG Component Transformations - Converts raw SVG paths and attributes into valid framework components during the build process.
- Tree-Shakeable Icon Bundles - Ensures only referenced icons are included in the final bundle to minimize asset size.
- Icon Appearance Customizations - Modifies icon size, color, and visual attributes via global configuration and query parameters.
- Automatic Component Imports - Automatically injects referenced icons into templates to eliminate the need for explicit import statements.
- Icon Alias Mappings - Provides a lookup table to map short identifiers to full icon collection names during module resolution.
- Virtual Modules - Intercepts module requests to provide dynamic icon components without requiring physical files on disk.
- Collection Aliasing - Maps long icon collection names to short identifiers to simplify imports within a project.
- Import URL Parameter Injection - Allows modifying generated icon components by parsing parameters passed within the import URL string.
- Build-Time Icon Transformations - Applies global modifications to custom icons during the loading phase to ensure visual consistency.
- Asset Loaders - Accesses icon sets as components.
- Icon Frameworks and Utilities - A plugin for on-demand icon loading in modern build tools.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
