html

README

html 🚧

Efficient HTML Tag Assembly

This is a simple library for assembling HTML tags using Go.

b := html.New()

b.Div().Class("wrapper")
b.Div().Class("inner")
b.Form().Attr("action", "my-server")
b.Input().Name("FullName").Value("John Connor").Close()
b.Input().Name("Email").Value("john@connor.mil").Close()
b.CloseAll()
b.String()

Why Builder?

Why not just use Go Templates instead? Templates work great in many cases, but they can be cumbersome when building complex conditional logic. Builder uses an efficient strings.Builder](https://pkg.go.dev/strings#Builder) to assemble the exact HTML you need, and nothing extra.

Pull Requests Welcome

This library is growing rapidly, as the requirements of its downstram projects continue to evolve. How can it help you build your next masterpiece? Add your voice, because we're all in this together! 🚧

Documentation

Index

• type Builder
  • func New() *Builder
  • func (b *Builder) BR() *Element
  • func (builder *Builder) Close() *Builder
  • func (builder *Builder) CloseAll() *Builder
  • func (builder *Builder) Container(name string) *Element
  • func (b *Builder) Div() *Element
  • func (builder *Builder) Element(name string, container bool) *Element
  • func (builder *Builder) Empty(name string) *Element
  • func (b *Builder) Input() *Element
  • func (b *Builder) Label(forID string) *Element
  • func (b *Builder) Span() *Element
  • func (builder *Builder) String() string
  • func (builder *Builder) SubTree() *Builder
• type Element
  • func (element *Element) Attr(name string, value interface{}) *Element
  • func (element *Element) Class(value string) *Element
  • func (element *Element) Close() *Element
  • func (element *Element) EndBracket() *Element
  • func (element *Element) For(value string) *Element
  • func (element *Element) ID(value string) *Element
  • func (element *Element) InnerHTML(innerHTML string) *Element
  • func (element *Element) Name(value string) *Element
  • func (element *Element) Start() *Element
  • func (element *Element) Value(value string) *Element

Types

type Builder

type Builder struct {
	*strings.Builder
	// contains filtered or unexported fields
}

Builder collects tags and attributes into a strings.Builder efficiently.

func New

func New() *Builder

New generates a fully initialized Builder

func (*Builder) BR

func (b *Builder) BR() *Element

func (*Builder) Close

func (builder *Builder) Close() *Builder

Close completes the last tag on the stack, then pops it off of the stack

func (*Builder) CloseAll

func (builder *Builder) CloseAll() *Builder

CloseAll calls .Cload() until the stack is empty.

func (*Builder) Container

func (builder *Builder) Container(name string) *Element

Container creates a new "container" element that WILL have an end tag.

func (*Builder) Div

func (b *Builder) Div() *Element

func (*Builder) Element

func (builder *Builder) Element(name string, container bool) *Element

Element adds a new HTML element to the builder

func (*Builder) Empty

func (builder *Builder) Empty(name string) *Element

Empty creates a new "empty" or non-container element that WILL NOT have an end tag

func (*Builder) Input

func (b *Builder) Input() *Element

func (*Builder) Label

func (b *Builder) Label(forID string) *Element

func (*Builder) Span

func (b *Builder) Span() *Element

func (*Builder) String

func (builder *Builder) String() string

String returns the assembled HTML as a string. It overrides the default behavior of the strings.Builder by also calling CloseAll() on all unclosed tags in the stack before generating HTML.

func (*Builder) SubTree

func (builder *Builder) SubTree() *Builder

SubTree generates a new Builder that shares this Builder's string buffer. This is useful when sending a Builder to another function, so that the other function can maintain it's own stack of elements -- and potentially call .CloseAll() -- without affecting this current builder.

type Element

type Element struct {
	// contains filtered or unexported fields
}

Element represents a element that is being written into the provided strings.Builder

func (*Element) Attr

func (element *Element) Attr(name string, value interface{}) *Element

Attr writes the attribute into the string builder. It converts the value (second parameter) into a string, and then uses html.EscapeString to escape the attribute value. Attribute names ARE NOT escaped.

func (*Element) Class

func (element *Element) Class(value string) *Element

Class adds a "class" attribute to the Element

func (*Element) Close

func (element *Element) Close() *Element

Close writes the necessary closing tag for this element and marks it closed

func (*Element) EndBracket

func (element *Element) EndBracket() *Element

EndBracket writes the final ">" of the beginning element to the strings.Builder It uses an internal variable to prevent duplicate calls

func (*Element) For

func (element *Element) For(value string) *Element

For adds a "for" attribute to the Element

func (*Element) ID

func (element *Element) ID(value string) *Element

ID adds an "id" attribute to the Element

func (*Element) InnerHTML

func (element *Element) InnerHTML(innerHTML string) *Element

InnerHTML does three things: 1) closes the beginning element (if needed) 2) appends innerHTML (if provided) 3) writes an ending element to the builder (ie. </element> )

func (*Element) Name

func (element *Element) Name(value string) *Element

Name adds a "name" attribute to the Element

func (*Element) Start

func (element *Element) Start() *Element

Start writes the initial tag name and opening bracket for this tag.

func (*Element) Value

func (element *Element) Value(value string) *Element

Value adds a "value" attribute to the Element