htmlbind

Sep 2, 2026

Changes in this version

type Builder

+ func (Builder[P]) Await[S, R any](resolve func(context.Context, P) (S, error), recovery func(P, AsyncError) R, ...) Op[P]

+ func (Builder[P]) ForCtx[E, S any](items func(context.Context, P) []E, scope func(P, E, int) S, body []Op[S]) Op[P]

+ func (Builder[P]) For[E, S any](items func(P) []E, scope func(P, E, int) S, body []Op[S]) Op[P]

+ func (Builder[P]) Live[S, R any](bindings func(context.Context, P) []LiveBinding[S], scope func(P) S, ...) Op[P]

+ func (Builder[P]) Provide[V any](element, provider string, fn func(context.Context) (V, error), ...) Op[P]

+ func (Builder[P]) ValCtx[V, S any](value func(context.Context, P) V, scope func(P, V) S, body []Op[S]) Op[P]

+ func (Builder[P]) ValErrCtx[V, S any](value func(context.Context, P) (V, error), scope func(P, V) S, body []Op[S]) Op[P]

+ func (Builder[P]) ValErr[V, S any](value func(P) (V, error), scope func(P, V) S, body []Op[S]) Op[P]

+ func (Builder[P]) Val[V, S any](value func(P) V, scope func(P, V) S, body []Op[S]) Op[P]

Aug 20, 2026

Changes in this version

+ func AppendJSONString[T ~string | ~[]byte](dst []byte, value T) []byte

Aug 16, 2026

Changes in this version

+ func URLPathSegment(prefix, value string, collapse bool) string

type Builder

+ func (Builder[P]) Message(segments func(context.Context, P) []MessageSegment, holes []MessageHoleOps[P]) Op[P]

+ func (Builder[P]) MessageInner() Op[P]

+ func (Builder[P]) RequireCtx(check func(context.Context, P) error) Op[P]

type CachePolicy

+ Bindings func(context.Context) string

+ type MessageHoleOps struct

+ Name string

+ Ops []Op[P]

+ type MessageSegment struct

+ Hole string

+ Text string

Aug 16, 2026

Changes in this version

type Op

+ func ValErrCtx[P, V, S any](value func(context.Context, P) (V, error), scope func(P, V) S, body []Op[S]) Op[P]

+ func ValErr[P, V, S any](value func(P) (V, error), scope func(P, V) S, body []Op[S]) Op[P]

Aug 14, 2026

Changes in this version

type Op

+ func ValCtx[P, V, S any](value func(context.Context, P) V, scope func(P, V) S, body []Op[S]) Op[P]

+ func Val[P, V, S any](value func(P) V, scope func(P, V) S, body []Op[S]) Op[P]

Aug 13, 2026

Changes in this version

type Builder

+ func (Builder[P]) Require(check func(P) error) Op[P]

type Plan

+ func (plan *Plan[P]) Bind(params P) Fragment

+ func (plan *Plan[P]) BindWrapper(params P, setChildren func(*P, Fragment)) Wrapper

Aug 12, 2026

Changes in this version

+ func JSONMember(body, name, encoded string) string

Aug 11, 2026

Changes in this version

type Asset

+ Scope string

Aug 10, 2026

Changes in this version

+ var ErrSignal = errors.New("htmlbind: signal")

+ type Signal struct

+ func AsSignal(err error) (Signal, bool)

+ func NamedSignal(name string) Signal

+ func NewRawSignal(name string, payload []byte) Signal

+ func NewSignal(name string, payload SignalPayload) Signal

+ func (s Signal) AppendJSON(dst []byte) []byte

+ func (s Signal) Error() string

+ func (s Signal) Is(target error) bool

+ func (s Signal) Name() string

+ func (s Signal) Payload() []byte

+ type SignalPayload interface

+ AppendJSON func(dst []byte) []byte

Aug 9, 2026

Changes in this version

