webgen

webgen

Write component views and styles in HTML files, and webgen generates webapi package Go code to construct the components for the js/wasm architecture.

Inspired by tomato.

For documentation, see below.

For command line help text, including example invocations, run webgen -h.

Why?

Constructing DOM with webapi.GetDocument().CreateElement/AppendChild is tedious, looks ugly, and makes it difficult to verify correctness.

Instead, define your components in HTML (which doesn't have the above drawbacks) and generate Go types and constructor functions for the components.

Install

go get github.com/littleroot/webgen/cmd/webgen

Documentation

Contents

• Basics: An overview
• The ref attribute: Obtain a reference to an element
• The <include> element: Composition of components
• The Roots method: Access the top-level element(s) of a component

Basics

webgen generates Go code corresponding to components specified in input .html files. The generated Go code uses the webapi package and its subpackages. A component file can optionally include CSS for the component in a top-level <style> element at the end of the file. webgen generates a single CSS file that is the concatenation of styles from all input files.

Consider a simple component in Foo.html.

<div class="Foo">DON'T PANIC</div>

<style>
.Foo { font-family: "Inter"; }
</style>

webgen generates the Go type for the component and its constructor. The Go type name is derived from the name of the .html file. If you would like the type and its constructor to be exported, begin the filename with an uppercase letter, akin to naming an exported type in Go. (Hint: Use title-case or camel-case for the filenames to generate idiomatic Go code.)

type Foo struct {
	roots []*dom.Element
}

func NewFoo() *Foo {
	div0 := _document.CreateElement("div", nil)
	div0.SetAttribute("class", "Foo")
	stringliteral0 := "DON'T PANIC"
	div0.SetTextContent(&stringliteral0)
	return &Foo{
		roots: []*dom.Element{div0},
	}
}

func (v *Foo) Roots() []*dom.Element {
	return v.roots
}

As mentioned earlier, webgen also generates CSS output that is the concatenation of styles from all input component files (in this example, just the single file).

.Foo { font-family: "Inter"; }

Use the --outviews and --outcss flags to specify the location to write the generated Go and generated CSS, respectively.

All elements must be closed: either use an explicit end tag (e.g., <input type="text"></input>) or use a self-closing tag (e.g., <input type="text" />)

The ref attribute

Adding a ref attribute to an element allows for easy access to that element from Go code. For instance, you might want a reference to an element in your component in order to set its textContent dynamically or to add an event listener.

<div class="Notification">
	<span ref="Message"></span>
</div>

The generated Go type has a field that is a reference to the element. The field's name is the ref attribute's value. Begin the ref attribute value with an uppercase letter to produce an exported field or with a lowercase letter to produce an unexported field.

type Notification struct {
	Message *html.HTMLSpanElement
	roots []*dom.Element
}

You can then access the element from your application code.

text := "Email archived."
n := NewNotification()
n.Message.SetTextContent(&text)

The <include> element

The <include> element can be used to include another component in the current component. For example:

<div>
	<span>hello, world!</span>
	<include path="path/to/otherComponent.html" />
</div>

The contents of the component at path/to/otherComponent.html will replace the <include> element in the generated code.

The path attribute is required. It can either be a relative path (not starting with /) or an absolute path (starting with /). If a relative path is used, it is resolved relative to the current component's directory. If an absolute path is used, the path is rooted at the value specified by the --root flag.

An <include> element may also optionally have a ref attribute.

The Roots method

The generated component types satisfy this Go interface. (The interface type is not defined in this package; you may define it yourself if you wish.)

type Component interface {
	Roots() []*dom.Element
}

The Roots method returns the top-level elements in a component. (In many cases, there may only be a single top-level element, in which case the list will have a length of 1.)

A few examples:

// Append the Select component inside a <form>.
form := webapi.GetDocument().CreateElement("form", nil)
sel := NewSelect()
form.AppendChild(&sel.Roots()[0].Node)

// Append the <li> elements from a component as children to a <ul> element.
ul := webapi.GetDocument().CreateElement("ul", nil)
items := NewItems()
for _, r := range items.Roots() {
	ul.AppendChild(&r.Node)
}

If you choose, you may write a generic AppendComponent function.

// AppendComponent appends the given component to the parent node.
func AppendComponent(parent dom.Node, c Component) {
	for _, r := range c.Roots() {
		parent.AppendChild(&r.Node)
	}
}

License

MIT