svelte-hero-icons/package.json

{
  "name": "svelte-hero-icons",
  "version": "4.0.3",
  "description": "Heroicons for Svelte (Project based on heroicons)",
  "repository": {
    "type": "git",
    "url": "https://github.com/JustinVoitel/svelte-hero-icons"
  },
  "engines": {
    "node": ">=14.0.0"
  },
  "author": "Justin Voitel <mail@justinv.me>",
  "license": "MIT",
  "keywords": [
    "svelte",
    "component",
    "icon",
    "icons",
    "heroicons",
    "tailwindcss"
  ],
  "bugs": {
    "url": "https://github.com/JustinVoitel/svelte-hero-icons/issues"
  },
  "homepage": "https://github.com/JustinVoitel/svelte-hero-icons#readme",
  "files": [
    "heroicons",
    "*.svelte",
    "*.js",
    "*.d.ts"
  ],
  "devDependencies": {
    "@sveltejs/adapter-node": "next",
    "@sveltejs/adapter-vercel": "next",
    "@sveltejs/kit": "next",
    "@types/node": "^16.11.20",
    "heroicons": "^1.0.5",
    "html-parse-stringify": "^3.0.1",
    "pascalcase": "^1.0.0",
    "svelte": "^3.46.2",
    "svelte-check": "^2.3.0",
    "svelte-hero-icons": "*",
    "svelte-preprocess": "^4.10.2",
    "svelte2tsx": "^0.4.14",
    "ts-node": "^10.4.0",
    "tslib": "^2.3.1",
    "typescript": "^4.5.4"
  },
  "type": "module",
  "main": "index.js",
  "exports": {
    "./package.json": "./package.json",
    ".": "./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## Important Info for Current or New Users\r\n\r\nThis package won't be updated for the upcoming Heroicons 2.0 release and will stay as a reference to v1.x.\r\n\r\nIf you want to use v2.0 Icons, check out [@steeze-ui/icons](https://github.com/steeze-ui/icons) which is meant as a successor of svelte-hero-icons and will be be maintained instead:\r\n\r\n### What is @steeze-ui/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---\r\n\r\n## Description\r\n\r\n- complete [heroicons](https://heroicons.dev/) 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 out of the box with SvelteKit\r\n- SSR compatible (no JS is needed for the client to display the icon)\r\n\r\n## Installation\r\n\r\n- install as `devDependency`\r\n\r\n### Example for npm\r\n\r\n```bash\r\nnpm i -D svelte-hero-icons\r\n```\r\n\r\n## Configuration\r\n\r\n## [SvelteKit](https://github.com/sveltejs/kit)\r\n\r\n- svelte-hero-icons should work with SvelteKit `without any configuration`\r\n- If you have any problems, this could help adding to your `svelte.config.js`:\r\n\r\n```js\r\nkit: {\r\n  vite: {\r\n    ssr: {\r\n      noExternal: [\"svelte-hero-icons\"],\r\n    },\r\n  },\r\n},\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\n## Author\r\n\r\nThis package is based on [heroicons](https://github.com/refactoringui/heroicons)\r\n\r\nSee all available icons here: https://github.com/refactoringui/heroicons\r\n"
}