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.
npm install icon-components
Add a command (script) to your package.json to create the components like;
scripts: {
...
"build:icons": "icon-components --src assets/icons --dest src/components/icons --template react",
...
}
option | description | default |
---|---|---|
--src |
Source folder with SVG files | /src/assets/icons |
--dest |
Destination folder for components | /src/components/icons |
--type |
Choose output type. Options; stencil, react, material | |
--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 |
--list |
In many cases it can come in handy to also create a list of all components. This can be created by setting --list. If set, it will create a default list. It can also contain a path to a template, in that case the template will be used for the list. | false |
--in-root |
By default there a folders created for every component. In case you want all files just to be in the root dest. You can enable --in-root |
false |
At the moment, one command can have one custom template file. The template file can be created in your own project and be used in the CLI.
In the template you can use EJS template strings. The file which will be written will have the same extension as your template file and be written in the set --dest
.
Option | description |
---|---|
og_name | Original name of the file |
name | Name of the Svg Icon |
title | Title of the Svg Icon in PascalCase |
title_lowercase | A lowercase version of the title |
componentName | A PascalCase version of the title |
data | The svg icon file data |
data_clean | Cleaned up version of the data |
data_stripped | When given strip options, this is the stripped data |
You can, if you want. Add .template
at the end of the file, because it won't be a valid javascript file anyway. The .template
part will be automatically removed.
For instance; your template file is called. my-icon-template.js.template
In this case. The files will have .js
extension.
In many cases it can come in handy to also create a list of all components. This can be created by setting --list
. If set, it will create a default list. It can also contain a path to a template, in that case the template will be used for the list.
Default template for list;
{
"icons": [<% files.forEach(function(file,index) { %>
"<%= file %>"<% if(index < files.length -1){ %>,<% } %>
<% }); %>]
}
You can create your own list template by setting the first argument to --list
a path to the template. In that case that template will be used for the list and written in the default destination folder.
- Add option to automatically cleanup the svg files.
- Add option to remove fills/colors
- Add option for custom template files.
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
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