Tabler Icons
A set of over 3000 free MIT-licensed high-quality SVG icons for you to use ...
README
A set of 3036 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.
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 :)
Preview
Sponsor Tabler
Installation
- ```
- npm install @tabler/icons --save
- ```
or just download from Github.
Usage
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;
- }
- ```
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):
- ``` html
- <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:
- ``` js
- 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.
Angular
Angular components available through [angular-tabler-icons](https://www.npmjs.com/package/angular-tabler-icons) package.
Install the package, then create icons module:
- ```ts
- import { NgModule } from '@angular/core';
- import { TablerIconsModule } from 'angular-tabler-icons';
- import { IconCamera, IconHeart, IconBrandGithub } from 'angular-tabler-icons/icons';
- // Select some icons (use an object, not an array)
- const icons = {
- IconCamera,
- IconHeart,
- IconBrandGithub
- };
- @NgModule({
- imports: [
- TablerIconsModule.pick(icons)
- ],
- exports: [
- TablerIconsModule
- ]
- })
- export class IconsModule { }
- ```
After importing the _IconsModule_ in your feature or shared module, use the icons as follows:
- ``` html
- <i-tabler name="camera"></i-tabler>
- <i-tabler name="heart" style="color: red;"></i-tabler>
- <i-tabler name="brand-github" class="someclass"></i-tabler>
- ```
angular-tabler-icons exports it's own type declarations for usage with Typescript.
For more usage documentation refer to the official documentation.
Vue
Vue components available through [vue-tabler-icons](https://www.npmjs.com/package/vue-tabler-icons) package.
Install the package, import the icon component and render it in your component. You can adjust SVG properties by passing regular HTML attributes:
- ``` html
- <script>
- // MyComponent.vue
- import { BoldIcon } from 'vue-tabler-icons';
- export default {
- components: { BoldIcon },
- };
- </script>
- <template>
- <bold-icon />
- </template>
- ```
vue-tabler-icons exports it's own type declarations for usage with Typescript.
For more usage documentation refer to the official documentation.
CDN
All files included in @tabler/icons npm package are available over a CDN.
React icons
- ``` html
- <script src="https://cdn.jsdelivr.net/npm/@tabler/icons@latest/icons-react/dist/index.umd.min.js"></script>
- ```
Iconfont
- ``` html
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tabler/icons@latest/iconfont/tabler-icons.min.css">
- ```
To load a specific version replace latest with the desired version number.
- ``` html
- <script src="https://cdn.jsdelivr.net/npm/@tabler/icons@1.74.0/icons-react/dist/index.umd.min.js"></script>
- ```
HTML
- ``` html
- <i class="ti ti-brand-tabler"></i>
- ```
CSS
- ```css
- content: 'ec8f';
- ```
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:
- ``` jsON
- {
- "includeIcons": [],
- "fontForge": "fontforge",
- "strokeWidth": null
- }
- ```
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.
- ``` jsON
- {
- "fontForge": "/Applications/FontForge.app/Contents/MacOS/FontForge"
- }
- ```
To compile the fonts run:
- ```sh
- npm run build-iconfont
- ```
By default the stroke width is 2. You can change the stroke width in the compile-options.json
- ``` 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:
- ``` jsON
- {
- "includeIcons": ["alert-octagon", "alert-triangle"]
- }
- ```
Optional property includeCategories - an array or string of icon categories to include, category names are case-issensetive.
- ``` jsON
- {
- "includeCategories": ["Devices", "System"]
- }
- ```
or
- ``` jsON
- {
- "includeCategories": "Devices System"
- }
- ```
Optional property excludeIcons - an array of icon names using to exclude some category icons:
- ``` jsON
- {
- "includeCategories": ["system"],
- "excludeIcons": ["adjustments"]
- }
- ```
Complex solution:
- ``` jsON
- {
- "includeIcons": ["alert-octagon", "alert-triangle"],
- "includeCategories": ["devices", "system"],
- "excludeIcons": ["adjustments"]
- }
- ```
Svelte
You can use [tabler-icons-svelte](https://github.com/benflap/tabler-icons-svelte) to use icons in your Svelte projects (see example):
- ``` js
- <script>
- import { CurrencyBitcoin, BrandGithub, CircleX } from "tabler-icons-svelte";
- </script>
- <CurrencyBitcoin />
- <BrandGithub size="48" strokeWidth="1" />
- <CircleX />
- ```
Jetpack Compose
For Android or Desktop you can use [compose-icons](https://github.com/DevSrSouza/compose-icons) to use icons in your projects. (see docs)
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.