mirror of
https://github.com/tabler/tabler-icons.git
synced 2025-09-08 21:30:40 +02:00
120 lines
3.1 KiB
Markdown
120 lines
3.1 KiB
Markdown
# Tabler Icons for Vue
|
|
|
|
<p align="center">
|
|
<img src="https://raw.githubusercontent.com/tabler/tabler-icons/main/.github/packages/og-package-vue.png" alt="Tabler Icons" width="838">
|
|
</p>
|
|
|
|
<p align="center">
|
|
Implementation of the Tabler Icons library for Vue 3 applications.
|
|
<p>
|
|
|
|
<p align="center">
|
|
<a href="https://tabler-icons.io/"><strong>Browse all icons at tabler-icons.io →</strong></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/tabler/tabler-icons/releases"><img src="https://img.shields.io/npm/v/@tabler/icons" alt="Latest Release"></a>
|
|
<a href="https://github.com/tabler/tabler-icons/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/@tabler/icons.svg" alt="License"></a>
|
|
</p>
|
|
|
|
## Sponsors
|
|
|
|
**If you want to support my project and help me grow it, you can [become a sponsor on GitHub](https://github.com/sponsors/codecalm) or just [donate on PayPal](https://paypal.me/codecalm) :)**
|
|
|
|
<a href="https://github.com/sponsors/codecalm">
|
|
<img src="https://cdn.jsdelivr.net/gh/tabler/sponsors@latest/sponsors.svg" alt="Tabler sponsors">
|
|
</a>
|
|
|
|
## 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>
|
|
<!-- basic usage -->
|
|
<IconHome />
|
|
|
|
<!-- set `stroke` color -->
|
|
<IconHome color="red"/>
|
|
<IconHome stroke="red"/>
|
|
|
|
<!-- set custom `width` and `height` -->
|
|
<IconHome size="36"/>
|
|
|
|
<!-- set `stroke-width` -->
|
|
<IconHome strokeWidth="2"/>
|
|
<IconHome stroke-width="2"/>
|
|
</template>
|
|
|
|
<script>
|
|
// Returns Vue component
|
|
import { IconHome } from '@tabler/icons-vue';
|
|
|
|
export default {
|
|
components: { IconHome }
|
|
};
|
|
</script>
|
|
```
|
|
|
|
or with `<script setup>`
|
|
|
|
```vue
|
|
<script setup>
|
|
// Import Vue component
|
|
import { IconHome } from '@tabler/icons-vue';
|
|
</script>
|
|
|
|
<template>
|
|
<IconHome color="red" size="36" strokeWidth="2"/>
|
|
</template>
|
|
```
|
|
|
|
You can pass additional attribute `stroke-width="1"` alongside the props to adjust the icon.
|
|
|
|
```html
|
|
<IconHome color="red" size="48" stroke-width="1" />
|
|
```
|
|
|
|
### Props
|
|
|
|
| name | type | default |
|
|
| ------------- | -------- | ------------ |
|
|
| `size` | _Number_ | 24 |
|
|
| `color` | _String_ | currentColor |
|
|
| `strokeWidth` | _Number_ | 2 |
|
|
|
|
## Contributing
|
|
|
|
For more info on how to contribute please see the [contribution guidelines](https://github.com/tabler/tabler-icons/blob/main/CONTRIBUTING.md).
|
|
|
|
Caught a mistake or want to contribute to the documentation? [Edit this page on Github](https://github.com/tabler/tabler-icons/blob/main/packages/icons-vue/README.md)
|
|
|
|
## License
|
|
|
|
Tabler Icons is licensed under the [MIT License](https://github.com/tabler/tabler-icons/blob/master/LICENSE).
|
|
|
|
## Sponsor Tabler
|
|
|
|
<a href="https://github.com/sponsors/codecalm" target="_blank"><img src="https://github.com/tabler/tabler/raw/dev/src/static/sponsor-banner-readme.png?raw=true" alt="Sponsor Tabler" /></a>
|