OpenGraph-Net 4.0.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package OpenGraph-Net --version 4.0.0                

                    
                

            
NuGet\Install-Package OpenGraph-Net -Version 4.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="OpenGraph-Net" Version="4.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add OpenGraph-Net --version 4.0.0                

                    
                

            
#r "nuget: OpenGraph-Net, 4.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. 
// Install OpenGraph-Net as a Cake Addin
#addin nuget:?package=OpenGraph-Net&version=4.0.0

// Install OpenGraph-Net as a Cake Tool
#tool nuget:?package=OpenGraph-Net&version=4.0.0

OpenGraphNet

Build Nuget V Nuget dl License Contributor Covenant gitter

All Contributors

A simple .net assembly to use to parse Open Graph information from either a URL or an HTML snippet. You can read more about the Open Graph protocol @ http://ogp.me.

Support the library

If you find this library useful, buy me a coffee!

Usage

These are the basic operations of the OpenGraphNet parser.

Parsing from a URL

Use async/await to parse a URL:

OpenGraph graph = await OpenGraph.ParseUrlAsync("https://open.spotify.com/user/er811nzvdw2cy2qgkrlei9sqe/playlist/2lzTTRqhYS6AkHPIvdX9u3?si=KcZxfwiIR7OBPCzj20utaQ");

Accessing Values

Accessing Metadata

Each metadata element is stored as an array. Additionally, each element's properties are also stored as an array.

<meta property="og:image" content="http://example.com/img1.png">
<meta property="og:image:width" content="30">
<meta property="og:image" content="http://example.com/img2.png">
<meta property="og:image:width" content="60">
<meta property="og:locale" content="en">
<meta property="og:locale:alternate" content="en_US">
<meta property="og:locale:alternate" content="en_GB">

You would access the values from the sample HTML above as:

graph.Metadata["og:image"].First().Value; // "http://example.com/img1.png"
graph.Metadata["og:image"].First().Properties["width"].Value(); // "30"
graph.Metadata["og:image"][1].Value; // "http://example.com/img2.png"
graph.Metadata["og:image"][1].Properties["width"].Value(); // "30"
graph.Metadata["og:locale"].Value(); // "en"
graph.Metadata["og:locale"].First().Properties["alternate"][0].Value; // "en_US"
graph.Metadata["og:locale"].First().Properties["alternate"][1].Value; // "en_GB"
Basic Metadata

The four required Open Graph properties for all pages are available as direct properties on the OpenGraph object.

  • graph.Type is a shortcut for graph.Metadata["og:type"].Value()
  • graph.Title is a shortcut for graph.Metadata["og:title"].Value()
  • graph.Image is a shortcut for graph.Metadata["og:image"].Value()
  • Note: since there can be multiple images, this helper returns the URI of the first image. If you want to access images or child properties like og:image:width then you should instead use the graph.Metadata dictionary.*
  • graph.Url is a shortcut for graph.Metadata["og:url"].Value()
Misc

The original URL used to generate the OpenGraph data is available from the OriginalUrl property graph.OriginalUrl.

Creating OpenGraph Data

To create OpenGraph data in memory use the following code:

var graph = OpenGraph.MakeGraph(
    title: "My Title", 
    type: "website", 
    image: "http://example.com/img/img1.png", 
    url: "http://example.com/home", 
    description: "My Description", 
    siteName: "Example.com");
graph.AddMetadata("og", "image", "http://example.com/img/img2.png");
graph.Metadata["og:image"][0].AddProperty("width", "30");
graph.Metadata["og:image"][1].AddProperty("width", "60");
System.Console.Write(graph.ToString());

The previous System.Console.Write(graph.ToString()); will produce the following HTML (formatting added for legibility):

<meta property="og:title" content="My Title">
<meta property="og:type" content="website">
<meta property="og:image" content="http://example.com/img/img1.png">
<meta property="og:image:width" content="30">
<meta property="og:image" content="http://example.com/img/img2.png">
<meta property="og:image:width" content="60">
<meta property="og:url" content="http://example.com/home">
<meta property="og:description" content="My Description">
<meta property="og:site_name" content="Example.com">

Parsing Namespaces

The component now knows about the 13 namespaces listed below. When parsing a url or a HTML document, OpenGraph.Net will now read and use those namespaces from either the <html> or <head> tags. The parser is now smart enough to include the namespaces when none are included in those tags by extracting it from the meta[property] value directly.

If there are any additional standard/supported namespaces that I am missing, please shoot me a comment or a pull request with the missing items.

Adding Custom Namespaces

You can now add custom namespaces to the parser. Simply make the following call:

NamespaceRegistry.Instance.AddNamespace(
    prefix: "gah",
    schemaUri: "http://wwww.geoffhorsey.com/ogp/brain#",
    requiredElements: new[] { "brain" });

Doing the above will allow the parser to understand the following HTML snippet:

<meta property="gah:brain" content="http://www.geoffhorsey.com/my-brain">
<meta property="gah:brain:size" content="tiny">

and the graph:

graph.Metadata["gah:brain"].Value() // "http://www.geoffhorsey.com/my-brain"
graph.Metadata["gah:brain"].First().Properties["size"].Value() // "tiny"

Writing out OpenGraph Namespaces

In the wild web sites seem to add their OpenGraph namespaces in one of 2 ways. They either write the namespaces in the html as xmlns attributes or within the head tag in the prefix attribute.

  • <html xmlns:og="http://ogp.me/ns#" xmlns:product="http://ogp.me/ns/product#">
  • <head prefix="og: http://ogp.me/ns# product: http://ogp.me/ns/product#">

