Sidio.OpenGraph.AspNetCore 2.0.0

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 2.0.0
                    


                    

                
NuGet\Install-Package Sidio.OpenGraph.AspNetCore -Version 2.0.0
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="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Sidio.OpenGraph.AspNetCore" Version="2.0.0" />
                    


                            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 2.0.0
                    


                    

                
#r "nuget: Sidio.OpenGraph.AspNetCore, 2.0.0"
#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. 
#:package Sidio.OpenGraph.AspNetCore@2.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Sidio.OpenGraph.AspNetCore&version=2.0.0
                    


                            Install as a Cake Addin
                        

                    

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


                            Install 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

Dependency injection

Dependency injection is recommended over creating instances of OpenGraphBuilder directly. The AddOpenGraph extension method on IServiceCollection registers the following services:

  • IOpenGraphBuilderFactory: factory for creating OpenGraphBuilder instances.
  • IObjectPoolService<OpenGraphBuilder>: object pool for OpenGraphBuilder instances.
services.AddOpenGraph();

Example:

public class MyClass
{
    private readonly IOpenGraphBuilderFactory _factory;
    private readonly IObjectPoolService<OpenGraphBuilder> _pool;
    
    // use either the factory or the object pool. For demonstration purposes 
    // they are both included here.
    public MyClass(IOpenGraphBuilderFactory factory, IObjectPoolService<OpenGraphBuilder> pool)
    {
        _factory = factory;
        _pool = pool;
    }
    
    // with DI using the factory
    public void Example1()
    {
        var  builder = _factory.CreateBuilder();
        builder.Add(new OpenGraphMetaTag("type", "example"));
        builder.Add("tag2", tag2);
        var openGraph = builder.Build();
    }
    
    // with DI using an object pool
    public void Example2()
    {
        using var borrowedBuilder = _pool.Borrow();
        borrowedBuilder.Instance.Add(new OpenGraphMetaTag("type", "example"));
        borrowedBuilder.Instance.Add("tag2", tag2);
        var openGraph = builder.Instance.Build();
    }
    
    // without DI, not recommended
    public void Example3()
    {
        var builder = new OpenGraphBuilder();
        builder.Add(new OpenGraphMetaTag("tag1", tag1));
        builder.Add("tag2", tag2);
        
        // adding a custom tag with a custom namespace
        builder.Add("mycustomtag", customTag, new OpenGraphNamespace("ab", "https://example.com/ns#"));
        
        var openGraph = builder.Build();
    }
}

Asp.Net Core

Controller:

// the builder pattern
public IActionResult Example1()
{
    this.SetOpenGraph(builder =>
        {
            builder.Add("title", title);
        });
    return View();
}

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

Register tag helper (usually in _ViewImports.cshtml):

@addTagHelper *, Sidio.OpenGraph.AspNetCore

View (e.g. in _Layout.cshtml):


<html prefix="@Html.GetOpenGraphPrefixAttributeValue()">
<head>
  
  <open-graph />
</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.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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