Skip to content

alex-gausman/Octicons.TagHelper

Folders and files

NameName
Last commit message
Last commit date
May 10, 2019
Dec 8, 2022
Mar 24, 2017
Mar 23, 2017
Mar 31, 2017
Mar 31, 2017
Apr 5, 2017
Mar 29, 2017

Repository files navigation

Octicons TagHelper

An ASP.NET Core Tag Helper for GitHub's Octicon icon set.

Setup

  1. Install via NuGet
Install-Package Octicons.TagHelper
  1. Add the tag helper to your view or _ViewImports.cshtml to access from any view.
@addTagHelper *, Octicons.TagHelper

Usage

To render a symbol, use the <octicon> tag.

If you want to optimize your page size, use the sprite sheet tag helper.

  1. Add this to your layout page
<octicon-sprite-sheet></octicon-sprite-sheet>
  1. Add attribute use-sprite to the octicon tag. This will reference the svg path in the sprite sheet
<octicon symbol="Octoface" use-sprite></octicon>

You can go a step further and use the <include> tag to define only those icons that you actually use.

<octicon-sprite-sheet>
    <include symbol="Lock"></include>
    <include symbol="Package"></include>
</octicon-sprite-sheet>

The above markup will create an svg tag with Lock and Package being the only icons on your page.