abrenderer

README

authboss-renderer

Completely basic renderer to start out with authboss.

Documentation

Overview

Package abrenderer implements a basic template renderer for a web app for both html responses and both or either html/txt e-mail rendering.

Package abrenderer implements a basic html/template renderer for an app.

Index

• func Asset(name string) ([]byte, error)
• func AssetDigest(name string) ([sha256.Size]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func AssetString(name string) (string, error)
• func Digests() (map[string][sha256.Size]byte, error)
• func MustAsset(name string) []byte
• func MustAssetString(name string) string
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type Email
  • func NewEmail(mountPath, overridePath string) *Email
  • func (e *Email) Load(names ...string) error
  • func (e *Email) Render(ctx context.Context, page string, data authboss.HTMLData) (output []byte, contentType string, err error)
• type HTML
  • func NewHTML(mountPath string, overridePath string) *HTML
  • func (h *HTML) Load(names ...string) error
  • func (h *HTML) Render(ctx context.Context, page string, data authboss.HTMLData) (output []byte, contentType string, err error)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDigest

func AssetDigest(name string) ([sha256.Size]byte, error)

AssetDigest returns the digest of the file with the given name. It returns an error if the asset could not be found or the digest could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"}, AssetDir("data/img") would return []string{"a.png", "b.png"}, AssetDir("foo.txt") and AssetDir("notexist") would return an error, and AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func AssetString

func AssetString(name string) (string, error)

AssetString returns the asset contents as a string (instead of a []byte).

func Digests

func Digests() (map[string][sha256.Size]byte, error)

Digests returns a map of all known files and their checksums.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func MustAssetString

func MustAssetString(name string) string

MustAssetString is like AssetString but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory.

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively.

Types

type Email

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

Email renderer for authboss, renders using html/template Allows overrides of the same template names in the same prefixes. For example: If overridePath is /home/authboss/views You could override the confirm_html.tpl by creating a file at /home/authboss/views/email-templates/confirm.html.tpl

This renderer differentiates html and text templates by checking for a suffix _html or _txt in the filename and uses the appropriate template library for the file type.

func NewEmail

func NewEmail(mountPath, overridePath string) *Email

NewEmail renderer

func (*Email) Load

func (e *Email) Load(names ...string) error

Load a template

func (*Email) Render

func (e *Email) Render(ctx context.Context, page string, data authboss.HTMLData) (output []byte, contentType string, err error)

Render a view

type HTML

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

HTML renderer for authboss, renders using html/template Allows overrides of the same template names in the same prefixes. For example: If overridePath is /home/authboss/views You could override the login.tpl by creating a file at /home/authboss/views/html-templates/login.tpl

func NewHTML

func NewHTML(mountPath string, overridePath string) *HTML

NewHTML renderer

func (*HTML) Load

func (h *HTML) Load(names ...string) error

Load a template

func (*HTML) Render

func (h *HTML) Render(ctx context.Context, page string, data authboss.HTMLData) (output []byte, contentType string, err error)

Render a view