html

Documentation

Overview

Package html contains code relating specifically to the web UI.

Index

• Constants
• func AddStaticHandler(r *mux.Router, devMode bool)
• func AssertRedirect(t *testing.T, w *httptest.ResponseRecorder, path string)
• func CurrentOrganization(content any) *string
• func Error(w http.ResponseWriter, err string, code int)
• func FlashError(w http.ResponseWriter, msg string)
• func FlashSuccess(w http.ResponseWriter, msg string)
• func FlashWarning(w http.ResponseWriter, msg string)
• func MarkdownToHTML(md []byte) template.HTML
• func NewViewEngine(devmode bool) (*viewEngine, error)
• func PopFlashes(w http.ResponseWriter, r *http.Request) ([]flash, error)
• func ReturnUserOriginalPage(w http.ResponseWriter, r *http.Request)
• func SendUserToLoginPage(w http.ResponseWriter, r *http.Request)
• func SetCookie(w http.ResponseWriter, name, value string, expiry *time.Time)
• func UIRouter(r *mux.Router) *mux.Router
• type FlashStack
  • func (s *FlashStack) Push(t flashType, msg string)
  • func (s FlashStack) Write(w http.ResponseWriter)

Constants

const (
	FlashSuccessType flashType = "success"
	FlashWarningType flashType = "warning"
	FlashErrorType   flashType = "error"
)

Functions

func AddStaticHandler

func AddStaticHandler(r *mux.Router, devMode bool)

AddStaticHandler adds a handler to router serving static assets (JS, CSS, etc) from within go binary. Dev mode sources files from local disk instead.

func AssertRedirect

func AssertRedirect(t *testing.T, w *httptest.ResponseRecorder, path string)

func CurrentOrganization

func CurrentOrganization(content any) *string

CurrentOrganization is a UI helper that is used to show the current organization on the web page.

func Error

func Error(w http.ResponseWriter, err string, code int)

func FlashError

func FlashError(w http.ResponseWriter, msg string)

FlashError helper writes a single flash error message

func FlashSuccess

func FlashSuccess(w http.ResponseWriter, msg string)

FlashSuccess helper writes a single flash success message

func FlashWarning

func FlashWarning(w http.ResponseWriter, msg string)

FlashWarning helper writes a single flash warning message

func MarkdownToHTML

func MarkdownToHTML(md []byte) template.HTML

func NewViewEngine

func NewViewEngine(devmode bool) (*viewEngine, error)

func PopFlashes

func PopFlashes(w http.ResponseWriter, r *http.Request) ([]flash, error)

PopFlashes pops all flash messages off the stack

func ReturnUserOriginalPage

func ReturnUserOriginalPage(w http.ResponseWriter, r *http.Request)

ReturnUserOriginalPage returns a user to the original page they tried to access before they were redirected to the login page.

func SendUserToLoginPage

func SendUserToLoginPage(w http.ResponseWriter, r *http.Request)

SendUserToLoginPage sends user to the login prompt page, saving the original page they tried to access so it can return them there after login.

func SetCookie

func SetCookie(w http.ResponseWriter, name, value string, expiry *time.Time)

SetCookie sets a cookie on the http response. A nil expiry sets no expiry, and a zero expiry sets it to be purged from the browser.

func UIRouter

func UIRouter(r *mux.Router) *mux.Router

UIRouter wraps the given router with a router suitable for web UI routes.

Types

type FlashStack

type FlashStack []flash

FlashStack is a stack of flash messages

func (*FlashStack) Push

func (s *FlashStack) Push(t flashType, msg string)

func (FlashStack) Write

func (s FlashStack) Write(w http.ResponseWriter)