G
gregberge/svgr
Svgr
SVGR is a tool that transforms static SVG files into reusable React components for direct rendering within user interface trees. It functions as an AST-based code transformer and build-time asset pipeline, parsing SVG XML into an abstract syntax tree to modify elements before generating JavaScript source code.
The project integrates an external optimization engine to strip redundant metadata and minify attributes, ensuring vector images are flexible and easy to style. It uses recursive tree traversal to apply these transformations to all nested graphic elements and employs attribute mapping to translate SVG properties into compatible component props.
This transformation layer integrates into frontend asset pipelines to convert vector graphics into programmable code during the project compilation phase.
Features
- React Component Generators - Provides a CLI and build-tool integration to transform raw vector graphics into optimized React components.
- AST-Based Source Transformations - Implements AST-based transformations to convert SVG XML nodes into JavaScript source code.
- Build-Time Asset Processing - Provides a build-time pipeline that processes static vector graphics into programmable UI components.
- Frontend Asset Pipelines - Integrates scalable vector graphics into the frontend asset pipeline as programmable code instead of static files.
- Build-Time Transformation Tools - Provides a build-time transformation layer to convert vector graphics into programmable React code during compilation.
- AST Transformation Pipelines - Implements a transformation pipeline that parses SVG XML into an AST for programmatic modification.
- Design-to-Code Workflows - Automates the transition of SVG design assets into a manageable library of React components.
- SVG Component Transformations - Transforms static SVG files into reusable React components for direct rendering within user interfaces.
- Asset Optimization - Integrates an external minification engine to optimize and strip redundant metadata from SVG assets.
- SVG Optimization - Optimizes SVG attributes during transformation to ensure vector images remain flexible and styleable.
- Template-Based Code Generators - Employs customizable string templates to wrap transformed SVG elements into valid React component definitions.
- SVG Asset Optimizations - Cleans and minifies SVG attributes to ensure images are lightweight and easy to style with CSS.
- SVG Attribute Optimizations - Adjusts specific SVG property values to ensure visual elements remain flexible and easy to style.
- Document Tree Traversers - Uses recursive document tree traversal to apply attribute changes and transformations to nested graphic elements.
- SVG Attribute Mappings - Translates kebab-case SVG attributes into compatible camelCase React props using predefined mapping rules.
- React Animation Libraries - Tool for transforming SVGs into React components.