xmlns: version in the html tag

To create the html version in an cshtml page after creating a new graph, use the following code:

<html @graph.HtmlXmlnsValues>

Would produce the following:

<html xmlns:og="http://ogp.me/ns#" xmlns:product="http://ogp.me/ns/product#">
prefix version in the <head> tag

To create the head version in a cshtml page, after create a new graph, use the following code:

<head prefix="@graph.HeadPrefixAttributeValue">

Would produce the following:

<head prefix="og: http://ogp.me/ns# product: http://ogp.me/ns/product#">

Writing out OpenGraph Metadata to the head tag

Below is a complete example to write out a OpenGraph metadata to a page:

@{
    var graph = OpenGraph.MakeGraph(
        title: "My Title", 
        type: "website", 
        image: "http://example.com/img/img1.png", 
        url: "http://example.com/home", 
        description: "My Description", 
        siteName: "Example.com");
}
<html>
<head prefix="@graph.HeadPrefixAttributeValue">
    @graph.ToString()
</head>
<body>
    
</body>
</html>

will produce the following HTML:

<html>
<head prefix="og: http://ogp.me/ns#">
    <meta property="og:title" content="My Title">
    <meta property="og:type" content="website">
    <meta property="og:image" content="http://example.com/img/img1.png">
    <meta property="og:url" content="http://example.com/home">
    <meta property="og:description" content="My Description">
    <meta property="og:site_name" content="Example.com">
</head>
<body>
    
</body>
</html>

It's FOSS

So please don't be afraid to fork me.

Contribution Guide

  1. Fork the OpenGraph-Net repository
  2. Create a feature branch for the item you are going to add.
  3. Add your awesome code and your unit tests to cover the new feature
  4. Run all of the tests to ensure everything is still passing.
  5. Create a pull request to our develop branch.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<table> <tr> <td align="center"><a href="http://www.geoffhorsey.com/"><img src="https://avatars.githubusercontent.com/u/448706?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Geoff</b></sub></a><br /><a href="https://github.com/ghorsey/OpenGraph-Net/commits?author=ghorsey" title="Code">💻</a> <a href="https://github.com/ghorsey/OpenGraph-Net/commits?author=ghorsey" title="Documentation">📖</a> <a href="#ideas-ghorsey" title="Ideas, Planning, & Feedback">🤔</a> <a href="#platform-ghorsey" title="Packaging/porting to new platform">📦</a> <a href="#projectManagement-ghorsey" title="Project Management">📆</a> <a href="https://github.com/ghorsey/OpenGraph-Net/commits?author=ghorsey" title="Tests">⚠️</a></td> <td align="center"><a href="https://osbeck.com/"><img src="https://avatars.githubusercontent.com/u/982752?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Per Osbäck</b></sub></a><br /><a href="https://github.com/ghorsey/OpenGraph-Net/commits?author=perosb" title="Code">💻</a></td> </tr> </table>

This project follows the all-contributors specification. Contributions of any kind welcome!

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on OpenGraph-Net:

Package Downloads
RestCms.Api.NETCore

This is the main REST CMS API package. This package contains initialization code, controllers, filters and core middleware required to run the REST CMS client API.
Zen.Web.App

WebApp-related abstration layer for Zen
Wechaty

dotnet wechaty
ImageWizard.OpenGraph

Image processing middleware based on ASP.NET and ImageSharp / SkiaSharp / SvgNet.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.2-alpha.0.6 4,035 11/14/2022
4.0.1 214,051 8/12/2022
4.0.1-alpha.0.3 120 8/12/2022
4.0.1-alpha.0.2 127 8/12/2022
4.0.1-alpha.0.1 122 8/12/2022
4.0.0 5,133 8/12/2022
3.2.9-alpha.0.21 119 8/12/2022
3.2.9-alpha.0.20 122 8/12/2022
3.2.9-alpha.0.16 118 8/12/2022
3.2.9-alpha.0.15 123 8/12/2022
3.2.9-alpha.0.14 124 8/12/2022
3.2.9-alpha.0.10 116 8/12/2022
3.2.9-alpha.0.4 898 7/27/2021
3.2.9-alpha.0.3 221 7/27/2021
3.2.9-alpha.0.2 236 7/27/2021
3.2.8 167,688 7/27/2021
3.2.7 4,318 6/8/2021
3.2.7-alpha.0.40 166 6/8/2021
3.2.7-alpha.0.39 166 6/8/2021
3.2.7-alpha.0.38 175 6/8/2021
3.2.7-alpha.0.37 167 6/8/2021
3.2.7-alpha.0.35 176 6/8/2021
3.2.7-alpha.0.34 174 6/8/2021
3.2.6 32,461 1/28/2021
3.2.5 443 1/28/2021
3.2.4 69,678 3/24/2020
3.2.3 2,249 2/26/2020
3.2.2 585 2/26/2020
3.2.1 15,963 2/7/2020
3.2.0 14,754 6/15/2019
3.1.2 41,718 3/16/2019
3.1.1 887 2/28/2019
3.1.0 2,081 1/18/2019
3.0.0 13,804 12/5/2018
2.2.0 37,660 5/10/2018
2.0.0 1,327 5/2/2018
1.3.4 64,441 8/17/2016
1.3.3 1,217 8/16/2016
1.3.2 1,290 8/15/2016
1.3.1 1,275 8/15/2016
1.3.0.1 6,795 6/30/2016
1.2.0.1 8,385 4/2/2013

Removed non-async methods.  Updated Package to .net 6 and removed older framework support.  Use version 3 for older support.