aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcodecalm <codecalm@gmail.com>2021-11-18 00:49:42 +0100
committercodecalm <codecalm@gmail.com>2021-11-18 00:49:42 +0100
commit3d90a83aed61951b018edfff33d8c8887cc31e97 (patch)
treeb8d54e53ac1f6f034fb4b3208c694cec0a0355f2
parentFixed icon: `currency-dogecoin` (diff)
parentMerge pull request #166 from pierreavn/patch-1 (diff)
downloadtabler-icons-3d90a83aed61951b018edfff33d8c8887cc31e97.tar.xz
Merge remote-tracking branch 'origin/master'
-rw-r--r--README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
index eb0e8e03..7a1d3cfa 100644
--- a/README.md
+++ b/README.md
@@ -119,6 +119,47 @@ const MyComponent = () => {
`@tabler/icons` exports it's own type declarations for usage with React and Typescript.
+### Angular
+
+Angular components available through [`angular-tabler-icons`](https://www.npmjs.com/package/angular-tabler-icons) package.
+Install the package, then create icons 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 { }
+```
+
+After importing the _IconsModule_ in your feature or shared module, use the icons as follows:
+
+```html
+<i-tabler name="camera"></i-tabler>
+<i-tabler name="heart" style="color: red;"></i-tabler>
+<i-tabler name="brand-github" class="someclass"></i-tabler>
+```
+
+`angular-tabler-icons` exports it's own type declarations for usage with Typescript.
+
+For more usage documentation refer to [the official documentation](https://github.com/pierreavn/angular-tabler-icons).
+
### Vue
Vue components available through [`vue-tabler-icons`](https://www.npmjs.com/package/vue-tabler-icons) package.