https://github.com/BlazorOcticons/BlazorOcticons

BlazorOcticons is an easy-to-use GitHub Octicons built as customizable .razor components
https://github.com/BlazorOcticons/BlazorOcticons

blazor blazor-components components-library csharp csharp-sourcegenerator dotnet icons icons-pack iconset octicons razor razor-components

Last synced: 5 months ago
JSON representation

BlazorOcticons is an easy-to-use GitHub Octicons built as customizable .razor components

• Host: GitHub
• URL: https://github.com/BlazorOcticons/BlazorOcticons
• Owner: BlazorOcticons
• License: mit
• Created: 2021-10-31T13:32:26.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-10T07:44:21.000Z (11 months ago)
• Last Synced: 2024-10-12T04:29:10.360Z (6 months ago)
• Topics: blazor, blazor-components, components-library, csharp, csharp-sourcegenerator, dotnet, icons, icons-pack, iconset, octicons, razor, razor-components
• Language: HTML
• Homepage: https://blazorocticons.net/
• Size: 1.15 MB
• Stars: 21
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• csharp-source-generators - BlazorOcticons -   Github [Octicons](https://primer.style/octicons/) created as a `.razor` components using source generator. The generated components are available via the NuGet package, the generator itself is available as a separate NuGet package. The project [website](https://blazorocticons.net/) is an example using the generated components. (Source Generators / Webprogramming)
• awesome-blazor - BlazorOcticons - square&cacheSeconds=604800)  Github [Octicons](https://primer.style/design/foundations/icons/) created as a .razor components using source generator. The generated components are available via the NuGet package, the generator itself is available as a separate NuGet package. The project website is an example using the generated components. (Source generators / Others)
• RSCG_Examples - BlazorOcticons

README

        
[![Backup Status](https://cloudback.it/badge/BlazorOcticons/BlazorOcticons)](https://cloudback.it)

[![.NET](https://github.com/BlazorOcticons/BlazorOcticons/actions/workflows/dotnet.yml/badge.svg)](https://github.com/BlazorOcticons/BlazorOcticons/actions/workflows/dotnet.yml)

[![GitHub](https://img.shields.io/github/license/BlazorOcticons/BlazorOcticons)](https://github.com/BlazorOcticons/BlazorOcticons/blob/main/LICENSE)

[![Nuget (with prereleases)](https://img.shields.io/nuget/vpre/BlazorOcticons?logo=nuget)](https://www.nuget.org/packages/BlazorOcticons)

![image](https://github.com/BlazorOcticons/BlazorOcticons/assets/6689884/30a985b1-0938-4ba7-b0c1-9ced889636d0)

# BlazorOcticons

**BlazorOcticons** is an easy-to-use GitHub Octicons built as customizable `.razor` components.

| NuGet Package           | Description |

|-------------------------|-------------|

| BlazorOcticons          | Main package which contains only `.razor` components |

| BlazorOcticonsGenerator | Helper package which contains Source Generators for Octicons |

## Installation

1. Install the BlazorOcticons NuGet package:

``` 

dotnet add package BlazorOcticons

```

2. In the `_Imports.razor` file add `@using BlazorOcticons.Octicons`:

``` razor

@using System.Net.Http

@using System.Net.Http.Json

...

@using Microsoft.AspNetCore.Components

@using Microsoft.JSInterop

@using BlazorOcticons.Octicons

```

3. That's it! Now you can use the components in your project.

## Usage

Inside your code, use any of GitHub Octicons as `.razor` components:

``` razor



  ...

  

  ...



```


## Contribute

All contributions are welcome! Feel free to raise any issues (bugs or feature requests), submit pull requests, etc.