UNPKG

@tabler/icons

Version:

A set of free MIT-licensed high-quality SVG icons for you to use in your web projects.

108 lines (76 loc) 2.96 kB
# Tabler Icons <p align="center"> <img src="https://raw.githubusercontent.com/tabler/tabler-icons/main/.github/packages/og-core.png" alt="Tabler Icons" width="838"> </p> <p align="center"> A set of <!--icons-count-->5945<!--/icons-count--> free MIT-licensed high-quality SVG icons for you to use in your web projects. Each icon is designed on a 24x24 grid and a 2px stroke. <p> <p align="center"> <a href="https://tabler-icons.io/"><strong>Browse all icons at tabler-icons.io &rarr;</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 ``` or ``` npm install @tabler/icons ``` or ``` pnpm install @tabler/icons ``` or just [download from Github](https://github.com/tabler/tabler-icons/releases). ## Usage All icons are built with SVG, so you can place them as `<img>`, `background-image` and inline in HTML code. ### HTML image If you load an icon as an image, you can modify its size using CSS. ```html <img src="path/to/icon.svg" alt="icon title" /> ``` ### Inline HTML You can paste the content of the icon file into your HTML code to display it on the page. ```html <a href=""> <svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-disabled" width="24" height="24" viewBox="0 0 24 24" stroke-width="1.25" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" > ... </svg> Click me </a> ``` Thanks to that, you can change the size, color and the `stroke-width` of the icons with CSS code. ```css .icon-tabler { color: red; width: 32px; height: 32px; stroke-width: 1.25; } ``` ## 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/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>