datastar

package

Go to main page

Versions in this module

v1

v1.2.2

Jun 2, 2026

Changes in this version

+ const ViewTransitionSelectorDatalineLiteral

type PatchElementOption

+ func WithViewTransitionSelector(selector string) PatchElementOption

v1.2.1

Apr 19, 2026

v1.2.0

Apr 16, 2026

v1.1.0

Dec 15, 2025

Changes in this version

+ const NamespaceDatalineLiteral

+ var ValidNamespaces = []Namespace

+ type Namespace string

+ const NamespaceHTML

+ const NamespaceMathML

+ const NamespaceSVG

+ func NamespaceFromString(s string) (Namespace, error)

type PatchElementOption

+ func WithNamespace(namespace Namespace) PatchElementOption

+ func WithNamespaceHTML() PatchElementOption

+ func WithNamespaceMathML() PatchElementOption

+ func WithNamespaceSVG() PatchElementOption

v1.0.3

Oct 16, 2025

v1.0.2

Aug 19, 2025

Changes in this version

type SSEOption

+ func WithContext(ctx context.Context) SSEOption

v1.0.1

Jul 15, 2025

Changes in this version

type ServerSentEventGenerator

+ func (sse *ServerSentEventGenerator) IsClosed() bool

v1.0.0

Jul 14, 2025

Changes in this version

+ const DatastarKey

+ const DefaultSseRetryDuration

+ const DoubleNewLine

+ const ElementsDatalineLiteral

+ const ModeDatalineLiteral

+ const NewLine

+ const OnlyIfMissingDatalineLiteral

+ const SelectorDatalineLiteral

+ const SignalsDatalineLiteral

+ const UseViewTransitionDatalineLiteral

+ var DefaultElementsUseViewTransitions = false

+ var DefaultPatchSignalsOnlyIfMissing = false

+ var ValidElementPatchModes = []ElementPatchMode

+ func DeleteSSE(urlFormat string, args ...any) string

+ func GetSSE(urlFormat string, args ...any) string

+ func PatchSSE(urlFormat string, args ...any) string

+ func PostSSE(urlFormat string, args ...any) string

+ func PutSSE(urlFormat string, args ...any) string

+ func ReadSignals(r *http.Request, signals any) error

+ type BrotliOption func(*brotli.Options)

+ func WithBrotliLGWin(lgwin int) BrotliOption

+ func WithBrotliLevel(level int) BrotliOption

+ type CompressionOption func(*compressionOptions)

+ func WithBrotli(opts ...BrotliOption) CompressionOption

+ func WithClientPriority() CompressionOption

+ func WithDeflate(opts ...DeflateOption) CompressionOption

+ func WithForced() CompressionOption

+ func WithGzip(opts ...GzipOption) CompressionOption

+ func WithServerPriority() CompressionOption

+ func WithZstd(opts ...zstd_opts.EOption) CompressionOption

+ type CompressionStrategy string

+ const ClientPriority

+ const Forced

+ const ServerPriority

+ type Compressor struct

+ Compressor httpcompression.CompressorProvider

+ Encoding string

+ type DeflateOption func(*zlib.Options)

+ func WithDeflateDictionary(dict []byte) DeflateOption

+ func WithDeflateLevel(level int) DeflateOption

+ type DispatchCustomEventOption func(*dispatchCustomEventOptions)

+ func WithDispatchCustomEventBubbles(bubbles bool) DispatchCustomEventOption

+ func WithDispatchCustomEventCancelable(cancelable bool) DispatchCustomEventOption

+ func WithDispatchCustomEventComposed(composed bool) DispatchCustomEventOption

+ func WithDispatchCustomEventEventID(id string) DispatchCustomEventOption

+ func WithDispatchCustomEventRetryDuration(retryDuration time.Duration) DispatchCustomEventOption

+ func WithDispatchCustomEventSelector(selector string) DispatchCustomEventOption

+ type ElementPatchMode string

+ const DefaultElementPatchMode

+ const ElementPatchModeAfter

+ const ElementPatchModeAppend

+ const ElementPatchModeBefore

+ const ElementPatchModeInner

+ const ElementPatchModeOuter

+ const ElementPatchModePrepend

+ const ElementPatchModeRemove

+ const ElementPatchModeReplace

+ func ElementPatchModeFromString(s string) (ElementPatchMode, error)

+ type EventType string

+ const EventTypePatchElements

+ const EventTypePatchSignals

+ type ExecuteScriptOption func(*executeScriptOptions)

+ func WithExecuteScriptAttributeKVs(kvs ...string) ExecuteScriptOption

+ func WithExecuteScriptAttributes(attributes ...string) ExecuteScriptOption

+ func WithExecuteScriptAutoRemove(autoremove bool) ExecuteScriptOption

+ func WithExecuteScriptEventID(id string) ExecuteScriptOption

