https://github.com/joshday/heroicons.jl

Use the https://heroicons.com SVGs in Julia!
https://github.com/joshday/heroicons.jl

julia svg-icons

Last synced: 10 months ago
JSON representation

Use the https://heroicons.com SVGs in Julia!

• Host: GitHub
• URL: https://github.com/joshday/heroicons.jl
• Owner: joshday
• License: mit
• Created: 2021-03-23T01:19:01.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-23T13:38:32.000Z (almost 2 years ago)
• Last Synced: 2025-08-25T17:03:54.441Z (10 months ago)
• Topics: julia, svg-icons
• Language: Julia
• Homepage: https://joshday.github.io/HeroIcons.jl/
• Size: 28.3 KB
• Stars: 14
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# HeroIcons

- This package provides access to the [https://heroicons.com](https://heroicons.com) collection of SVG icons from Julia.

- Any `HeroIcons.Icon` will display as expected in `MIME"text/html"` environments (like [Pluto](https://github.com/fonsp/Pluto.jl)!).

## Usage

HeroIcons come in four sizes/styles: `outline`, `solid`, `mini`, and `micro`.  Each size/style has its own set of icons.

- You can retrieve the raw SVG string via `raw_outline(:arrow_down)` (similarly for `solid`, `mini`, and `micro`).

- The `Icon` object (`Icon(icon_name::Symbol, style::Symbol)`) displays the SVG in `MIME"text/html"` environments.

- Icons are "queryable" via `HeroIcons.outline.` (similarly for `solid`, `mini`, and `micro`).  E.g. `HeroIcons.outline.arrow_down` will return the `Icon` object for the icon `arrow_down`.

```julia

using HeroIcons

HeroIcons.outline.arrow_down

HeroIcons.solid.arrow_down

HeroIcons.mini.arrow_down

HeroIcons.micro.arrow_down

```

- To quickly view icons, use HeroIcons.jl with Cobweb.jl!

```julia

using Cobweb

Cobweb.preview(outline.arrow_circle_down)  # View a single icon

Cobweb.preview(HeroIcons.Viewer())  # See all available icons

```