+ func IsPrivate(wrappers []Wrapper, leaf Fragment) bool

+ func PrivateSource(wrappers []Wrapper, leaf Fragment) string

type CachePolicy

+ Scoped bool

type Fragment

+ func (f Fragment) IsPrivate() bool

+ func (f Fragment) PrivateSource() string

type Option

+ func WithCacheScope(scope string) Option

type Plan

+ DeclaresPrivate bool

+ DeclaresPublic bool

+ PrivateSource string

type Wrapper

+ func (w Wrapper) IsPrivate() bool

+ func (w Wrapper) PrivateSource() string

Aug 8, 2026

Changes in this version

+ var ErrSequenceMismatch = errors.New("htmlbind: values do not match the sequence")

type Boundary

+ Instance func(P) string

type Collector

+ Choice func(value string)

+ Slot func(begin bool)

type Fragment

+ func (f Fragment) InstanceID() string

type Plan

+ func (p *Plan[P]) Sequence(boundaryPrefix string) *Sequence

+ type SeqKind int

+ const SeqComponent

+ const SeqIf

+ const SeqRepeat

+ const SeqSlot

+ const SeqStatic

+ type SeqNode struct

+ Else []SeqNode

+ Kind SeqKind

+ Text string

+ Then []SeqNode

+ type Sequence struct

+ Address string

+ Nodes []SeqNode

+ func LookupSequence(address string) (*Sequence, bool)

+ func (s *Sequence) AppendJSON(dst []byte) []byte

+ func (s *Sequence) Reassemble(values []string) (string, error)

+ func (s *Sequence) String() string

Aug 8, 2026

Changes in this version

+ func ChainHead(wrappers []Wrapper, leaf Fragment, options ...Option) ([]string, error)

+ func CollectChainAsync(ctx context.Context, w io.Writer, collect Collector, rendered func() bool, ...) iter.Seq2[Content, error]

+ type Collector interface

+ Begin func(validatorTag string)

+ Close func()

+ Open func(id, componentID, attr, input string)

+ TakePending func() (attr, id string, ok bool)

+ Write func(value string)

Aug 5, 2026

Changes in this version

type Renderer

+ func (r *Renderer) WriteEscaped(value string) error

Aug 5, 2026

Changes in this version

+ const BlockedURL

+ const URLListSpace

+ const URLListSrcset

+ var DefaultDataURLMediaTypes = []string

+ var DefaultURLSchemes = []string

type Builder

+ func (Builder[P]) URLAttr(name string, value func(P) (string, bool)) Op[P]

+ func (Builder[P]) URLAttrCtx(name string, value func(context.Context, P) (string, bool)) Op[P]

+ func (Builder[P]) URLListAttr(name, shape string, value func(P) (string, bool)) Op[P]

+ func (Builder[P]) URLListAttrCtx(name, shape string, value func(context.Context, P) (string, bool)) Op[P]

type Option

+ func WithDataURLMediaTypes(mediaTypes ...string) Option

+ func WithURLSchemes(schemes ...string) Option

Aug 3, 2026

Changes in this version

type Option

+ func WithValidatorTag(tag string) Option

Aug 3, 2026

Changes in this version

+ const AssetTypeScript

+ const AssetTypeStyle

+ var ErrNoCSRFToken = errors.New("htmlbind: form needs a CSRF token")

+ var ErrNoRenderContext = errors.New("htmlbind: render needs a context")

+ func MergeVary(wrappers []Wrapper, leaf Fragment) []string

+ type Asset struct

+ ID string

+ Type string

+ URL string

+ func MergeAssets(wrappers []Wrapper, leaf Fragment) []Asset

type Builder

+ func (Builder[P]) CSRFField(name string) Op[P]

type Fragment

+ func (f Fragment) Assets() []Asset

+ func (f Fragment) Vary() []string

type Op

+ func Provide[P, V any](element, provider string, fn func(context.Context) (V, error), ...) Op[P]

