react-icon-components v0.0.1
React Icon Components
A design system can also incorporate a full set of Icons.
To automatically create the source code for icon web components for a full folder of SVG files, this plugin comes in handy. Just add it to your stencil project and generate the icons.
Install
npm install react-icon-componentsAdd a command (script) to your package.json to create the components like;
scripts: {
...
"build:icons": "react-icon-components --src assets/icons --dest src/components/icons",
...
}Options
| option | description | default |
|---|---|---|
--src | Source folder with SVG files | /src/assets/icons |
--dest | Destination folder for components | /src/components/icons |
--prefix | Add a prefix to all files, ex; social-network.svg becomes icon-social-network | false |
--remove-old | Remove the whole destionation folder as set. In order to be sure to not have any old files and create everything new. Don't set this if your destination folder also includes files which arent generated. | false |
Wishlist
- Add option to automatically cleanup the svg files.
- Add option to remove fills/colors
- Add option for custom template files.
Contributing
Any help to make this package better is very welcome! So if you like this idea and have a good idea for refactor, update, write better docs or add features. Please feel free to contact me or just make a PR.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
Author
react-icon-components © Sil van Diepen, Released under the MIT License. Authored and maintained by Sil van Diepen with help from contributors (list).
github.com/silvandiepen · GitHub @Sil van Diepen · Twitter @silvandiepen
4 years ago