README
¶
gotml
gotml is a component-based HTML templating library for Go. It allows you to create and render HTML structures using a component-oriented approach, offering an alternative to Go's built-in template package. With gotml, you can define reusable components and compose HTML elements in a more modular and expressive way.
Overview
Why Use gotml?
-
Component-Based Approach: Unlike Go templates, which are primarily text-based and less modular,
gotmlenables you to define components as functions. This allows for better reuse and organization of HTML structures. -
Reduce Nesting: In Go templates, refactors can easily create merge conflicts due to deep nesting of HTML. In contrast,
gotml -
Dynamic Composition: Easily compose complex HTML structures by combining simple components.
gotmlsupports variadic parameters for components, making it straightforward to include multiple children or attributes. -
Improved Readability:
gotml’s approach helps to maintain readability by separating concerns into manageable components, avoiding the verbosity and complexity often found in traditional template-based HTML generation.
Basic Usage: Define a tree structure
You can define a simple tree structure just like HTML or other frameworks.
package main
import (
"fmt"
g "github.com/philip-peterson/gotml"
)
func main() {
ctx := g.Bag{}
var App g.Component = func(attrs *g.AttrList, children ...g.GotmlTree) g.GotmlTree {
return g.Tree("html").Children(
g.Tree("head"),
g.Tree("body").Children(
g.Tree("div").
Attr("style", "color: red").
Children("Lorem ipsum"),
g.Tree("hr"),
g.Tree("div").Children("Hello world"),
),
)
}
myTree := g.Tree(App)
result := g.Render(ctx, myTree)
fmt.Println(result)
}
The output*:
<html>
<head />
<body>
<div style="color: red">
Lorem ipsum
</div>
<hr />
<div>
Hello world
</div>
</body>
</html>
Advanced Usage: Passing through Children
Define a component with attributes and children:
package main
import (
"fmt"
g "github.com/philip-peterson/gotml"
)
func main() {
var BorderedDiv g.Component = func(attrs *g.AttrList, children ...g.GotmlTree) g.GotmlTree {
return g.Tree("div").
Attr("style", "border: 3px double black").
Children(
g.AsAny(children)...,
)
}
}
Note that due to Go's quirk where it cannot convert a slice of a type, []T to a slice of any, []any without help, we use g.AsAny(...) to perform this conversion.
Now, we can render the component to HTML:
myTree := g.Tree(BorderedDiv).Children(
g.Tree("p").Children("Hello, world!"),
)
result := g.Render(ctx, myTree)
fmt.Println(result)
Creating the output*:
<div style="border: 3px double black">
<p>
Hello, world!
</p>
</div>
The full program is therefore as follows:
package main
import (
"fmt"
g "github.com/philip-peterson/gotml"
)
func main() {
var BorderedDiv g.Component = func(attrs *g.AttrList, children ...g.GotmlTree) g.GotmlTree {
return g.Tree("div").
Attr("style", "border: 3px double black").
Children(
g.AsAny(children)...,
)
}
ctx := map[string]interface{}{}
myTree := g.Tree(BorderedDiv).Children(
g.Tree("p").Children("Hello, world!"),
)
result := g.Render(ctx, myTree)
fmt.Println(result)
}
For more detailed usage and examples, please see the tests.
* Output has been prettified for readability.
Documentation
¶
Overview ¶
You can edit this code! Click here and start typing.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Source Files