daz

README

daz

Composable HTML components in Golang

Daz is a "functional" alternative to using templates, and allows for nested components/lists Also enables template-free server-side rendered components with support for nested lists. It is inspired by HyperScript.

A component can be created and used with simple functions:

// Example prop for a component
type User struct {
	Name string
	// ...
}

func MyComponenet(user User) func() string {
	return H(
		"div",
		Attr{"class": "bg-grey-50"},
		user.Name,
	)
}

func Root() func() string {
	user := User{Name: "Daz"}
	html := H("html", MyComponenet(user))
}

// And used in a handler:

func Handler(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte(Root()))
}

Lists can be easily created without needing to embed a range / end in a template:

items := []func() string{
	H("li", "item one"),
	H("li", "item two"),
}

element := H("ul", Attr{"class": "bg-grey-50"}, items)

div := H("div", element)

Install

import (
	"github.com/stevelacy/daz"
)

Usage

func H

Create a HTML element:

H("div", ...attrs)

struct Attr

HTML attributes:

Attr{
	"class": "app",
	"onClick": "javascriptFunc()",
}

func UnsafeContent

This will bypass HTML sanitization and allow for direct injecting

injection := "<script>alert('xss')</script>"
root := H("div", UnsafeContent(injection))
// <script>alert('xss')</script>

Documentation

Overview

Package daz is a library for building composable HTML components in Go. It is a functional alternative to using templates, and allows for nested components/lists.

Daz is a "functional" alternative to using templates, and allows for nested components/lists Also enables template-free server-side rendered components with support for nested lists. It is inspired by https://github.com/hyperhype/hyperscript

Basic usage:

element := H("div", Attr{"class": "bg-grey-50"})

html := H("html", element)

w.Write([]byte(html()))

Lists can be easily created without needing to embed a `range / end` in a template:

items := []func() string{H("li", "item one"), H("li", "item two")}

element := H("ul", Attr{"class": "bg-grey-50"})

div := H("div", element)

Index

• func UnsafeContent(str string) dangerousContents
• type Attr
• type HTML
  • func H(el string, attrs ...interface{}) HTML

Functions

func UnsafeContent

func UnsafeContent(str string) dangerousContents

UnsafeContent allows injection of JS or HTML from functions

Types

type Attr

type Attr map[string]string

Attr is a HTML element attribute <a href="#"> => Attr{"href": "#"}

type HTML

type HTML func() string

func H

func H(el string, attrs ...interface{}) HTML

H is the base HTML func