html

package

v0.0.32 Latest Latest Go to latest Published: Mar 30, 2023 License: MPL-2.0 Imports: 23 Imported by: 0

Details

Package html contains code relating specifically to the web UI.

View Source

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

This section is empty.

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 Error(w http.ResponseWriter, err string, code int)

func FlashError(w http.ResponseWriter, msg string)

FlashError helper writes a single flash error message

func FlashSuccess(w http.ResponseWriter, msg string)

FlashSuccess helper writes a single flash success message

func FlashWarning(w http.ResponseWriter, msg string)

FlashWarning helper writes a single flash warning message

func MarkdownToHTML(md []byte) template.HTML

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

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

PopFlashes pops all flash messages off the stack

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 SetOrganization(next http.Handler) http.Handler

SetOrganization ensures the session's organization reflects the most recently visited organization route.

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

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

type FlashStack []flash

FlashStack is a stack of flash messages

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

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

Path	Synopsis
paths Package paths provides rails-style path helpers for use with the web app.	Package paths provides rails-style path helpers for use with the web app.