friend-to-net-web-developers/FriendToNetWebDevelopers.HtmlAttributeDictionaryv1.2.3
.NET 8.0.NET 9.0.NET 10.0
A helper for those who need to dynamically generate an html tag safely
Get Started
$ dotnet add package FriendToNetWebDevelopers.HtmlAttributeDictionaryReadme
HTML Attribute Dictionary
Summary
A dictionary which extends Dictionary<string,string> and provides html attribute and value safety features.
Some of these can change regularly. Please see the CHANGELOG.md file for more details.
Installation
Install-Package FriendToNetWebDevelopers.HtmlAttributeDictionary
Usage
How?
Add the following to your _ViewImports.cshtml
@using FriendToNetWebDevelopers.HtmlAttributeDictionary
@addTagHelper *, FriendToNetWebDevelopers.HtmlAttributeDictionary
This is the simplest use case I could come up with.
@{ // Please note the multiple classes being brought in
// Along with your id ↓ ↓
// ↓ ↓ ↓
var dictionary = HtmlAttributeDictionaryFactory.WithId("foo", "some-hero bar");
if(needsScrim)
{
dictionary.AddClassToClassAttribute("hero-scrim");
}
}
<section>
<!-- Produces the div for the hero with or without the "hero-scrim" class, as needed. -->
<div html-attributes="dictionary">
<!-- ... -->
</div>
</section>
-or just with classes-
@{
var dictionary = HtmlAttributeDictionaryFactory.WithClasses("some-hero bar");
if(needsScrim)
{
dictionary.AddClassToClassAttribute("hero-scrim");
}
}
<section>
<!-- Produces the div for the hero with or without the "hero-scrim" class, as needed. -->
<!-- An alternative way to use the dictionary -->
<div @Html.Raw(dictionary)>
<!-- ... -->
</div>
</section>
But can be initialized in the following ways as well.
//Provides an empty dictionary
var dictionary = HtmlAttributeDictionaryFactory.Get();
//ALSO provides an empty dictionary
dictionary = new HtmlAttributeDictionary();
//Follows the safety procedures to attempt to bring in the attributes from a different type of dictionary
var someOtherDictionary = new Dictionary<string, string>();
dictionary = new HtmlAttributeDictionary(someOtherDictionary);
//Follows the safety procedures to attempt to bring in the attributes from a list of key-value-pairs
var list = new KeyValuePair<string,string>();
dictionary = new HtmlAttributeDictionary(list);
