Sidio.OpenGraph.AspNetCore 1.2.3

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Sidio.OpenGraph.AspNetCore --version 1.2.3
                    


                    

                
NuGet\Install-Package Sidio.OpenGraph.AspNetCore -Version 1.2.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Sidio.OpenGraph.AspNetCore" Version="1.2.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Sidio.OpenGraph.AspNetCore" Version="1.2.3" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Sidio.OpenGraph.AspNetCore" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Sidio.OpenGraph.AspNetCore --version 1.2.3
                    


                    

                
#r "nuget: Sidio.OpenGraph.AspNetCore, 1.2.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=Sidio.OpenGraph.AspNetCore&version=1.2.3
                    


                            Install Sidio.OpenGraph.AspNetCore as a Cake Addin
                        

                    

                
#tool nuget:?package=Sidio.OpenGraph.AspNetCore&version=1.2.3
                    


                            Install Sidio.OpenGraph.AspNetCore as a Cake Tool

Sidio.OpenGraph

Sidio.OpenGraph is a .NET library for creating OpenGraph tags. Both .NET Standard 2.0 and .NET 8+ are supported.

Sidio.OpenGraph Sidio.OpenGraph.AspNetCore
NuGet NuGet Version NuGet Version
Requirements .NET Standard 2.0 .NET 8+, AspNetCore

build Coverage Status

ASP .NET Core support

Sidio.OpenGraph.AspNetCore provides the same functionality as Sidio.OpenGraph, but it has some helper functions to make it easier to use in an ASP.NET Core application. This library can be used in .NET 8 or higher applications only.

Installation

Get this package on NuGet:

Usage

Builder pattern

The OpenGraphBuilder class is used to create an OpenGraph object:

var builder = new OpenGraphBuilder();
builder.Add(new OpenGraphMetaTag("tag1", tag1));
builder.Add("tag2", tag2);
builder.Add("mycustomtag", customTag, new OpenGraphNamespace("ab", "https://example.com/ns#"));

var openGraph = builder.Build();

Dependency injection

When using dependency injection, add the IOpenGraphBuilderFactory to the service collection by using the following line of code. The advantage of using dependency injection is that an ILogger is injected in the builder which can provides some useful insights.

services.AddOpenGraph();

Example:

public class MyClass
{
    private readonly IOpenGraphBuilderFactory _factory;
    
    public MyClass(IOpenGraphBuilderFactory factory)
    {
        _factory = factory;
    }
    
    public void Example()
    {
        var  builder = _factory.CreateBuilder();
        builder.Add(new OpenGraphMetaTag("type", "example"));
        var openGraph = builder.Build();
    }
}

Asp.Net Core

Controller:

public IActionResult Example1()
{
    this.SetOpenGraph(myOpenGraphObject);
    return View();
}

public IActionResult Example2()
{
    this.SetOpenGraph("Home", "website", "https://example.com/image.jpg", "https://example.com/");   
    return View();
}

View:

<html prefix="@Html.GetOpenGraphPrefixAttributeValue()">
<head>
  @Html.RenderOpenGraphTags()
</head>

References

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

https://github.com/marthijn/Sidio.OpenGraph/releases