Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pjlamb12/angular-svg-icon-preloader
Angular service that preloads a JSON list of SVG icons for use with the angular-svg-icon library
https://github.com/pjlamb12/angular-svg-icon-preloader
Last synced: 12 days ago
JSON representation
Angular service that preloads a JSON list of SVG icons for use with the angular-svg-icon library
- Host: GitHub
- URL: https://github.com/pjlamb12/angular-svg-icon-preloader
- Owner: pjlamb12
- License: mit
- Created: 2020-12-07T21:14:42.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-02T05:27:49.000Z (6 months ago)
- Last Synced: 2024-11-24T12:55:48.717Z (about 1 month ago)
- Language: TypeScript
- Size: 3.08 MB
- Stars: 11
- Watchers: 3
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[]()
[]()
[]()
[](https://github.com/prettier/prettier)
[](#contributors-)
Angular SVG Icon Preloader is a library to be used in conjunction with the [angular-svg-icon library](https://www.npmjs.com/package/angular-svg-icon). The purpose is to allow you to provide a JSON file of icons that you will use frequently enough that they can be preloaded when the app bootstraps. You can still load icons after the app bootstraps the same way angular-svg-icon provides; this is just another way of loading the icons.
## Features
- ✅ Preload icons as files or SVG icon data
- ✅ Use the icons as soon as the app loads without having to manually load the icon
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
## Installation
### NPM
`npm install angular-svg-icon-preloader`
### Yarn
`yarn add angular-svg-icon-preloader`
## Usage
For the library to work, you need to first create a JSON file somewhere that your app can load. The easiest location is in the app's `assets` folder. The JSON file should have two top level attributes:
- `iconImageFiles`: an array of `IconImageFile` items. These items have two attributes each, `iconName` and `iconPath`. Both are strings. `iconName` is how you'll refer to the icon later in your app. `iconPath` is the URL to the SVG image file. This can be in the app's asset folder, or anywhere else that your app has access to reference SVG images.
- `customIcons`: an array of `CustomIconData` items. These items have two attributes each, `iconName` and `iconData`. Both are strings. `iconName` is how you'll refer to the icon later in your app. `iconData` is the SVG code that would go in your HTML file if you were using the raw SVG.
These arrays can have any number of icons in them, and they'll all be loaded automatically when the app bootstraps for you. Here's an example `icons.json` file:
```json
{
"iconImageFiles": [
{
"iconName": "badge-check",
"iconPath": "/assets/icons/badge-check.svg"
}
],
"customIcons": [
{
"iconName": "academic-cap",
"iconData": " "
}
]
}
```
Once you've defined your JSON file with the icon information, just import the angular-svg-icon library and this library in your `AppModule`. Make sure to provide the path to the icons JSON file in the `forRoot` method of the `AngularSvgIconPreloaderModule`'s `forRoot` method:
```ts
@NgModule({
imports: [
AngularSvgIconModule.forRoot(), // angular-svg-icon library module
AngularSvgIconPreloaderModule.forRoot({
configUrl: './assets/json/icons.json',
}),
]
})
```
At this point, everything is done. To use the `academic-cap` icon in the above mentioned `customIcons` array, you only need to use the `svg-icon` component from `angular-svg-icon`:
```html
```
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
