htmlg

Documentation

Index

• func Send(w http.ResponseWriter, statusCode int, s string) (int, error)
• func SendStringer(w http.ResponseWriter, statusCode int, s Stringer) (int, error)
• type Element
  • func Create(t string, opts ...Modifier) *Element
  • func (e *Element) Apply(opts ...Modifier) *Element
  • func (e *Element) HTMLString() string
  • func (e *Element) Tag() string
• type Fragment
  • func NewFragment(siblings ...Stringer) Fragment
  • func (f Fragment) HTMLString() string
• type Modifier
  • func AddChild(s ...Stringer) Modifier
  • func SetAttr(newAttr [2]string) Modifier
  • func SetAttrs(newAttrs ...[2]string) Modifier
  • func SetTag(t string) Modifier
  • func Style(d ...cssg.Decl) Modifier
  • func WithString(s string) Modifier
  • func WithText(lines ...string) Modifier
  • func Wrap(s ...Stringer) Modifier
• type String
  • func Text(s ...string) String
  • func (s String) HTMLString() string
• type Stringer

Functions

func Send

func Send(w http.ResponseWriter, statusCode int, s string) (int, error)

Send writes a HTML string to the given response writer. It sets the content-type header to "text/html; charset=utf-8" and writes the given status code.

func SendStringer

func SendStringer(w http.ResponseWriter, statusCode int, s Stringer) (int, error)

SendStringer renders and writes a Stringer to the given response writer. It sets the content-type header to "text/html; charset=utf-8" and writes the given status code.

Types

type Element

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

Element represents a HTML element with a tag and optional attribute and inner HTML. Use Create to instanciate an element.

func Create

func Create(t string, opts ...Modifier) *Element

Create instanciates a new Element with the given tag.

func (*Element) Apply

func (e *Element) Apply(opts ...Modifier) *Element

Apply mutates this element using the given modifier(s).

func (*Element) HTMLString

func (e *Element) HTMLString() string

HTMLString returns a valid HTML representation of this element.

func (*Element) Tag

func (e *Element) Tag() string

type Fragment

type Fragment []Stringer

Fragment represents a group of HTMLStringers. This can be several HTML sibling elements.

func NewFragment

func NewFragment(siblings ...Stringer) Fragment

NewFragment returns a fragment made of the given HTMLStringers.

func (Fragment) HTMLString

func (f Fragment) HTMLString() string

HTMLString returns the concatenated underyling HTMLStringers.

type Modifier

type Modifier func(*Element)

Modifier performs a mutation on an element. Eg. Changing its internal state (for ex: adding an attribute)

func AddChild

func AddChild(s ...Stringer) Modifier

func SetAttr

func SetAttr(newAttr [2]string) Modifier

func SetAttrs

func SetAttrs(newAttrs ...[2]string) Modifier

func SetTag

func SetTag(t string) Modifier

func Style

func Style(d ...cssg.Decl) Modifier

Sets the inline style of the element to the given CSS declarations.

func WithString

func WithString(s string) Modifier

func WithText

func WithText(lines ...string) Modifier

func Wrap

func Wrap(s ...Stringer) Modifier

type String

type String string

String represents a literal HTML string.

func Text

func Text(s ...string) String

Text returns an Stringer that returns given strings with <br> tags in between them.

func (String) HTMLString

func (s String) HTMLString() string

HTMLString returns the underlying string without modification.

type Stringer

type Stringer interface {
	HTMLString() string
}

Stringer can generate a valid HTML string.