mirror of
https://github.com/tabler/tabler.git
synced 2026-08-14 23:32:25 +04:00
docs update
This commit is contained in:
@@ -0,0 +1,61 @@
|
||||
---
|
||||
title: Tabler Icons for Vue
|
||||
---
|
||||
|
||||

|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
yarn add @tabler/icons-vue
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
npm install @tabler/icons-vue
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
pnpm install @tabler/icons-vue
|
||||
```
|
||||
|
||||
or just [download from Github](https://github.com/tabler/tabler-icons/releases).
|
||||
|
||||
## How to use
|
||||
|
||||
All icons are Vue components that contain SVG elements. So any icon can be imported and used as a component. It also helps to use threeshaking, so you only import the icons you use.
|
||||
|
||||
|
||||
```vue
|
||||
<template>
|
||||
<IconHome />
|
||||
</template>
|
||||
|
||||
<script>
|
||||
// Returns Vue component
|
||||
import { IconHome } from '@tabler/icons-vue';
|
||||
|
||||
export default {
|
||||
components: { IconHome }
|
||||
};
|
||||
</script>
|
||||
```
|
||||
|
||||
You can pass additional props to adjust the icon.
|
||||
|
||||
```html
|
||||
<IconHome color="red" :size="48" stroke-width="1" />
|
||||
```
|
||||
|
||||
### Props
|
||||
|
||||
| name | type | default |
|
||||
| ------------- | -------- | ------------ |
|
||||
| `size` | _Number_ | 24 |
|
||||
| `color` | _String_ | currentColor |
|
||||
| `stroke` | _Number_ | 2 |
|
||||
|
||||
Reference in New Issue
Block a user