README
¶
Message Package
The message package provides HTML templating functionality for rendering dynamic web pages.
Usage
Basic Error Page
import (
"net/http"
"github.com/agentuity/go-common/message"
)
func handler(w http.ResponseWriter, r *http.Request) {
message.NotFoundResponse(w)
}
Custom Error Page
import (
"net/http"
"github.com/agentuity/go-common/message"
)
func handler(w http.ResponseWriter, r *http.Request) {
message.CustomErrorResponse(w, "Custom Error", "Something went wrong", "Error details here", http.StatusBadRequest)
}
Using a Template Writer
import (
"net/http"
"github.com/agentuity/go-common/message"
)
func handler(w http.ResponseWriter, r *http.Request) {
tw := message.NewTemplateWriter()
data := message.TemplateData{
Title: "Page Title",
Description: "Page description",
HeaderTitle: "Header Title",
Message: "Page message",
ShowDetails: true,
ErrorDetails: "Error details",
}
tw.Write(w, data, http.StatusOK)
}
Custom Template
import (
"net/http"
"github.com/agentuity/go-common/message"
)
func handler(w http.ResponseWriter, r *http.Request) {
customTemplate := "<!DOCTYPE html><html>...</html>"
tmpl, err := message.WithCustomTemplate(customTemplate)
if err != nil {
// Handle error
}
tw := message.NewTemplateWriter().WithTemplate(tmpl)
data := message.TemplateData{
Title: "Custom Page",
HeaderTitle: "Custom Header",
Message: "Custom message",
}
tw.Write(w, data, http.StatusOK)
}
Documentation
¶
Index ¶
- Variables
- func CustomErrorResponse(w http.ResponseWriter, title string, message string, details string, ...) error
- func ErrorResponse(w http.ResponseWriter, title string, message string, details string, ...) error
- func ErrorResponseWithHTML(w http.ResponseWriter, title string, htmlMessage string, details string, ...) error
- func NotFoundResponse(w http.ResponseWriter) error
- func RenderErrorPage(title, message, details string) (string, error)
- func RenderErrorPageWithHTML(title, htmlMessage, details string) (string, error)
- func RenderHTML(data TemplateData) (string, error)
- func RenderHTMLWithTemplate(tmpl *template.Template, data TemplateData) (string, error)
- func ServerErrorResponse(w http.ResponseWriter, err error) error
- func WithCustomTemplate(tmplContent string) (*template.Template, error)
- type TemplateData
- type TemplateWriter
Constants ¶
This section is empty.
Variables ¶
Functions ¶
func CustomErrorResponse ¶
func ErrorResponse ¶
func ErrorResponseWithHTML ¶
func NotFoundResponse ¶
func NotFoundResponse(w http.ResponseWriter) error
func RenderErrorPage ¶
func RenderErrorPageWithHTML ¶
func RenderHTML ¶
func RenderHTML(data TemplateData) (string, error)
func RenderHTMLWithTemplate ¶
func RenderHTMLWithTemplate(tmpl *template.Template, data TemplateData) (string, error)
func ServerErrorResponse ¶
func ServerErrorResponse(w http.ResponseWriter, err error) error
Types ¶
type TemplateData ¶
type TemplateData struct {
Title string // Page title in <title> tag
Description string // Meta description
HeaderTitle string // H1 title displayed on the page
Message string // Message text displayed below the title (escaped)
RawHTML string // Raw HTML message content (not escaped)
ShowDetails bool // Whether to show the details section
ErrorDetails string // Error details to display in the details section
}
type TemplateWriter ¶
func NewTemplateWriter ¶
func NewTemplateWriter() *TemplateWriter
func (*TemplateWriter) RenderToString ¶
func (tw *TemplateWriter) RenderToString(data TemplateData) (string, error)
func (*TemplateWriter) WithTemplate ¶
func (tw *TemplateWriter) WithTemplate(tmpl *template.Template) *TemplateWriter
func (*TemplateWriter) Write ¶
func (tw *TemplateWriter) Write(w http.ResponseWriter, data TemplateData, statusCode int) error
Source Files
Click to show internal directories.
Click to hide internal directories.