type Option

+ func WithCSRFToken(token string) Option

+ func WithoutCSRFToken() Option

type Plan

+ Assets []Asset

+ Slots func(P) []Fragment

+ Vary []string

+ type Segment struct

+ Hole func(P, V) string

+ Static string

type Wrapper

+ func (w Wrapper) Assets() []Asset

+ func (w Wrapper) Vary() []string

Aug 1, 2026

Changes in this version

+ const DefaultBoundaryPrefix

type Option

+ func WithBoundaryPrefix(prefix string) Option

Aug 1, 2026

Changes in this version

+ const OpReplace

+ const ProtocolVersion

+ func CanonArray[T any](values []T, encode func(T) string) string

+ func CanonBool(value bool) string

+ func CanonBytes(value []byte) string

+ func CanonFloat(value float64) string

+ func CanonInt(value int) string

+ func CanonJoin(parts ...string) string

+ func CanonOptional[T any](value *T, encode func(T) string) string

+ func CanonRecord(fields string) string

+ func CanonString[T ~string](value T) string

+ func CanonTime(value time.Time) string

+ func CanonURL(value url.URL) string

+ func DeltaStreamHead(wrappers []Wrapper, leaf Fragment, options ...Option) ([]string, error)

+ func RenderDeltaStream(ctx context.Context, key []byte, known Manifest, wrappers []Wrapper, ...) iter.Seq2[DeltaRecord, error]

+ type Boundary struct

+ Attr string

+ ComponentID string

+ Input func(P) string

type Builder

+ func (Builder[P]) BoundaryAttr() Op[P]

+ type Delta struct

+ Head []string

+ Manifest Manifest

+ Operations []Operation

+ func RenderDelta(key []byte, known Manifest, wrappers []Wrapper, leaf Fragment) (Delta, error)

+ type DeltaRecord struct

+ Completion *Content

+ Frame string

+ Operation *Operation

+ type Instance struct

+ ComponentID string

+ FrameValidator string

+ ID string

+ InputValidator string

+ ParentID string

+ type Manifest struct

+ Instances []Instance

+ func CollectChain(w io.Writer, key []byte, wrappers []Wrapper, leaf Fragment, options ...Option) (Manifest, error)

+ func (m Manifest) Changed(previous Manifest) []Instance

+ func (m Manifest) Find(id string) (Instance, bool)

+ type Operation struct

+ HTML string

+ InstanceID string

+ Kind string

type Plan

+ Boundary *Boundary[P]

Jul 31, 2026

Changes in this version

+ var ErrHeadNode = errors.New("htmlbind: invalid head contribution")

+ func RenderHeadNodes(nodes []HeadNode) ([]string, error)

type Builder

+ func (Builder[P]) AttrCtx(name string, value func(context.Context, P) (string, bool)) Op[P]

+ func (Builder[P]) BoolAttrCtx(name string, value func(context.Context, P) bool) Op[P]

+ func (Builder[P]) ComponentCtx(bind func(context.Context, P) Fragment) Op[P]

+ func (Builder[P]) IfCtx(condition func(context.Context, P) bool, then, otherwise []Op[P]) Op[P]

+ func (Builder[P]) RawCtx(value func(context.Context, P) string) Op[P]

+ func (Builder[P]) SlotCtx(value func(context.Context, P) Fragment, fallback []Op[P]) Op[P]

+ func (Builder[P]) TextCtx(value func(context.Context, P) string) Op[P]

+ type HeadAttr struct

+ Name string

+ Value string

+ type HeadNode struct

+ func HeadLink(attrs ...HeadAttr) HeadNode

+ func HeadMeta(attrs ...HeadAttr) HeadNode

+ func HeadNoScript(children ...HeadNode) HeadNode

+ func HeadScript(attrs ...HeadAttr) HeadNode

+ func HeadTitle(text string) HeadNode

