Tabler Icons Types
Simple library that provides React types for Tabler Icons.
![Support Badge](https://raw.githubusercontent.com/intergrav/devins-badges/v2/assets/cozy/social/discord-singular_vector.svg)
βοΈ Features
- Typescript definition file containing all available Tabler Icons.
- Array of every Tabler Icon name/type.
- Truncated and normalized tags.json.
- Targeted towards Tabler's React icons.
- Package automatically updates when Tabler Icons updates.
π§ Including
Node.js
NPM
```sh
npm i @encode42/tabler-icons-types
```
Yarn
```sh
yarn add @encode42/tabler-icons-types
```
---
Javascript
```js
const { TablerIconsType } = require("@encode42/tabler-icons-types");
```
Typescript
```js
import { TablerIconsType } from "@encode42/tabler-icons-types";
```
Deno
> It's recommended to use a versioned link, e.g. `@encode42/tabler-icons-types@1.103.2`
```js
import { TablerIconsType } from "https://cdn.jsdelivr.net/npm/@encode42/tabler-icons-types/dist/esm.js";
```
π¨ Building
Ensure pnpm and Node.js are installed.
- Enter the directory containing the
tabler-icons-types
source code in your terminal.
- Install the build dependencies via
pnpm install
.
- Run
pnpm run build
to generate the Node.js and browser modules.
This will automatically update @tabler/icons
if an update is available.
Generated files:
./cjs/
: CommonJS bundle, used by Node.js.
./esm/
: ES module for browser script modules.
./lib/
: Built ECMAScript files.