goalpinejshandler

README

go-alpinejs-handler

Documentation

Index

• Constants
• func Register(router *http.ServeMux, config *Config)
• func RegisterGlobalStyle(style string)
• func RegisterStyle(name, style string)
• type ActionHandler
• type ChannelMessage
• type Client
  • func (ctx *Client) SendMessage(msg ChannelMessage)
• type Component
• type Config
• type Message
• type MessagePool
  • func (ctx *MessagePool) Add(msg ChannelMessage)
  • func (ctx *MessagePool) Pull() chan ChannelMessage
• type Page
• type Response
• type Tools
  • func (ctx *Tools) GetClientId(req *http.Request) string
  • func (ctx *Tools) HasConnections(clientID string) bool
• type ViewTools
  • func (ctx *ViewTools) Paint(tmpl Component) template.HTML
  • func (ctx *ViewTools) Style(names ...string) template.HTML

Constants

const ContentTypeKey = "Content-Type"

Functions

func Register

func Register(router *http.ServeMux, config *Config)

func RegisterGlobalStyle

func RegisterGlobalStyle(style string)

func RegisterStyle

func RegisterStyle(name, style string)

Types

type ActionHandler

type ActionHandler interface {
	GetName() string
	GetActionType() string
	GetDefaultState() any
	Handle(msg Message, res http.ResponseWriter, req *http.Request, messagePool *MessagePool, tools *Tools)
}

type ChannelMessage

type ChannelMessage struct {
	ClientFilter func(client Client) bool
	Message      Message
}

type Client

type Client struct {
	ID           string
	ConnectionID string
	Response     http.ResponseWriter
	Request      *http.Request
}

func (*Client) SendMessage

func (ctx *Client) SendMessage(msg ChannelMessage)

type Component

type Component interface {
	Name() string
	Render() string
}

type Config

type Config struct {
	EventUrl                string
	ActionUrl               string
	ClientIDHeaderKey       string
	SocketReconnectInterval int
	Pages                   []Page
}

type Message

type Message struct {
	Type    string `json:"type"`
	Payload any    `json:"payload"`
}

type MessagePool

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

func (*MessagePool) Add

func (ctx *MessagePool) Add(msg ChannelMessage)

func (*MessagePool) Pull

func (ctx *MessagePool) Pull() chan ChannelMessage

type Page

type Page interface {
	Component
	Route() string
	Handlers() []ActionHandler
}

type Response

type Response struct {
	Code  int    `json:"code"`
	Error string `json:"error"`
}

type Tools

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

func (*Tools) GetClientId

func (ctx *Tools) GetClientId(req *http.Request) string

func (*Tools) HasConnections

func (ctx *Tools) HasConnections(clientID string) bool

type ViewTools

type ViewTools struct{}

func (*ViewTools) Paint

func (ctx *ViewTools) Paint(tmpl Component) template.HTML

func (*ViewTools) Style

func (ctx *ViewTools) Style(names ...string) template.HTML