benjamincanac / tailwindcss-icons

Use any icon (100,000+) from Iconify, for TailwindCSS

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

💛 You can help the author become a full-time open-source maintainer by sponsoring him on GitHub.


@egoist/tailwindcss-icons

Use any icon from Iconify

npm version npm downloads

preview

Install

npm i @egoist/tailwindcss-icons

Usage

In your tailwind.config.js:

const { iconsPlugin, getIconCollections } = require("@egoist/tailwindcss-icons")

module.exports = {
  plugins: [
    iconsPlugin({
      // Select the icon collections you want to use
      collections: getIconCollections(["mdi", "lucide"]),
    }),
  ],
}

You also need to install @iconify/json (full icon collections, 50MB) or @iconify-json/{collection_name} (individual icon package)

Then you can use the icons in your HTML:

<!-- pattern: i-{collection_name}-{icon_name} -->
<span class="i-mdi-home"></span>

Search the icon you want to use here: https://icones.js.org

Sponsors

sponsors

License

MIT © EGOIST

About

Use any icon (100,000+) from Iconify, for TailwindCSS

License:MIT License


Languages

Language:TypeScript 87.3%Language:JavaScript 8.1%Language:HTML 4.6%