datastar

package module
v0.19.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 25, 2024 License: MIT Imports: 13 Imported by: 0

Documentation

Overview

templ: version: v0.2.778

Index

Constants

View Source 
const (
	FragmentSelectorSelf  = "self"
	FragmentSelectorUseID = ""
	SSEEventTypeFragment  = "datastar-fragment"
	SSEEventTypeSignal    = "datastar-signal"
	SSEEventTypeDelete    = "datastar-delete"
	SSEEventTypeRedirect  = "datastar-redirect"
	SSEEventTypeConsole   = "datastar-console"
)

Variables

View Source 
var ValidFragmentMergeTypes = []FragmentMergeType{
	FragmentMergeMorph,
	FragmentMergeInner,
	FragmentMergeOuter,
	FragmentMergePrepend,
	FragmentMergeAppend,
	FragmentMergeBefore,
	FragmentMergeAfter,
	FragmentMergeUpsert,
}

Functions

func BodySanitize 

func BodySanitize(r *http.Request, sanitizer *sanitize.Sanitizer, store any) error

func BodyUnmarshal 

func BodyUnmarshal(r *http.Request, store any) error

func Console added in v0.19.0 

func Console(sse *ServerSentEventsHandler, Mode ConsoleLogMode, message string)

func ConsoleDebugF added in v0.19.0 

func ConsoleDebugF(sse *ServerSentEventsHandler, format string, args ...interface{})

func ConsoleErrorF added in v0.19.0 

func ConsoleErrorF(sse *ServerSentEventsHandler, format string, args ...interface{})

func ConsoleF added in v0.19.0 

func ConsoleF(sse *ServerSentEventsHandler, Mode ConsoleLogMode, format string, args ...interface{})

func ConsoleGroup added in v0.19.0 

func ConsoleGroup(sse *ServerSentEventsHandler, label string)

func ConsoleGroupEnd added in v0.19.0 

func ConsoleGroupEnd(sse *ServerSentEventsHandler)

func ConsoleInfoF added in v0.19.0 

func ConsoleInfoF(sse *ServerSentEventsHandler, format string, args ...interface{})

func ConsoleLogF added in v0.19.0 

func ConsoleLogF(sse *ServerSentEventsHandler, format string, args ...interface{})

func ConsoleWarnF added in v0.19.0 

func ConsoleWarnF(sse *ServerSentEventsHandler, format string, args ...interface{})

func DELETE 

func DELETE(urlFormat string, args ...any) string

func Delete 

func Delete(sse *ServerSentEventsHandler, selector string, opts ...RenderFragmentOption)

func DeleteFromStore added in v0.19.6 

func DeleteFromStore(sse *ServerSentEventsHandler, paths ...string)

func Error 

func Error(sse *ServerSentEventsHandler, err error)

func GET 

func GET(urlFormat string, args ...any) string

func PATCH 

func PATCH(urlFormat string, args ...any) string

func POST 

func POST(urlFormat string, args ...any) string

func PUT 

func PUT(urlFormat string, args ...any) string

func PatchStore 

func PatchStore(sse *ServerSentEventsHandler, store any)

func PatchStoreIfMissing added in v0.18.3 

func PatchStoreIfMissing(sse *ServerSentEventsHandler, store any)

func PatchStoreIfMissingRaw added in v0.18.3 

func PatchStoreIfMissingRaw(sse *ServerSentEventsHandler, storeJSON string)

func PatchStoreRaw 

func PatchStoreRaw(sse *ServerSentEventsHandler, storeJSON string, opts ...PatchStoreOption)

func QueryStringUnmarshal 

func QueryStringUnmarshal(r *http.Request, store any) error

func Redirect 

func Redirect(sse *ServerSentEventsHandler, url string)

func RedirectF 

func RedirectF(sse *ServerSentEventsHandler, urlFormat string, args ...interface{})

func RenderFragmentGostar 

func RenderFragmentGostar(sse *ServerSentEventsHandler, child elements.ElementRenderer, opts ...RenderFragmentOption) error

func RenderFragmentString 

func RenderFragmentString(sse *ServerSentEventsHandler, fragment string, opts ...RenderFragmentOption) error

func RenderFragmentTempl 

func RenderFragmentTempl(sse *ServerSentEventsHandler, c templ.Component, opts ...RenderFragmentOption) error

func ScriptCDNLatest 

func ScriptCDNLatest() templ.Component

func ScriptCDNVersion 

