aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaweł Kuna <1282324+codecalm@users.noreply.github.com>2021-11-03 13:02:57 +0100
committerGitHub <noreply@github.com>2021-11-03 13:02:57 +0100
commitee4ce52666f7c69c15ff207bade09a9a399df8c5 (patch)
treef6c579dab63edde57e63ae74a1d1011dbee6c13d /README.md
parentRelease 1.41.2 (diff)
parentAdd reference to the Vue components library. (diff)
downloadtabler-icons-ee4ce52666f7c69c15ff207bade09a9a399df8c5.tar.xz
Merge pull request #124 from alex-oleshkevich/document-vue-lib
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index 84ceab2b..e37383f0 100644
--- a/README.md
+++ b/README.md
@@ -105,6 +105,30 @@ const MyComponent = () => {
`@tabler/icons` exports it's own type declarations for usage with React and Typescript.
+### Vue
+
+Vue components available through [`vue-tabler-icons`](https://www.npmjs.com/package/vue-tabler-icons) package.
+Install the package, import the icon component and render it in your component. You can adjust SVG properties by passing regular HTML attributes:
+
+```html
+<script>
+ // MyComponent.vue
+ import { BoldIcon } from 'vue-tabler-icons';
+
+ export default {
+ components: { BoldIcon },
+ };
+</script>
+
+<template>
+ <bold-icon />
+</template>
+```
+
+`vue-tabler-icons` exports it's own type declarations for usage with Typescript.
+
+For more usage documentation refer to [the official documentation](https://github.com/alex-oleshkevich/vue-tabler-icons).
+
### CDN
All files included in `@tabler/icons` npm package are available over a CDN.