gomponents

README

gomponents

gomponents are components of DOM nodes for Go, that can render to an HTML Document. gomponents aims to make it easy to build HTML pages of reusable components, without the use of a template language. Think server-side-rendered React, but without the virtual DOM and diffing.

The implementation is still incomplete, but usable. The API may change until version 1 is reached.

Documentation

Overview

Package gomponents provides components of DOM nodes for Go, that can render to an HTML Document. The primary interface is a Node, which has a single function Render, which should render the Node to a string. Furthermore, NodeFunc is a function which implements the Node interface by calling itself on Render. All DOM elements and attributes can be created by using the El and Attr functions. The package also provides a lot of convenience functions for creating elements and attributes with the most commonly used parameters. If they don't suffice, a fallback to El and Attr is always possible.

Index

• type Node
  • func Attr(name string, value ...string) Node
• type NodeFunc
  • func El(name string, children ...Node) NodeFunc
  • func Raw(t string) NodeFunc
  • func Text(t string) NodeFunc
  • func (n NodeFunc) Render() string
  • func (n NodeFunc) String() string

Types

type Node

type Node interface {
	Render() string
}

Node is a DOM node that can Render itself to a string representation.

func Attr

func Attr(name string, value ...string) Node

Attr creates an attr DOM Node. If one parameter is passed, it's a name-only attribute (like "required"). If two parameters are passed, it's a name-value attribute (like `class="header"`). More parameter counts make Attr panic. Use this if no convenience creator exists.

type NodeFunc

type NodeFunc func() string

NodeFunc is render function that is also a Node.

func El

func El(name string, children ...Node) NodeFunc

El creates an element DOM Node with a name and child Nodes. Use this if no convenience creator exists.

func Raw

func Raw(t string) NodeFunc

Raw creates a raw Node that just Renders the unescaped string t.

func Text

func Text(t string) NodeFunc

Text creates a text DOM Node that Renders the escaped string t.

func (NodeFunc) Render

func (n NodeFunc) Render() string

func (NodeFunc) String

func (n NodeFunc) String() string

String satisfies fmt.Stringer.