svelte-hero-icons - npm Package Compare versions

Comparing version 3.2.0-beta.0 to 4.0.0-beta.0

Icon.svelte.d.ts

@@ -10,3 +10,2 @@ /** @typedef {typeof __propDef.props}  IconProps */
     class?: string;
-    ariaHidden?: boolean;
 }, {
@@ -27,3 +26,2 @@ [evt: string]: CustomEvent<any>;
         class?: string;
-        ariaHidden?: boolean;
     };
@@ -30,0 +28,0 @@ events: {

package.json

 {
   "name": "svelte-hero-icons",
-  "version": "3.2.0-beta.0",
+  "version": "4.0.0-beta.0",
   "description": "Heroicons for Svelte (Project based on heroicons)",
@@ -34,3 +34,4 @@ "repository": {
     "tslib": "^2.0.0",
-    "typescript": "^4.4.2"
+    "typescript": "^4.4.2",
+    "svelte-hero-icons": "*"
   },
@@ -40,6 +41,6 @@ "type": "module",
     "./package.json": "./package.json",
-    "./Icon.svelte": "./Icon.svelte",
     ".": "./index.js"
   },
-  "svelte": "./index.js"
+  "svelte": "./index.js",
+  "readme": "<div align=\"center\">\r\n  <h1>Svelte Heroicons</h1>\r\n  <a href=\"https://www.npmjs.com/package/svelte-hero-icons\"><img src=\"https://img.shields.io/npm/v/svelte-hero-icons.svg?style=flat\" /></a>\r\n</div>\r\n\r\n## Info\r\n\r\nCheck out [@steeze-ui/icons](https://github.com/steeze-ui/icons) which is meant as a successor of svelte-hero-icons:\r\n\r\n- Icon Components for any framework (for now its only svelte)\r\n- Icon Packs (e.g heroicons, radix-icons, iconic-free)\r\n- A template to create your own publishable Icon Pack (Planned)\r\n- Now lives under an org that will focus on more ui tools that I have planned (primarily for svelte)\r\n\r\n## Description\r\n\r\n- complete heroicon set optimized for svelte\r\n- programatically change solid or outline version based on the `solid` attribute\r\n- fully typed for a great IDE experience\r\n- works with SvelteKit & Vite\r\n\r\n## Install\r\n\r\n- install as `dependency` (important)\r\n\r\nNPM\r\n\r\n```bash\r\nnpm install svelte-hero-icons\r\n```\r\n\r\n## Configuration\r\n\r\n### [SvelteKit](https://github.com/sveltejs/kit) & [vitejs](https://github.com/vitejs/vite)\r\n\r\n- Add this to your `vite.config.js`, so all icons are bundled into one file -> no import waterfalls\r\n\r\n```js\r\nconst config = {\r\n  kit: {\r\n    vite: {\r\n      //!IMPORTANT so the icon data can be imported (as JSON)\r\n      ssr: {\r\n        noExternal: [\"svelte-hero-icons\"],\r\n      },\r\n\r\n      // no import waterfalls in development\r\n      optimizeDeps: {\r\n        include: [\"svelte-hero-icons\"],\r\n      },\r\n    },\r\n  },\r\n};\r\nexport default config;\r\n```\r\n\r\n## Usage\r\n\r\n- Default is Outline version of icon\r\n- Use **solid** attribute for Solid Icons\r\n\r\n```html\r\n<script>\r\n  // Only import what you need!\r\n  import { Icon, ArrowUp, Filter } from \"svelte-hero-icons\";\r\n</script>\r\n\r\n<!-- use solid attribute to control whether to show solid or outline version of icon -->\r\n<Icon src=\"{Filter}\" solid />\r\n\r\n<!-- use size attribute to set icon size (32 -> 32px | 2rem | 100% == default ) -->\r\n<Icon src=\"{ArrowUp}\" size=\"32\" />\r\n\r\n<!-- use Windi CSS or tailwindcss classes directly -->\r\n<Icon src=\"{Filter}\" class=\"h-6 text-red-500 w-6\" />\r\n```\r\n\r\nSee all icons here: https://github.com/refactoringui/heroicons\r\n\r\n## Known Problems\r\n\r\n### Windows & pnpm\r\n\r\nIf you are developing with Windows or pnpm you need to prevent the dependency from being externalized for SSR:\r\n\r\n```js\r\nconst config = {\r\n  // ...\r\n  kit: {\r\n    // ...\r\n    vite: {\r\n      // ...\r\n      ssr: {\r\n        noExternal: [\"svelte-hero-icons\"],\r\n      },\r\n    },\r\n  },\r\n};\r\n```\r\n\r\n## Author\r\n\r\nThis package is based on [heroicons](https://github.com/refactoringui/heroicons)\r\n"
 }

README.md

@@ -6,6 +6,11 @@ <div align="center">
 
-## !!!WARNING!!!
+## Info
 
-With version 3.0.0 , this package is primarily meant for SvelteKit projects and it is not guaranteed to work with other build systems!
+Check out [@steeze-ui/icons](https://github.com/steeze-ui/icons) which is meant as a successor of svelte-hero-icons:
 
+- Icon Components for any framework (for now its only svelte)
+- Icon Packs (e.g heroicons, radix-icons, iconic-free)
+- A template to create your own publishable Icon Pack (Planned)
+- Now lives under an org that will focus on more ui tools that I have planned (primarily for svelte)
+
 ## Description
@@ -12,0 +17,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

201703

increased by1.48%

Number of lines in readme file

104

increased by5.05%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

15

increased by7.14%

Lines of code

3010

decreased by-0.07%

No dependency changes