renderer

Documentation

Index

• type HTMLRender
  • func NewHTMLRenderer(cfg ...HTMLRenderConfig) *HTMLRender
  • func (r *HTMLRender) AddHook(hook RendererHook)
  • func (r *HTMLRender) Render(w http.ResponseWriter, req *http.Request, name string, data map[string]any) hypergon.HypergonError
  • func (r *HTMLRender) RenderPartial(w http.ResponseWriter, name string, data any) hypergon.HypergonError
• type HTMLRenderConfig
• type JSONRenderer
  • func NewJSONRenderer() *JSONRenderer
  • func (r *JSONRenderer) JSON(w http.ResponseWriter, data any) hypergon.HypergonError
• type RendererHook

Types

type HTMLRender

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

HTMLRender accepts templates and a layout that will parse all necessary html files.

func NewHTMLRenderer

func NewHTMLRenderer(cfg ...HTMLRenderConfig) *HTMLRender

The constructor for the HTMLRender.

func (*HTMLRender) AddHook

func (r *HTMLRender) AddHook(hook RendererHook)

Allows adding a hook to modify data globally.

func (*HTMLRender) Render

func (r *HTMLRender) Render(w http.ResponseWriter, req *http.Request, name string, data map[string]any) hypergon.HypergonError

Render renders a html page with layout. The name must unique so it wont be a conflict to other html pages.

func (*HTMLRender) RenderPartial

func (r *HTMLRender) RenderPartial(w http.ResponseWriter, name string, data any) hypergon.HypergonError

RenderPartial renders a partial template without the layout The name must unique so it wont be a conflict to other partial htmls.

type HTMLRenderConfig

type HTMLRenderConfig struct {
	// Layout name declaration.
	// Default: "layout.html"
	Layout string
	// TemplateDirs where you declare where are your html templates are in.
	//
	// Default:  []string{"templates", "templates/partials"}
	TemplateDirs []string

	// Add custom functionality within your html template
	CustomFuncs map[string]any
}

type JSONRenderer

type JSONRenderer struct{}

JSONRenderer object.

func NewJSONRenderer

func NewJSONRenderer() *JSONRenderer

JSONRenderer constructor.

func (*JSONRenderer) JSON

func (r *JSONRenderer) JSON(w http.ResponseWriter, data any) hypergon.HypergonError

JSON functions returns a json response.

type RendererHook

type RendererHook func(http.ResponseWriter, *http.Request, map[string]any)