@tabler/icons

What is @tabler/icons?

@tabler/icons is an npm package that provides a collection of over 1000 customizable SVG icons. These icons are designed to be simple, consistent, and easily integrated into web projects. The package is particularly useful for developers looking to add high-quality icons to their applications without the need for custom design work.

What are @tabler/icons's main functionalities?

Importing Icons

You can import specific icons from the @tabler/icons package to use in your project. This allows you to include only the icons you need, reducing the overall bundle size.

import { IconHome, IconUser } from '@tabler/icons';

Using Icons in React

The icons can be easily used within React components. This example demonstrates how to include the 'IconHome' icon in a simple React component.

import { IconHome } from '@tabler/icons';

function App() {
  return (
    <div>
      <IconHome />
    </div>
  );
}

Customizing Icon Size and Color

The icons are highly customizable. You can change their size and color by passing props to the icon component. This example shows how to set the size to 48 pixels and the color to red.

import { IconHome } from '@tabler/icons';

function App() {
  return (
    <div>
      <IconHome size={48} color="red" />
    </div>
  );
}

Other packages similar to @tabler/icons

react-icons

react-icons is a popular package that provides a wide range of icons from various icon libraries, including Font Awesome, Material Design, and more. It offers a similar level of customization and ease of use as @tabler/icons, but with a broader selection of icon styles.

heroicons

heroicons is a set of free, MIT-licensed high-quality SVG icons for you to use in your web projects. It is similar to @tabler/icons in terms of simplicity and design consistency, but it offers a different style and a smaller selection of icons.

feather-icons

feather-icons is a collection of simply beautiful open-source icons. Each icon is designed on a 24x24 grid with an emphasis on simplicity, consistency, and readability. It is comparable to @tabler/icons in terms of design philosophy and ease of use.

README

Tabler Icons

A set of over 1250 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.

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

Icons search: https://tabler-icons.io/

Sponsors

Preview

Sponsor Tabler

Installation

npm install @tabler/icons --save

or just download from Github.

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.

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

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

.icon-tabler {
  color: red;
  width: 32px;
  height: 32px;
  stroke-width: 1.25;
}

SVG sprite

Add an icon to be displayed on your page with the following markup (activity in the above example can be replaced with any valid icon name):

<svg width="24" height="24">
  <use xlink:href="path/to/tabler-sprite.svg#tabler-activity" />
</svg>

React

Import the icon and render it in your component. You can adjust SVG properties through React props:

import { IconAward } from '@tabler/icons';

const MyComponent = () => {
  return <IconAward 
    size={36} // set custom `width` and `height`
    color="red" // set `stroke` color
    stroke={3}  // set `stroke-width`
    strokeLinejoin="miter" // override other SVG props
  />
}

@tabler/icons exports it's own type declarations for usage with React and Typescript.

CDN

All files included in @tabler/icons npm package are available over a CDN.

React icons

<script src="https://unpkg.com/@tabler/icons@latest/icons-react/dist/index.umd.min.js"></script>

Iconfont

<link rel="stylesheet" href="https://unpkg.com/@tabler/icons@latest/iconfont/tabler-icons.min.css">

To load a specific version replace latest with the desired version number.

<script src="https://unpkg.com/@tabler/icons@1.36.0/icons-react/dist/index.umd.js"></script>

Compiling fonts

To compile fonts first install fontforge.

When compiling the font it will look for a json file compile-options.json in root folder (same folder as the package.json) In this file you can define extra options:

The default settings if you have not defined the file will be:

{
  "includeIcons": [],
  "fontForge": "fontforge",
  "strokeWidth": 2
}

The fontforge executable needs to be in the path or you can set the path to the downloaded fontforge executable in the configuration file. If you installed in on a mac in your application directory it will be /Applications/FontForge.app/Contents/MacOS/FontForge. You can set this value in the compile-options.json file.

{
  "fontForge":"/Applications/FontForge.app/Contents/MacOS/FontForge"
}

To compile the fonts run:

npm run build-iconfont

By default the stroke width is 2. You can change the stroke width in the compile-options.json

{
  "strokeWidth": 1.5,
}

To reduce the font file size you can choose to compile a sub set of icons. When you leave the array empty it will compile all the fonts. To compile only two icons you can set for example the folowing option in the compile-options.json:

{
  "includeIcons":["alert-octagon","alert-triangle"]
}

Svelte

You can use tabler-icons-svelte to use icons in your Svelte projects (see example):

<script>
    import { CurrencyBitcoin, BrandGithub, CircleX } from "tabler-icons-svelte";
</script>

<CurrencyBitcoin />
<BrandGithub size="48" strokeWidth="1" />
<CircleX />

Multiple strokes

All icons in this repository have been created with the value of the stroke-width property, so if you change the value, you can get different icon variants that will fit in well with your design.

License

Tabler Icons is licensed under the MIT License.