type Op

+ func ForCtx[P, E, S any](items func(context.Context, P) []E, scope func(P, E, int) S, body []Op[S]) Op[P]

type Option

+ func WithHead(nodes ...HeadNode) Option

Jul 30, 2026

Changes in this version

+ func HasLiveBlock(wrappers []Wrapper, leaf Fragment) bool

+ func RenderChainLive(ctx context.Context, w io.Writer, wrappers []Wrapper, leaf Fragment, ...) iter.Seq2[Content, error]

+ func RenderLive(ctx context.Context, w io.Writer, leaf Fragment, options ...Option) iter.Seq2[Content, error]

type Content

+ func (c Content) AppendJSON(dst []byte) []byte

type Fragment

+ func (f Fragment) HasLiveBlock() bool

+ type LiveBinding func(deliver func(assign func(*S), err error) bool) error

type Op

+ func Live[P, S, R any](bindings func(context.Context, P) []LiveBinding[S], scope func(P) S, ...) Op[P]

type Option

+ func WithLiveSubscriptions() Option

type Plan

+ HasLiveBlock bool

type Wrapper

+ func (w Wrapper) HasLiveBlock() bool

Jul 29, 2026

Changes in this version

type Fragment

+ func (f Fragment) HeadSources() []string

type Plan

+ HeadSources []string

type Wrapper

+ func (w Wrapper) HeadSources() []string

Jul 27, 2026

Changes in this version

+ type UnrecoveredError struct

+ BoundaryID string

+ Err error

+ func (e *UnrecoveredError) Error() string

+ func (e *UnrecoveredError) Unwrap() error

Jul 27, 2026

Changes in this version

+ func ErrUnsetPending(path string) error

type Fragment

+ func (f Fragment) Validate() error

type Op

+ func Require[P any](check func(P) error) Op[P]

+ type Pending struct

+ func Failed[T any](err error) Pending[T]

+ func Go[T any](ctx context.Context, work func(context.Context) (T, error)) Pending[T]

+ func Resolved[T any](value T) Pending[T]

+ func (p Pending[T]) IsSet() bool

+ func (p Pending[T]) Wait(ctx context.Context) (T, error)

type Plan

+ Check func(P) error

+ type UnsetPendingError struct

+ Path string

+ func (e *UnsetPendingError) Error() string

type Wrapper

+ func (w Wrapper) Validate() error

Jul 27, 2026

Changes in this version

+ func HasAwaitBlock(wrappers []Wrapper, leaf Fragment) bool

type Fragment

+ func (f Fragment) HasAwaitBlock() bool

type Plan

+ HasAwaitBlock bool

type Wrapper

+ func (w Wrapper) HasAwaitBlock() bool

+ func (w Wrapper) Head() []string

Jul 26, 2026

Changes in this version

+ const ErrorCodeInternal

+ const ErrorCodeTimeout

+ func Concurrent(ctx context.Context, tasks ...func() error) error

+ func Flush(w io.Writer)

+ func FormatBool(value bool) string

+ func FormatFloat(value float64) string

+ func FormatInt(value int) string

+ func JSONArray[T any](values []T, encode func(T) string) string

+ func JSONBool(value bool) string

+ func JSONFloat(value float64) string

+ func JSONInt(value int) string

+ func JSONOptional[T any](value *T, encode func(T) string) string

+ func JSONString[T ~string](value T) string

+ func KeyArray[T any](values []T, encode func(T) string) string

+ func KeyBool(value bool) string

+ func KeyBytes(value []byte) string

+ func KeyFloat(value float64) string

+ func KeyInt(value int) string

+ func KeyOptional[T any](value *T, encode func(T) string) string

+ func KeyString[T ~string](value T) string

+ func KeyTime(value time.Time) string

+ func RenderAsync(ctx context.Context, w io.Writer, leaf Fragment, options ...Option) iter.Seq2[Content, error]

