tabler-icons/packages/icons-vue
codecalm 0a955dcc11 rollup plugins fix 2024-01-19 02:15:46 +01:00
..
src add icons aliases 2024-01-05 03:51:24 +01:00
README.md Improved docs + remove clash props and SVG attribute stroke (#841) 2023-09-27 18:26:24 +00:00
build.mjs vue components 2024-01-05 01:29:27 +01:00
package.json Release 3.0.0-alpha.0 2024-01-19 00:00:05 +01:00
rollup.config.mjs rollup plugins fix 2024-01-19 02:15:46 +01:00
setupVitest.js add unit tests 2024-01-05 02:45:28 +01:00
test.spec.js build fixes 2024-01-05 03:33:23 +01:00
tsconfig.json vue components 2024-01-05 01:29:27 +01:00
vitest.config.mts add unit tests 2024-01-05 02:45:28 +01:00

README.md

Tabler Icons for Vue

Tabler Icons

Implementation of the Tabler Icons library for Vue 3 applications.

Browse all icons at tabler-icons.io →

Latest Release License

Sponsors

If you want to support my project and help me grow it, you can become a sponsor on GitHub or just donate on PayPal :)

Installation

yarn add @tabler/icons-vue

or

npm install @tabler/icons-vue

or

pnpm install @tabler/icons-vue

or just download from Github.

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.

<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>

<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.

<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.

Caught a mistake or want to contribute to the documentation? Edit this page on Github

License

Tabler Icons is licensed under the MIT License.

Sponsor Tabler

Sponsor Tabler