Skip to content
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.

encode42/tabler-icons-types

Repository files navigation

Tabler Icons Types

Simple library that provides React types for Tabler Icons.

NPM Badge Documentation Badge Support Badge

⚙️ 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

npm i @encode42/tabler-icons-types

Yarn

yarn add @encode42/tabler-icons-types

Javascript

const { TablerIconsType } = require("@encode42/tabler-icons-types");

Typescript

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

import { TablerIconsType } from "https://cdn.jsdelivr.net/npm/@encode42/tabler-icons-types/dist/esm.js";

🔨 Building

Ensure pnpm and Node.js are installed.

  1. Enter the directory containing the tabler-icons-types source code in your terminal.
  2. Install the build dependencies via pnpm install.
  3. 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.

About

Simple library that provides types for Tabler Icons.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project