Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@egoist/tailwindcss-icons

Package Overview
Dependencies
Maintainers
1
Versions
28
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@egoist/tailwindcss-icons

Icons utility for TailwindCSS

  • 1.8.1
  • latest
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

💛 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 -D

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
      // You can also ignore this option to automatically discover all individual icon packages you have installed
      // If you install @iconify/json, you should explicitly specify the collections you want to use, like this:
      collections: getIconCollections(["mdi", "lucide"]),
      // If you want to use all icons from @iconify/json, you can do this:
      // collections: getIconCollections("all"),
      // and the more recommended way is to use `dynamicIconsPlugin`, see below.
    }),
  ],
}

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

# install every icon:
npm i @iconify/json -D

# or install individual packages like this:
npm i @iconify-json/mdi @iconify-json/lucide -D

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

[!TIP] To get the full list of icon names as typescript type, you can refer to this issue.

Plugin Options

OptionTypeDefaultDescription
prefixstringiClass prefix for matching icon rules
scalenumber1Scale relative to the current font size
strokeWidthnumberundefinedStroke width for icons (this may not work for all icons)
extraPropertiesRecord<string, string>{}Extra CSS properties applied to the generated CSS.
collectionNamesAlias[key in CollectionNames]?: string{}Alias to customize collection names.

Custom Icons

You can also use custom icons with this plugin, for example:

module.exports = {
  plugins: [
    iconsPlugin({
      collections: {
        foo: {
          icons: {
            "arrow-left": {
              // svg body
              body: '<path d="M10 19l-7-7m0 0l7-7m-7 7h18"/>',
              // svg width and height, optional
              width: 24,
              height: 24,
            },
          },
        },
      },
    }),
  ],
}

Then you can use this custom icon as class name: i-foo-arrow-left.

[!TIP] To read custom icons from directory, you can refer to Load svgs from filesystem

Generate Icon Dynamically

The idea is from @iconify/tailwind, thanks to the author of Iconify for the great work!

If you want to install @iconify/json and use whatever icon you want, you should add another plugin to your tailwind.config.js.

This is because we can not provide autocomplete for all icons from @iconify/json, it will make your editor slow.

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

module.exports = {
  plugins: [iconsPlugin(), dynamicIconsPlugin()],
}

Then you can use icons dynamically like <span class="i-[mdi-light--home]"></span>.

Sponsors

sponsors

License

MIT © EGOIST

FAQs

Package last updated on 05 Jun 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc