Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

tailwindcss-plugin-iconify

yunsii479MIT1.5.2TypeScript support: included

Use any SVG icon powered by Iconify for Tailwind CSS, easy to use local icons and figma icons in particular.

tailwindcss, tailwindcss-plugin, iconify

readme

tailwindcss-plugin-iconify

NPM version Download monthly

Use any SVG icon powered by Iconify for Tailwind CSS, easy to use local icons and figma icons in particular.

Features

About Figma icons

TailwindCSS do not support async plugin for now, so figma-icon-sets extension you can not use directly.

But this library export related node scripts:

  • importFigmaIconSets to import IconSets from figma files
  • writeIconifyJSONs to write corresponding JSON files and SVG icons preview HTMLs
  • loadFigmaIconSets = importFigmaIconSets + writeIconifyJSONs

[!IMPORTANT] For better git auto merge, you should ignore icons.json and icons.html for code formatting.

Icon limitations

ref: iconify.design/import/figma

Motivation

I want to use tailwind autocomplete for Iconify icon sets and support local icon sets. related issue: iconify/iconify#241

Credits

Build & Publish

  • npm run build
  • npx changeset
  • npx changeset version
  • git commit
  • npx changeset publish
  • git push --follow-tags

changeset prerelease doc

License

MIT License © 2022 Yuns

changelog

tailwindcss-plugin-iconify

1.5.2

Patch Changes

  • 🐛 fix: support staticIconNames for custom iconSets

1.5.1

Patch Changes

  • 🐛 fix: create require

1.5.0

Minor Changes

  • ✨ feat: support aboutWrite callback

1.4.5

Patch Changes

  • update @iconify/tools

1.4.4

Patch Changes

  • 🐛 fix: match icon full name

1.4.3

Patch Changes

  • ✨ feat: use regexp to ensure valid icon name

1.4.2

Patch Changes

  • 🐛 fix: polish output files

1.4.1

Patch Changes

  • 🐛 fix: loop all types icons

1.4.0

Minor Changes

  • ✨ feat: support write mode

1.3.4

Patch Changes

  • ✨ feat: print icon set changes

1.3.3

Patch Changes

  • ✨ feat: optimize cache logic

1.3.2

Patch Changes

  • 🐛 fix: import icons from icon, variation types only

1.3.1

Patch Changes

  • ✨ feat: use '*' match all icon set

1.3.0

Minor Changes

  • ✨ feat: support specific static icons

1.2.4

Patch Changes

  • 🐛 fix: repeat "-"

1.2.3

Patch Changes

  • 🐛 fix: process normalizedName

1.2.2

Patch Changes

  • 🐛 fix: console warningNames

1.2.1

Patch Changes

  • 🐛 fix: normalize icon name

1.2.0

Minor Changes

  • ✨ feat: support pages config

1.1.0

Minor Changes

  • ✨ feat: support merge same prefix IconSet

1.0.2

Patch Changes

  • 📦 refactor: use files config

1.0.1

Patch Changes

  • chore: fix publish 1.0.0

1.0.0

Major Changes

  • ✨ feat: support multiple figma files

0.1.6

Patch Changes

  • 🐛 fix: node filter

0.1.5

Patch Changes

  • ✨ feat: support more node types

0.1.4

Patch Changes

  • 🐛 fix: exports description

0.1.3

Patch Changes

  • release latest

0.1.2

Patch Changes

  • 📚 docs: detailed features
  • ✨ feat: support more node types

0.1.1

Patch Changes

  • 🐛 fix: runSVGO

0.1.0

Minor Changes

  • ✨ feat: support load figma icon sets
  • ✨ feat: support iconifyJsonPath

0.0.1

Patch Changes

  • 6a3ade5: 🐛 fix: correct package.json exports
  • e9531ce: docs: about motivation
  • 29de74d: feat: getLocalIconSets
  • 71eeafe: ✨ feat: support preserveColors callback
  • e8f40d0: 🐛 fix: normalize path only
  • 📦 refactor: support preserveColors for every icon set

0.0.1-next.4

Patch Changes

  • ✨ feat: support preserveColors callback

0.0.1-next.3

Patch Changes

  • 🐛 fix: normalize path only

0.0.1-next.2

Patch Changes

  • 🐛 fix: correct package.json exports

0.0.1-next.1

Patch Changes

  • feat: getLocalIconSets

0.0.1-next.0

Patch Changes

  • docs: about motivation