html

Documentation

Overview

Package html provides an HTML string renderer backend for the gui library.

Index

• Variables
• type Renderer
  • func New() *Renderer
  • func (r *Renderer) Render(node gui.Node, w io.Writer) error
  • func (r *Renderer) RenderString(node gui.Node) string

Variables

var ErrMaxDepth = errors.New("html: maximum render depth exceeded")

ErrMaxDepth is returned when the node tree exceeds maxRenderDepth levels.

Types

type Renderer

type Renderer struct{}

Renderer renders a gui.Node tree to HTML strings. It resolves functional and stateful components via gui.Resolve before traversing, so callers do not need to resolve manually.

Renderer implements the gui.Renderer interface; the compile-time check is in html_test.go.

func New

func New() *Renderer

New creates a new HTML Renderer.

func (*Renderer) Render

func (r *Renderer) Render(node gui.Node, w io.Writer) error

Render resolves components in node and writes the resulting HTML to w. It returns the first write error encountered, if any. Returns ErrMaxDepth if the tree exceeds 512 levels of nesting.

func (*Renderer) RenderString

func (r *Renderer) RenderString(node gui.Node) string

RenderString returns the node tree rendered as an HTML string. Any write errors are silently discarded because strings.Builder never returns an error.