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

svelte-hero-icons

Package Overview
Dependencies
Maintainers
1
Versions
72
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

svelte-hero-icons

Heroicons for Svelte (Project based on heroicons)

  • 5.0.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2.9K
increased by11.12%
Maintainers
1
Weekly downloads
 
Created
Source

Svelte Heroicons

If you want to use more Icons Packs and components for multiple Frameworks (React, Vue, Lit and more), check out @steeze-ui/icons which is meant as a successor to svelte-hero-icons:

What is @steeze-ui/Icons ?

  • Icon Components for various frameworks (svelte, lit, solid and react)
  • Icon Packs (e.g heroicons, radix-icons, feathericons and more)
  • A template to create your own publishable Icon Pack
  • Now lives under an org that will focus on more ui tools for svelte

Description

  • complete heroicons set optimized for svelte
  • programatically change solid or outline version based on the solid attribute
  • fully typed for a great IDE experience
  • works out of the box with SvelteKit
  • SSR compatible (no JS is needed for the client to display the icon)

Installation

  • install as devDependency

Example for npm

npm i -D svelte-hero-icons

Configuration

SvelteKit

  • svelte-hero-icons should work with SvelteKit without any configuration
  • If you have any problems, this could help adding to your vite.config.js:
ssr: {
   noExternal: ["svelte-hero-icons"],
 }

Usage

  • Default is Outline version of icon
  • Use solid attribute for Solid Icons
<script>
  // Only import what you need!
  import { Icon, ArrowUp, Filter } from "svelte-hero-icons";
</script>
<!-- default it's using the outline version of this icon -->
<Icon src="{Filter}" />

<!-- use solid attribute to display the solid version of this icon -->
<Icon src="{Filter}" solid />

<!-- use mini attribute to display the mini version of this icon -->
<Icon src="{Filter}" mini />

<!-- in this (rather unusual) case solid will have the precedence -->
<Icon src="{Filter}" solid mini />

<!-- use size attribute to set icon size (32 -> 32px | 2rem | 100% == default ) -->
<Icon src="{ArrowUp}" size="32" />

<!-- use Windi CSS or tailwindcss classes directly -->
<Icon src="{Filter}" class="h-6 text-red-500 w-6" />

Use with types

<script>
  import { Icon, Filter, type IconSource } from "svelte-hero-icons";
  export let icon:IconSource = Filter
</script>

<Icon src="{icon}" solid />

Author

This package is based on heroicons

See all available icons here: https://github.com/refactoringui/heroicons

Keywords

FAQs

Package last updated on 03 Mar 2023

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