Skip to content

tompazourek/Heroicons.AspNetCore

Repository files navigation

Heroicons.AspNetCore logo Heroicons.AspNetCore

Heroicons that are easy to use in ASP.NET Core MVC as TagHelpers.

Build status Tests codecov NuGet version NuGet downloads

The library is written in C# and released with an MIT license, so feel free to fork or use commercially.

Any feedback is appreciated, please visit the issues page or send me an e-mail.

Download

Binaries of the last build can be downloaded on the AppVeyor CI page of the project.

The library is also published on NuGet.org, install using:

dotnet add package Heroicons.AspNetCore.Mvc.TagHelpers

The package is built for .NET 6 or newer and ASP.NET Core MVC.

Usage

  • Add package to your ASP.NET Core MVC project.
  • Find _ViewImports.cshtml file and add the following line:
@addTagHelper *, Heroicons.AspNetCore.Mvc.TagHelpers
  • In your *.cshtml views, you can then use the icon as tag helper:
<heroicon kind="Solid" name="Envelope" />
  • The kind corresponds to style kind enum, currently, either Solid (24x24) Outline (24x24), Mini (20x20), or Micro (16x16).
  • The name corresponds to individual icons, currently there are over 200 of them. See https://heroicons.com/ for the complete overview.
  • Note that you can easily apply additional attributes (e.g. CSS classes), which makes it great for use with Tailwind CSS:
<heroicon class="ml-2 -mr-0.5 h-4 w-4" kind="Solid" name="Envelope" />
  • You can also try the sample project in the tests/ folder to see it running.