aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPierre Avinain <8176955+pierreavn@users.noreply.github.com>2021-11-16 19:16:39 +0100
committerGitHub <noreply@github.com>2021-11-16 19:16:39 +0100
commitd50e0901ed43dee7ed6254c285ccd3296e31f469 (patch)
tree64d05e881aceb6af3d82a4a1daad7bec81954b36 /README.md
parentMerge pull request #163 from kicaj/patch-1 (diff)
downloadtabler-icons-d50e0901ed43dee7ed6254c285ccd3296e31f469.tar.xz
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
index f5366223..3dd4f493 100644
--- a/README.md
+++ b/README.md
@@ -105,6 +105,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.