+ func WithExecuteScriptRetryDuration(retryDuration time.Duration) ExecuteScriptOption

+ type GoStarElementRenderer interface

+ Render func(w io.Writer) error

+ type GzipOption func(*gzip.Options)

+ func WithGzipLevel(level int) GzipOption

+ type PatchElementOption func(*patchElementOptions)

+ func WithMode(merge ElementPatchMode) PatchElementOption

+ func WithModeAfter() PatchElementOption

+ func WithModeAppend() PatchElementOption

+ func WithModeBefore() PatchElementOption

+ func WithModeInner() PatchElementOption

+ func WithModeOuter() PatchElementOption

+ func WithModePrepend() PatchElementOption

+ func WithModeRemove() PatchElementOption

+ func WithModeReplace() PatchElementOption

+ func WithPatchElementsEventID(id string) PatchElementOption

+ func WithRetryDuration(retryDuration time.Duration) PatchElementOption

+ func WithSelector(selector string) PatchElementOption

+ func WithSelectorID(id string) PatchElementOption

+ func WithSelectorf(selectorFormat string, args ...any) PatchElementOption

+ func WithUseViewTransitions(useViewTransition bool) PatchElementOption

+ func WithViewTransitions() PatchElementOption

+ func WithoutViewTransitions() PatchElementOption

+ type PatchSignalsOption func(*patchSignalsOptions)

+ func WithOnlyIfMissing(onlyIfMissing bool) PatchSignalsOption

+ func WithPatchSignalsEventID(id string) PatchSignalsOption

+ func WithPatchSignalsRetryDuration(retryDuration time.Duration) PatchSignalsOption

+ type SSEEventOption func(*serverSentEventData)

+ func WithSSEEventId(id string) SSEEventOption

+ func WithSSERetryDuration(retryDuration time.Duration) SSEEventOption

+ type SSEOption func(*ServerSentEventGenerator)

+ func WithCompression(opts ...CompressionOption) SSEOption

+ type ServerSentEventGenerator struct

+ func NewSSE(w http.ResponseWriter, r *http.Request, opts ...SSEOption) *ServerSentEventGenerator

+ func (sse *ServerSentEventGenerator) ConsoleError(err error, opts ...ExecuteScriptOption) error

+ func (sse *ServerSentEventGenerator) ConsoleLog(msg string, opts ...ExecuteScriptOption) error

+ func (sse *ServerSentEventGenerator) ConsoleLogf(format string, args ...any) error

+ func (sse *ServerSentEventGenerator) Context() context.Context

+ func (sse *ServerSentEventGenerator) DispatchCustomEvent(eventName string, detail any, opts ...DispatchCustomEventOption) error

+ func (sse *ServerSentEventGenerator) ExecuteScript(scriptContents string, opts ...ExecuteScriptOption) error

+ func (sse *ServerSentEventGenerator) MarshalAndPatchSignals(signals any, opts ...PatchSignalsOption) error

+ func (sse *ServerSentEventGenerator) MarshalAndPatchSignalsIfMissing(signals any, opts ...PatchSignalsOption) error

+ func (sse *ServerSentEventGenerator) PatchElementGostar(child GoStarElementRenderer, opts ...PatchElementOption) error

+ func (sse *ServerSentEventGenerator) PatchElementTempl(c TemplComponent, opts ...PatchElementOption) error

+ func (sse *ServerSentEventGenerator) PatchElementf(format string, args ...any) error

+ func (sse *ServerSentEventGenerator) PatchElements(elements string, opts ...PatchElementOption) error

+ func (sse *ServerSentEventGenerator) PatchSignals(signalsContents []byte, opts ...PatchSignalsOption) error

+ func (sse *ServerSentEventGenerator) PatchSignalsIfMissingRaw(signalsJSON string) error

+ func (sse *ServerSentEventGenerator) Prefetch(urls ...string) error

+ func (sse *ServerSentEventGenerator) Redirect(url string, opts ...ExecuteScriptOption) error

+ func (sse *ServerSentEventGenerator) Redirectf(format string, args ...any) error

+ func (sse *ServerSentEventGenerator) RemoveElement(selector string, opts ...PatchElementOption) error

+ func (sse *ServerSentEventGenerator) RemoveElementByID(id string) error

+ func (sse *ServerSentEventGenerator) RemoveElementf(selectorFormat string, args ...any) error

+ func (sse *ServerSentEventGenerator) ReplaceURL(u url.URL, opts ...ExecuteScriptOption) error

+ func (sse *ServerSentEventGenerator) ReplaceURLQuerystring(r *http.Request, values url.Values, opts ...ExecuteScriptOption) error

+ func (sse *ServerSentEventGenerator) Send(eventType EventType, dataLines []string, opts ...SSEEventOption) error

+ type TemplComponent interface

+ Render func(ctx context.Context, w io.Writer) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL