SharpTemplar 1.0.5

.NET 6.0

dotnet add package SharpTemplar --version 1.0.5

NuGet\Install-Package SharpTemplar -Version 1.0.5

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="SharpTemplar" Version="1.0.5" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add SharpTemplar --version 1.0.5

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: SharpTemplar, 1.0.5"

#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 SharpTemplar as a Cake Addin
#addin nuget:?package=SharpTemplar&version=1.0.5

// Install SharpTemplar as a Cake Tool
#tool nuget:?package=SharpTemplar&version=1.0.5

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

SharpTemplar

SharpTemplar is a library for writing SGML in C#, using delegate nesting. Only HTML is currently implemented, therefor this document demostrates how to use SharpTemplar for writing HTML.

Central types

Type	Description
MarkupState	The abstract representation of the markup.
MarkupSuccess	Markup that is correct.
MarkupFailure	Information on what broke the markup.
Attribute	Represents some SGML attribute such as 'class' or 'id'
ValuedAttribute	Represents some SGML attribute which has been given a value, such as 'class="container"'
Tag	Represents some SGML tag, such as 'div' or 'head'
AttributedTag	Represents som SGML tag, which has been given valued attributes
Element	Represents some SGML tag, which has both been given valued attrubutes and children (i.e. other Elements)

Basic usage

To start working on some HTML, the static method HTML() should be called. This function represenst the <html> tag, and it takes its children as arguments.

Elements starting with lower case are for adding html tags, or text.
Elements stating with upper case are utility, e.g. conditionals and loops.
Attributes start with '@'.

Example

var page = HTML(
  head()(),
  body()(
    p(@class("greeting"))(
      text("Hello world!")
    )
  )
).Build();

Creates the page:

<html>
  <head/>
  <body>
    <p class="greeting">Hello world!</p>
  </body>
</html>

SharpTemplar.HyperText is split into multiple bundles, containing the functionality need for different domains of HTML, for example lists and tables. The most usual tags, attributes etc. are contained in the static class SharpTemplar.HyperText.Base.

SharpTemplar will enforce correct HTML, i.e. tags can only be added in places where they make sense, attributes can only be applied to tags where they make sense and ids must be unique. If any of these rules are broken, a MarkupFailure will be returned, containing information on what went wrong.

Components

Sometimes you might want to create similar structures, multiple times. This can be done by nesting Elements outside of the HTML() call.

Example

Element component = 
  div(@class("container"))(
    p()(text("Im a contained paragraph!"))
  );

var page = MarkupHMTL(
  head()(),
  body()(
    component,
    component
  )
).Build();

Creates the page:

<html>
  <head/>
  <body>
    <div class="container">
      <p>Im a contained paragraph!</p>
    </div>
    <div class="container">
      <p>Im a contained paragraph!</p>
    </div>
  </body>
</html>

Static components might not be that interesting, but parameters can be added to them using the Func<> delegate, like in the following example.

Func<string, Element> component = (name) => 
  div(@class("container"))(
    p()(
      text($"Hello {name}!")
    )
  );

var page = HTML(
  head()(),
  body()(
    component("Bob"),
    component("Alice")
  )
).Build();

Creates the page:

<html>
  <head/>
  <body>
    <div class="container">
      <p>Hello Bob!</p>
    </div>
    <div class="container">
      <p>Hello Alice!</p>
    </div>
  </body>
</html>

Alternativly to using a Func<> for adding parameters to a component, a method could be used.

Example

public Element component(string name) {
  return div(@class("container"))(
    p()(
      text($"Hello {name}!")
    )
  );
}

var page = HTML(
  head()(),
  body()(
    component("Bob"),
    component("Alice")
  )
).Build();

Creates the page:

<html>
  <head/>
  <body>
    <div class="container">
      <p>Hello Bob!</p>
    </div>
    <div class="container">
      <p>Hello Alice!</p>
    </div>
  </body>
</html>

Utility Elements

If( )

Is used to conditionally add an Element or Attribute, depending on a boolean expression. If there is only provided one Element to If() nothing is applied if the boolean is false.

Example

var b = false;
var page = HTML(
  head()(),
  body()(
    If(b, text("true"), text("false"))
  )
).Build();

Creates the page:

<html>
  <head/>
  <body>
    false
  </body>
</html>

Attempt( )

Is used to apply an Element that might throw an exception, and handle those cases without crashing. This can be quite slow, as a clone of the entire markup structure is created, so that all changes made can be rolled back. If only one Element is provided, nothing is applied on an exception. Elements must be provided as Func<Element> i.e. unit functions, to delay their evaluation.

Example

Func<int, Element> component = (divident) => 
  div(@class("container"))(
    p().text($"{100/divident}")
  );

Element failed = 
  div(@class("container"))(
    p()(
      text("Oh no!")
    )
  );

var page = HTML(
  head()(),
  body()(
    Attempt(() => component(2), () => failed),
    Attempt(() => component(0), () => failed)
  )
).Build();

Creates the page:

<html>
  <head/>
  <body>
    <div class="container">
      <p>50</p>
    </div>
    <div class="container">
      <p>Oh no!</p>
    </div>
  </body>
</html>

Range( )

Is used to apply the same Element or Func<int, Element> once for each number in the selected range.

Example

Func<int, Element> component = (number) => 
  div(@class("container"))(
    p()(
      text($"{number}")
    )
  );

var page = HTML(
  head()(),
  body()(
    Range(10, 3, component)
  )
).Build();

Creates the page:

<html>
  <head/>
  <body>
    <div class="container">
      <p>10</p>
    </div>
    <div class="container">
      <p>11</p>
    </div>
    <div class="container">
      <p>12</p>
    </div>
  </body>
</html>

OnList<T>( )

Is used to apply a Func<T,Element> for each element of type T in an IEnumerable<T>.

Example

var names = new List<string>() {"Bob", "Alice"};

Func<string, Element> component = (name) =>
  div(@class("container"))(
    p()(
      text($"Hello {name}!")
    )
  );

var page = HTML(
  head()(),
  body()(
    OnList(names, component)
  )
).Build();

Creates the page:

<html>
  <head/>
  <body>
    <div class="container">
      <p>Hello Bob!</p>
    </div>
    <div class="container">
      <p>Hello Alice!</p>
    </div>
  </body>
</html>

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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- No dependencies.

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.0.5	185	6/21/2023
1.0.4	363	11/6/2022
1.0.3	337	11/5/2022
1.0.2	351	11/5/2022
1.0.1	362	11/4/2022
1.0.0	345	11/3/2022
0.5.2	434	3/23/2022
0.5.1	402	2/25/2022
0.5.0	407	2/24/2022
0.4.1	341	7/2/2021
0.4.0	298	7/2/2021
0.3.0	312	6/12/2021
0.2.2	340	5/20/2021
0.2.1	354	5/20/2021
0.2.0	306	4/20/2021
0.1.1	314	4/19/2021
0.1.0	309	4/19/2021

SharpTemplar 1.0.5

SharpTemplar

Central types

Basic usage

Components

Utility Elements

If( )

Attempt( )

Range( )

OnList<T>( )

net6.0

NuGet packages

GitHub repositories