JSPM

  • Created
  • Published
  • Downloads 43
  • Score
    100M100P100Q58260F
  • License ISC

Heroicons in svelte components

Package Exports

  • svelte-heroicons-component
  • svelte-heroicons-component/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (svelte-heroicons-component) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Svelte Heroicons Component

Heroicons component for Svelte. Available props are: className, size, strokeWidth, and fill(solid icon only). You can also add on:click event.

Installing

npm install -D svelte-heroicons-component

Usage

//Example: to use heroicons home just import the HomeIcon component. If you want to use a solid icon import HomeSolidIcon.

import { HomeIcon, HomeSolidIcon} from 'svelte-heroicons-component'


<HomeIcon />
<HomeSolidIcon />
// to add click event you can do like this
<HomeIcon on:click={callFunction} />

<HomeSolidIcon on:click={callFunction} />

// to add class name
<HomeIcon className="hidden lg:block" />
// default size is 1.5rem but you can customized the size like this example bellow
<HomeIcon size="10px" />
<HomeIcon size="20pt" />
<HomeIcon size="3em" />
<HomeIcon size="2rem" />
<HomeIcon size="4" /> # "The default unit size is rem, so this will be 4rem"

// If you use tailwindcss the classname w-* will override the size value
<HomeIcon size="4rem" className="w-6 h-6 xl:w-8 h-8" />
// the default strokewidth is 2 but you can change like this. Props strokeWidth only exists in outline icons
<HomeIcon strokeWidth="5" />
// If you use tailwindcss the classname stroke-* will override the strokeWidth value
<HomeIcon strokeWidth="5" className="stroke-2" />
// If you want to fill the color you can do like this. Props fill only exists in outline icons
<HomeIcon fill="#87CEEB" />

Available Icons: https://heroicons.com

Note: Add Icon to the end of component name (e.g., AcademicCapIcon) . For solid icon add SolicIcon to the end of component name (e.g., AcademicCapSolidIcon).

AcademicCap         CloudDownload         Home                   Save
Adjustments         Cloud                 Identification         Scale
Annotation          CloudUpload           InboxIn                Scissors
Archive             Code                  Inbox                  SearchCircle
ArrowCircleDown     Cog                   InformationCircle      Search
ArrowCircleLeft     Collection            Key                    Selector
ArrowCircleRight    ColorSwatch           Library                Server
ArrowCircleUp       CreditCard            LightBulb              Share
ArrowDown           Cube                  LightningBolt          ShieldCheck
ArrowLeft           CubeTransparent       Link                   ShieldExclamation
ArrowNarrowDown     CurrencyBangladeshi   LocationMarker         ShoppingBag
ArrowNarrowLeft     CurrencyDollar        LockClosed             ShoppingCart
ArrowNarrowRight    CurrencyEuro          LockOpen               SortAscending
ArrowNarrowUp       CurrencyPound         Login                  SortDescending
ArrowRight          CurrencyRupee         Logout                 Sparkles
ArrowsExpand        CurrencyYen           MailOpen               SpeakerPhone
ArrowSmDown         CursorClick           Mail                   Star
ArrowSmLeft         Database              Map                    StatusOffline
ArrowSmRight        DesktopComputer       MenuAlt1               StatusOnline
ArrowSmUp           DeviceMobile          MenuAlt2               Stop
ArrowUp             DeviceTablet          MenuAlt3               Sun
AtSymbol            DocumentAdd           MenuAlt4               Support
Backspace           DocumentDownload      Menu                   SwitchHorizontal
BadgeCheck          DocumentDuplicate     Microphone             SwitchVertical
Ban                 DocumentRemove        MinusCircle            Table
Beaker              DocumentReport        MinusSm                Tag
Bell                DocumentSearch        Minus                  Template
BookmarkAlt         Document              Moon                   Terminal
Bookmark            DocumentText          MusicNote              ThumbDown
BookOpen            DotsCircleHorizontal  Newspaper              ThumbUp
Briefcase           DotsHorizontal        OfficeBuilding         Ticket
Cake                DotsVertical          PaperAirplane          Translate
Calculator          Download              PaperClip              Trash
Calendar            Duplicate             Pause                  TrendingDown
Camera              EmojiHappy            PencilAlt              TrendingUp
Cash                EmojiSad              Pencil                 Truck
ChartBar            ExclamationCircle     PhoneIncoming          Upload
ChartPie            Exclamation           PhoneMissedCall        UserAdd
ChartSquareBar      ExternalLink          PhoneOutgoing          UserCircle
ChatAlt2            EyeOff                Phone                  UserGroup
ChatAlt             Eye                   Photograph             UserRemove
Chat                FastForward           Play                   Users
CheckCircle         Film                  PlusCircle             User
Check               Filter                PlusSm                 Variable
ChevronDoubleDown   FingerPrint           Plus                   VideoCamera
ChevronDoubleLeft   Fire                  PresentationChartBar   ViewBoards
ChevronDoubleRight  Flag                  PresentationChartLine  ViewGridAdd
ChevronDoubleUp     FolderAdd             Printer                ViewGrid
ChevronDown         FolderDownload        Puzzle                 ViewList
ChevronLeft         FolderOpen            Qrcode                 VolumeOff
ChevronRight        FolderRemove          QuestionMarkCircle     VolumeUp
ChevronUp           Folder                ReceiptRefund          Wifi
Chip                Gift                  ReceiptTax             XCircle
ClipboardCheck      GlobeAlt              Refresh                X
ClipboardCopy       Globe                 Reply                  ZoomIn
ClipboardList       Hand                  Rewind                 ZoomOut
Clipboard           Hastag                Rss
Clock               Heart                 SaveAs