toasts

Documentation

Index

• Constants
• Variables
• func Success(c *fiber.Ctx, message string, code ...int)
• func Toasts() htmx.Node
• type Toast
  • func Error(message string, code ...int) Toast
  • func Info(message string, code ...int) Toast
  • func New(level string, message string, code ...int) Toast
  • func (t Toast) Error() string
  • func (t Toast) SetHXTriggerHeader(c *fiber.Ctx) error
  • func (t Toast) ToJson() (string, error)
• type ToasterProps

Constants

const (
	// INFO is the info level.
	INFO = "info"
	// SUCCESS is the success level.
	SUCCESS = "success"
	// ERROR is the error level.
	ERROR = "error"
)

Variables

var DefaultErrorHandler = func(c *fiber.Ctx, err error) error {
	code := fiber.StatusInternalServerError

	var te Toast
	if !errors.As(err, &te) {
		te = Error("there has been an unexpected error")
	}

	var e *fiber.Error // if this is not a toast then use the error message
	if errors.As(err, &e) {
		code = e.Code
		te = Error(e.Message)
	}

	if te.Level != SUCCESS {
		htmx.ReSwap(c, "none")
	}

	te.SetHXTriggerHeader(c)

	c.Set(fiber.HeaderContentType, fiber.MIMETextPlainCharsetUTF8)

	return c.Status(code).SendString(err.Error())
}

DefaultErrorHandler is the default error handler for toasts.

Functions

func Success

func Success(c *fiber.Ctx, message string, code ...int)

Success returns a success message.

func Toasts

func Toasts() htmx.Node

Toast is the toast component.

Types

type Toast

type Toast struct {
	// Level is the level of the toast.
	Level string `json:"level"`
	// Message is the message of the toast.
	Message string `json:"message"`
	// Code is the http status code of the toast.
	Code int `json:"code"`
}

Toast is a message to display to the user.

func Error

func Error(message string, code ...int) Toast

Error returns an error message.

func Info

func Info(message string, code ...int) Toast

Info returns an info message.

func New

func New(level string, message string, code ...int) Toast

New returns a new Toast.

func (Toast) Error

func (t Toast) Error() string

Error returns the error message.

func (Toast) SetHXTriggerHeader

func (t Toast) SetHXTriggerHeader(c *fiber.Ctx) error

SetHXTriggerHeader sets the HTMX trigger header.

func (Toast) ToJson

func (t Toast) ToJson() (string, error)

ToJson returns the JSON representation of the toast.

type ToasterProps

type ToasterProps struct {
	// ClassNames are the class names for the toast.
	ClassNames htmx.ClassNames
}

ToasterProps is the properties for the Toaster component.