tailwindcss-plugin-icons - npm Package Compare versions

Comparing version 0.0.4 to 1.0.0

dist/index.d.ts

 import * as tailwindcss_plugin from 'tailwindcss/plugin'
 
-interface IconSet {}
-declare type IconSetSelector = {
-  [K in keyof IconSet extends never
-    ? string
-    : keyof IconSet]?: keyof IconSet extends never ? string[] : IconSet[K][]
-}
-declare type Options = {
-  asMask?: IconSetSelector
-  asBackground?: IconSetSelector
-  custom?: {
-    asMask?: string[]
-    asBackground?: string[]
+declare type IconSets = {
+  [iconSetName: string]: {
+    icons: string[]
     location?: string
   }
 }
-declare const Icons: tailwindcss_plugin.TailwindPluginWithOptionsFn<Options>
+declare const Icons: tailwindcss_plugin.TailwindPluginWithOptionsFn<IconSets>
 
-export { IconSet, IconSetSelector, Icons, Options }
+export { IconSets, Icons }

package.json

 {
   "name": "tailwindcss-plugin-icons",
-  "version": "0.0.4",
+  "version": "1.0.0",
   "description": "Tailwind CSS icons with classes",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -30,13 +30,20 @@ # tailwindcss-plugin-icons
     Icons({
-      // With existing icon sets
-      asMask: {
-        heroiconsSolid: ['trash', 'dots-vertical'],
-        heroiconsOutline: ['trash', 'dots-vertical'],
+      heroiconsSolid: {
+        // By default will search in common iconify module locations
+        icons: ['trash', 'trash?bg']
       },
-      asBackground: {
-        heroiconsSolid: ['trash']
+      heroiconsOutline: {
+        icons: ['lock-open', 'lock-closed'],
+        // Can be some other module too
+        location: 'my-icon-alias/icons.json'
       },
-      // Pass a custom icon set
       custom: {
-        asMask: ['loading'],
+        icons: ['loading'],
+        // Can be a URI
+        location:
+          'https://gist.githubusercontent.com/JensDll/4e59cf6005f585581975941a94bc1d88/raw/6cdeb3cb9dacd47fd132d49004a2e8f4cbc0774f/icons.json'
+      },
+      customAlt: {
+        icons: ['loading'],
+        // Can be a relative or absolute path
         location: './src/icons.json'
@@ -52,5 +59,5 @@ }
 ```html
-<div class="i-heroicons-solid-trash w-5 h-5"></div>
+<div class="i-heroicons-solid-trash h-5 w-5"></div>
 ```
 
 ## [Example](https://stackblitz.com/github/JensDll/tailwindcss-plugin-icons/tree/main/playground/vue?file=tailwind.config.js)

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 2 instances in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19730

increased by7.99%

Number of package files

9

increased by12.5%

Lines of code

385

increased by27.91%

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

62

increased by12.73%

Worsened metrics

Number of low supply chain risk alerts

13

increased by30%

Number of medium supply chain risk alerts

5

increased byInfinity%

No dependency changes