func ScriptCDNVersion(version string) templ.Component

Types

type ConsoleLogMode added in v0.19.0 

type ConsoleLogMode string
const (
	ConsoleLogModeLog      ConsoleLogMode = "log"
	ConsoleLogModeError    ConsoleLogMode = "error"
	ConsoleLogModeWarn     ConsoleLogMode = "warn"
	ConsoleLogModeInfo     ConsoleLogMode = "info"
	ConsoleLogModeDebug    ConsoleLogMode = "debug"
	ConsoleLogModeGroup    ConsoleLogMode = "group"
	ConsoleLogModeGroupEnd ConsoleLogMode = "groupEnd"
)

type FragmentMergeType 

type FragmentMergeType string
const (
	FragmentMergeMorph   FragmentMergeType = "morph"
	FragmentMergeInner   FragmentMergeType = "inner"
	FragmentMergeOuter   FragmentMergeType = "outer"
	FragmentMergePrepend FragmentMergeType = "prepend"
	FragmentMergeAppend  FragmentMergeType = "append"
	FragmentMergeBefore  FragmentMergeType = "before"
	FragmentMergeAfter   FragmentMergeType = "after"
	FragmentMergeUpsert  FragmentMergeType = "upsert_attributes"
)

type PatchStoreOption added in v0.19.0 

type PatchStoreOption func(*PatchStoreOptions)

func WithIfMissing added in v0.19.0 

func WithIfMissing() PatchStoreOption

type PatchStoreOptions added in v0.19.0 

type PatchStoreOptions struct {
	OnlyIfMissing bool
}

type RenderFragmentOption 

type RenderFragmentOption func(*RenderFragmentOptions)

func WithMergeAfter added in v0.19.0 

func WithMergeAfter() RenderFragmentOption

func WithMergeAppend added in v0.19.0 

func WithMergeAppend() RenderFragmentOption

func WithMergeBefore added in v0.19.0 

func WithMergeBefore() RenderFragmentOption

func WithMergeMorph added in v0.19.0 

func WithMergeMorph() RenderFragmentOption

func WithMergePrepend added in v0.19.0 

func WithMergePrepend() RenderFragmentOption

func WithMergeType 

func WithMergeType(merge FragmentMergeType) RenderFragmentOption

func WithMergeUpsertAttributes 

func WithMergeUpsertAttributes() RenderFragmentOption

func WithQuerySelector 

func WithQuerySelector(selector string) RenderFragmentOption

func WithQuerySelectorF 

func WithQuerySelectorF(format string, args ...any) RenderFragmentOption

func WithQuerySelectorID 

func WithQuerySelectorID(id string) RenderFragmentOption

func WithQuerySelectorSelf 

func WithQuerySelectorSelf() RenderFragmentOption

func WithQuerySelectorUseID 

func WithQuerySelectorUseID() RenderFragmentOption

func WithSettleDuration 

func WithSettleDuration(d time.Duration) RenderFragmentOption

func WithViewTransitions 

func WithViewTransitions() RenderFragmentOption

func WithoutViewTransitions 

func WithoutViewTransitions() RenderFragmentOption

type RenderFragmentOptions 

type RenderFragmentOptions struct {
	QuerySelector      string
	Merge              FragmentMergeType
	SettleDuration     time.Duration
	UseViewTransitions *bool
}

type SSEEvent 

type SSEEvent struct {
	Id    string
	Event string
	Data  []string
	Retry time.Duration
}

type SSEEventOption 

type SSEEventOption func(*SSEEvent)

func WithSSEEvent 

func WithSSEEvent(event string) SSEEventOption

func WithSSEId 

func WithSSEId(id string) SSEEventOption

func WithSSERetry 

func WithSSERetry(retry time.Duration) SSEEventOption

type ServerSentEventsHandler 

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

func NewSSE 

func NewSSE(w http.ResponseWriter, r *http.Request) *ServerSentEventsHandler

func (*ServerSentEventsHandler) Context 

func (sse *ServerSentEventsHandler) Context() context.Context

func (*ServerSentEventsHandler) Send 

func (sse *ServerSentEventsHandler) Send(data string, opts ...SSEEventOption)

func (*ServerSentEventsHandler) SendMultiData 

func (sse *ServerSentEventsHandler) SendMultiData(dataArr []string, opts ...SSEEventOption)

Source Files

View all Source files

Directories

Path Synopsis
backends
go/cmd/badapple
go/cmd/site
go/site

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.