https://github.com/rinminase/ng-fortawesome
🎨⭐ Reduce your project dependencies when using @fortawesome/angular-fortawesome.
https://github.com/rinminase/ng-fortawesome
List: ng-fortawesome
angular circleci fortawesome ng-fortawesome npm-package
Last synced: 3 months ago
JSON representation
🎨⭐ Reduce your project dependencies when using @fortawesome/angular-fortawesome.
- Host: GitHub
- URL: https://github.com/rinminase/ng-fortawesome
- Owner: RinMinase
- License: mit
- Created: 2020-02-13T17:20:41.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-01T17:59:28.000Z (almost 4 years ago)
- Last Synced: 2024-05-21T16:11:17.529Z (about 2 years ago)
- Topics: angular, circleci, fortawesome, ng-fortawesome, npm-package
- Language: TypeScript
- Homepage:
- Size: 1.52 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Angular Fortawesome Dependencies
## Introduction
Reduce your project dependencies when using `@fortawesome/angular-fontawesome`.
This library removes `svg-core` as its peer dependency. This also includes imports for `brand`, `regular` and `solid` icons.
## Versions used
| Dependencies | Version | Import Shorthand |
| ------------------------- | -------- | ------------------ |
| `angular-fontawesome` | v0.9.0 | |
| `fontawesome-svg-core` | v1.2.35 | |
| `free-brands-svg-icons` | v5.15.3 | fab |
| `free-regular-svg-icons` | v5.15.3 | fa |
| `free-solid-svg-icons` | v5.15.3 | fas |
## Usage & Demo
### Installation
1. You can install ***ng-fortawesome*** using npm
```bash
npm install @rinminase/ng-fortawesome
```
2. Add it on your module, like so
```typescript
import { FontAwesomeModule } from "@rinminase/ng-fortawesome";
@NgModule({
imports: [
...,
FontAwesomeModule,
]
})
```
3. Declare it in your component, like so
```typescript
import { fasPlus, faEdit, fabGithub } from "@rinminase/ng-fortawesome";
export class SomeComponent implements OnInit {
fasPlus = fasPlus;
faEdit = faEdit;
fabGithub = fabGithub;
onInit() {
...
}
}
```
4. Use it on your template, like so
```html
```
## FAQ
### Why re-create this library when there is already an existing one?
- The existing library doesn't seem to remove `svg-core` as its peer dependency, but needs it for both `brands-svg`, `regular-svg` and `solid-svg`. I seem to see the need to remove the additional library installed for your project and have this library install it instead. This library aims to reduce the number of dependencies listed in your package file.
Instead of:
```npm install @fortawesome/angular-fontawesome @fortawesome/fontawesome-svg-core @fortawesome/free-brands-svg-icons @fortawesome/free-regular-svg-icons @fortawesome/free-solid-svg-icons```
I wanted to do it this way:
```npm install @rinminase/ng-fortawesome```
Which only adds one dependency in your project depencies instead of five.
### Will this library be updated when any of its dependencies updates?
- Yes. This is updated whenever `angular-fontawesome`, `brands-svg`, `regular-svg`, `solid-svg` or `svg-core` updates.
## Built with
* 
[Angular 12](https://angular.io/) - Library setup
* 
[TypeScript](https://www.typescriptlang.org/) - Language syntax
* 
[NodeJS](https://nodejs.org/) - Environment
* 
[Circle CI](https://circleci.com/) - Continuous Integration (CI) service
* 
[Semantic Release📦🚀](https://semantic-release.gitbook.io/) - Releasing strategy