aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoralex.oleshkevich <alex.oleshkevich@gmail.com>2021-04-19 11:12:40 +0300
committeralex.oleshkevich <alex.oleshkevich@gmail.com>2021-04-19 11:12:40 +0300
commit36aacbf044b582a3a64ede4299f461d22999de45 (patch)
treeab79d5f0dc3a62af5b6584cd6f28574fa1c27f7d /README.md
parentnew version fix (diff)
downloadtabler-icons-36aacbf044b582a3a64ede4299f461d22999de45.tar.xz
Add reference to the Vue components library.
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.