[!NOTE]
This project is greatly inspired by and mainly edited based on typst-fontawesome.
A Typst library for Tabler Icons, a set of over 5500 free MIT-licensed high-quality SVG icons.
Usage
Install Font
Download latest release of tabler-icons and install webfont/fonts/tabler-icons.ttf. Or, if you are using Typst web app, simply upload the font file to your project.
Import the Library
Using the Typst Packages
You can install the library using the typst packages:
#import "@preview/use-tabler-icons:0.2.0": *
Manually Install
Just copy all files under src to your project and rename them to avoid naming conflicts.
Then, import lib.typ to use the library:
#import "lib.typ": *
Use the Icons
You can use the tabler-icon function to create an icon with its name:
#tabler-icon("calendar")
Or you can directly use the ti- prefix :
#ti-calendar()
As these icons are actually text with custom font, you can pass any text attributes to the function:
#tabler-icon("calendar", fill: blue)
Refer to gallery.pdf and Tabler Icons website for all available icons.
Contributing
Pull Requests are welcome!
It is strongly recommended to follow the Conventional Commits specification when writing commit messages and creating pull requests.
Github Actions Workflow
This package uses a daily run Github Actions workflow to keep the library up-to-date with the latest version of Tabler Icons, which internally runs scripts/generate.mjs to generate Typst source code of the library and gallery.