+ func RenderChainAsync(ctx context.Context, w io.Writer, wrappers []Wrapper, leaf Fragment, ...) iter.Seq2[Content, error]

+ type AsyncError struct

+ Code string

+ Message string

+ Retryable bool

+ Timeout bool

+ type CachePolicy struct

+ ID string

+ Key func(P) string

+ TTL time.Duration

+ type CacheStore interface

+ Get func(ctx context.Context, key string) ([]byte, bool)

+ Set func(ctx context.Context, key string, value []byte, ttl time.Duration)

+ type Content struct

+ BoundaryID string

+ HTML []byte

+ func (c Content) WriteTo(w io.Writer) (int64, error)

+ type MemoryCache struct

+ func NewMemoryCache(maxEntries int) *MemoryCache

+ func (c *MemoryCache) Get(_ context.Context, key string) ([]byte, bool)

+ func (c *MemoryCache) Len() int

+ func (c *MemoryCache) Set(_ context.Context, key string, value []byte, ttl time.Duration)

type Op

+ func Await[P, S, R any](resolve func(context.Context, P) (S, error), recovery func(P, AsyncError) R, ...) Op[P]

+ type Option func(*renderOptions)

+ func WithAsyncTimeout(timeout time.Duration) Option

+ func WithCache(store CacheStore) Option

+ func WithConcurrencyLimit(limit int) Option

+ func WithContext(ctx context.Context) Option

+ func WithErrorReporter(report func(error)) Option

type Plan

+ Cache *CachePolicy[P]

+ type PublicError interface

+ PublicError func() AsyncError

+ type ScriptJSON string

+ type TrustedCSS string

+ type TrustedHTML string

+ type TrustedJavaScript string

Jul 25, 2026

Changes in this version

+ var ErrNilWrapper = errors.New("htmlbind: chain contains an unset wrapper")

+ var ErrNoLeaf = errors.New("htmlbind: chain needs a leaf component")

+ func Escape(value string) string

+ func MergeHead(wrappers []Wrapper, leaf Fragment) []string

+ func Render(w io.Writer, leaf Fragment) error

+ func RenderChain(w io.Writer, wrappers []Wrapper, leaf Fragment) error

+ type Builder struct

+ func (Builder[P]) Attr(name string, value func(P) (string, bool)) Op[P]

+ func (Builder[P]) BoolAttr(name string, value func(P) bool) Op[P]

+ func (Builder[P]) Component(bind func(P) Fragment) Op[P]

+ func (Builder[P]) If(condition func(P) bool, then, otherwise []Op[P]) Op[P]

+ func (Builder[P]) MergedHead() Op[P]

+ func (Builder[P]) Raw(value func(P) string) Op[P]

+ func (Builder[P]) Slot(value func(P) Fragment, fallback []Op[P]) Op[P]

+ func (Builder[P]) Static(text string) Op[P]

+ func (Builder[P]) Text(value func(P) string) Op[P]

+ type Fragment struct

+ func Bind[P any](plan *Plan[P], params P) Fragment

+ func (f Fragment) Head() []string

+ func (f Fragment) Present() bool

+ type Op interface

+ Exec func(r *Renderer, params P) error

+ func For[P, E, S any](items func(P) []E, scope func(P, E, int) S, body []Op[S]) Op[P]

+ type Plan struct

+ Head []string

+ Ops []Op[P]

+ func (p *Plan[P]) Exec(r *Renderer, params P) error

+ type Renderer struct

+ func (r *Renderer) MergedHead() []string

+ func (r *Renderer) Write(value string) error

+ type Wrapper struct

+ func BindWrapper[P any](plan *Plan[P], params P, setChildren func(*P, Fragment)) Wrapper

Jul 22, 2026

Changes in this version

+ var ZstdCompression bool

+ func PrepareResponse(w http.ResponseWriter, r *http.Request) (http.ResponseWriter, func() error, error)