Yummy Icons
A npm package with the Yummy Icon.
Installation
1. Add the library to your project
npm i yummy-iconsyarn add yummy-icons2. Reference the fonts on the HTML's head
Usage
Cheat Sheet
For details and embeddings codes, click here.
Configuration
The following variables are allowed to be set externally:
| Variable | Description | Default value |
|---|---|---|
| $yummy-icon-selector | Defines main icon selector | yummy-icon |
| $yummy-icon-slug | Defines the icon selector | yi |
| $yummy-icon-font-path | Defines the fonts' path | web-fonts |
Sass configuration (Angular)
On your /src/app/app.scss file, add:
Ionic 3 configuration
1. Add to config/sass.config.js:
... /** * includePaths: Used by node-sass for additional * paths to search for sass imports by just name. */ includePaths: 'node_modules/ionic-angular/themes' 'node_modules/ionicons/dist/scss' 'node_modules/ionic-angular/fonts' 'node_modules/yummy-icons/src/sass' //add this line.. ...2. Add to config/copy.config.js:
... copyFonts: src: '{{ROOT}}/node_modules/ionicons/dist/fonts/**/*' '{{ROOT}}/node_modules/ionic-angular/fonts/**/*' '{{ROOT}}/node_modules/yummy-icons/dist/web-fonts/**/*' //and this! dest: '{{WWW}}/assets/fonts' ...How to contribute
- Bug reports and pull requests are welcome on GitHub
- Follow the Semantic Versioning Specification
- Follow the GitHub Flow
- Follow the 5 Useful Tips For A Better Commit Message article and the How to Write a Git Commit Message post
- Use Commitizen cli when committing
Code of Conduct
Everyone interacting in the Yummy-Icons project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
License
The package is available as open source under the terms of the CC BY-SA 4.0.
Copyright
(c) Designed by medisculpt. Licensed under the CC BY-SA 4.0.