This package allows you to use the Tabler Icons in your angular applications. Tabler Icons is a set of free MIT-licensed high-quality SVG icons for you to use in your web projects. Each icon is designed on a 24x24 grid and a 2px stroke.
Inspired by angular-feather, thank you to the author.
1. Install the package
npm install angular-tabler-icons
# or
yarn add angular-tabler-icons
2. Generate a module to host the icons you'll import
ng generate module icons
3. Import assets
You need to import:
- TablerIconsModule, as it contains the
<i-tabler>
component - The icons that you need
We put this in IconsModule for modularity. See example below:
file: icon.module.ts
import { NgModule } from '@angular/core';
import { TablerIconsModule } from 'angular-tabler-icons';
import { IconCamera, IconHeart, IconBrandGithub } from 'angular-tabler-icons/icons';
// Select some icons (use an object, not an array)
const icons = {
IconCamera,
IconHeart,
IconBrandGithub
};
@NgModule({
imports: [
TablerIconsModule.pick(icons)
],
exports: [
TablerIconsModule
]
})
export class IconsModule { }
// NOTES:
// 1. We add TablerIconsModule to the 'exports', since the <i-tabler> component will be used in templates of parent module
// 2. Don't forget to pick some icons using TablerIconsModule.pick({ ... })
4. Use it in template
After importing the IconsModule in your feature or shared module, use the icons as follows:
<i-tabler name="camera"></i-tabler>
<i-tabler name="heart" style="color: red;"></i-tabler>
<i-tabler name="brand-github" class="someclass"></i-tabler>
List of available icons: https://tabler-icons.io/
This version includes Tabler Icons v2.40.0, see changelog to know which icons are available.
Each icon can be styled separately with CSS:
<i-tabler name="camera" class="big fill-red stroke-blue thin"></i-tabler>
.big {
height: 50px;
width: 50px;
}
.fill-red {
fill: red;
}
.stroke-blue {
color: blue;
}
.thin {
stroke-width: 1px;
}
Some options are available to configure the module:
import { environment } from '../environments/environment';
import { TablerIconsModule } from 'angular-tabler-icons';
import * as TablerIcons from 'angular-tabler-icons/icons';
@NgModule({
imports: [
TablerIconsModule.pick(TablerIcons, {
// Ignore warnings, such as "Tabler Icon not found"
ignoreWarnings: true,
ignoreWarnings: environment.production,
})
],
exports: [
TablerIconsModule
]
})
export class IconsModule { }
You can import all icons at once by doing the following. However, keep in mind that by doing this, all icons will end up in your application bundle. While this may not be much of an issue for prototyping, it is not recommended for any application that you plan to release.
import { TablerIconsModule } from 'angular-tabler-icons';
import * as TablerIcons from 'angular-tabler-icons/icons';
@NgModule({
imports: [
TablerIconsModule.pick(TablerIcons)
],
exports: [
TablerIconsModule
]
})
export class IconsModule { }
Angular | angular-tabler-icons |
---|---|
16 | 2.21.1+ |
15 | 1.117.1+ |
14 | 1.72.1+ |
13 | 1.53.1+ |
12 | 1.41.3+ |
11 | 1.41.0+ |
Feel free to report issues or to contibute to this project!
Here are few tips to start:
$ yarn lib:generate # generate components from Tabler Icons
$ yarn lib:build # build angular library
- Run GitHub actions workflow
Automatic PR on Tabler Icons Release
, with new Tabler Icons version (e.g.1.117.0
). This workflow will create automatically a new Pull Request. - Approve and Merge the generated Pull Request.
- Create a release/tag with the new Tabler Icons version.
Package is automatically rebuilt and published, with the GitHub actions workflow Build and Publish package
.