ngx-tabler-icons
TypeScript icon, indicating that this package has built-in type declarations

2.0.1 • Public • Published

Ngx Tabler Icons

Welcome to the NgxTablerIcons library! This library allows you to effortlessly incorporate Tabler Icons within your Angular applications, enhancing your app's user interface with aesthetically pleasing, vector-based icons.


Important:

At first glance, the library may seem hefty, but it's important to note that it contains all 4018 icons from Tabler Icons. However, rest assured that this library is fully tree-shakable. In your final bundle, only the icons that you actually use will be included, which helps to optimize the size and performance of your applicat


Angular version compatibility

Angular ngx-tabler-icons
14-16 1.0.0
17 2.x

Acknowledgements

I would like to express our deepest gratitude to the Tabler Icons team for creating and providing such a diverse and beautiful set of icons. The elegance and simplicity of Tabler Icons significantly enrich the user experience of our library, making the visual interface more engaging and intuitive.

Features

  • Easily integrate Tabler Icons in your Angular projects.
  • Explore a wide range of icons to match your app’s design.
  • SVG-based icons ensure a crisp display on all screen sizes and resolutions.
  • Customizable icon size, color, and other SVG properties.
  • All the icons from https://tabler-icons.io are available.

Usage

1. Install the package

npm install ngx-tabler-icons
# or
yarn add ngx-tabler-icons

# or
pnpm install ngx-tabler-icons

2. Import the icon that you want to use

@NgModule({
  imports: [ITabler2faModule],
})
export class Module {}
@Component({
  standalon: true,
  imports: [ITabler2faModule],
})
export class Component {}

3. Use it in your template

<i-tabler-2fa></i-tabler-2fa>

4. Attributes

Attribute Description Default value
size Set the height and width of the icon 24
strokeWidth Set the stroke width of the icon 1.5

5. If you want to change the default strokeWidth of all the icons, you just need to provide the following value in your app.module.ts

@NgModule({
  ...
  providers: [{ provide: 'TABLER_ICON_STROKE_WIDTH', useValue: 3 }],
  ...
})

To build the icons

If Tabler Icons releases a new version of their library with additional icons, follow these steps to update and generate the icons:

  1. Visit the Tabler Icons website.
  2. Locate and download the latest JSON file containing the icon data.
  3. Replace the content of the icons.json file with the downloaded JSON data.
  4. Execute the command ./generate-icons.sh in your terminal or command prompt.
  5. Once the command runs successfully, the new icons will be generated and ready for use.

Contributing

Feel free to contribute to this project by submitting issues or pull requests. We appreciate your feedback and support in making this library better!

Package Sidebar

Install

npm i ngx-tabler-icons

Weekly Downloads

6

Version

2.0.1

License

MIT

Unpacked Size

57.4 MB

Total Files

9644

Last publish

Collaborators

  • hernan__giraldo