C# package with a HTML DSL and support for generating HTML elements and serializing object graphs to HTML
This project is a dead simple and dependency free package to work with HTML elements from C# code.
In addition, there is support for serializing objects and graphs of objects to HTML.
Lots of elements and attributes are implemented, and you can generate missing elements/attributes at run time by specifying element/attribute names.
Writing out non-standard / non-safe HTML code is also supported.
Various helper methods are available to make it easy to work with attributes and elements.
See the test classes for more info.
Requirements: .Net Core 6.0 or later.
Dependencies: None.
Nuget link: https://www.nuget.org/packages/DV8.Html/
Usage:
dotnet add package DV8.Html
using static DV8.Html.Prefixes.Underscore;
...
var fruits = new[] { "Apple", "Banana", "Cherry" };
var html =
_<Html>(
_<Head>(
_<Title>("Hello, World!")
),
_<Body>(
_<H1>("Hello, World!"),
_<P>(
_("This is a paragraph with <>. "), // Becomes plain text, not an element. Text is escaped.
_<Ul>(
fruits.Select(_<Li>)
)
),
_UNSAFE("This will not be <b>escaped</b>") // Allows any HTML, don't use this with untrusted content.
)
);
var act = html.ToHtml();
var exp = @"
<!DOCTYPE html><html>
<head><title>Hello, World!</title></head>
<body><h1>Hello, World!</h1><p>This is a paragraph with <>. <ul><li>Apple</li><li>Banana</li><li>Cherry</li></ul></p>
This will not be <b>escaped</b>
</body></html>";
// "Canonical" strips linebreaks, whitespace between elements, and uses ' instead of " as attribute delimiter.
Assert.AreEqual(exp.Canonical(), act).Canonical();
var fruits = new[] { "Apple", "Banana", "Cherry" }
.Select( f => new A( $"https://fruits.org/{f}));
var ul = new Ul(fruits)
.WithClass("the-fruits");
ul.Attributes["my-attribute"] = "my-value";
ul.Properties["my-property"] = myFruitCollectionObject;
var p = new P("This is a paragraph with <>. ", ul);
var ulHtml = ul.ToHtml()
Use ToXml instead of ToHtml if you want the output to be
correct XML. This uses the .Net XmlWriter class and is
probably safer and faster, however it will always close elements,
so an input becomes <input ... /> instead of <input ...>.
In addition, it will use " instead of ' as attribute delimiter.
Example code for serializing objects to HTML (recursive to max 3 levels into properties)
var ser = HtmlSerializerRegistry.AddDefaults(new HtmlSerializerRegistry());
var elements = HtmlSerializer.Serialize(myListOrCustomObjectOrWhatever, 3);
This serializer can also be added as a HtmlOutputFormatter in Asp.Net, easily making all your JSON-APIs available as straight, human-readable HTML.
Documentation TBA :)
In the very unlikely event that anybody actually is interested in this project: Let me know (starring it on github is enough) and I'll improve documentation and samples :) Issues and pull requests are also welcome.