Sidio.OpenGraph.AspNetCore 1.2.0

Prefix Reserved
dotnet add package Sidio.OpenGraph.AspNetCore --version 1.2.0                
NuGet\Install-Package Sidio.OpenGraph.AspNetCore -Version 1.2.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="1.2.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Sidio.OpenGraph.AspNetCore --version 1.2.0                
#r "nuget: Sidio.OpenGraph.AspNetCore, 1.2.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.
// Install Sidio.OpenGraph.AspNetCore as a Cake Addin
#addin nuget:?package=Sidio.OpenGraph.AspNetCore&version=1.2.0

// Install Sidio.OpenGraph.AspNetCore as a Cake Tool
#tool nuget:?package=Sidio.OpenGraph.AspNetCore&version=1.2.0                

Sidio.OpenGraph

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

build NuGet Version Coverage Status

Sidio.OpenGraph.AspNetCore

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 applications only.

build NuGet Version Coverage Status

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. 
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.

Version Downloads Last updated
1.2.0 81 11/13/2024
1.1.2 97 10/14/2024
1.1.1 141 8/19/2024
1.1.0 123 7/25/2024
1.0.1 89 7/24/2024
1.0.0 102 7/21/2024