htmlc

package module

Go to main page

Versions in this module

v0

v0.9.0

Mar 18, 2026

Changes in this version

+ var InspectorScript string

v0.8.0

Mar 17, 2026

Changes in this version

+ type ComponentErrorHandler func(w io.Writer, path []string, err error) error

+ func HTMLErrorHandler() ComponentErrorHandler

+ type MapProps struct

+ func (p MapProps) Get(key string) (any, bool)

+ func (p MapProps) Keys() []string

type Options

+ ComponentErrorHandler ComponentErrorHandler

+ type Props interface

+ Get func(key string) (any, bool)

+ Keys func() []string

type RenderError

+ ComponentPath []string

type Renderer

+ func (r *Renderer) WithComponentErrorHandler(h ComponentErrorHandler) *Renderer

+ func (r *Renderer) WithComponentPath(path []string) *Renderer

+ type StructProps struct

+ func (p StructProps) Get(key string) (any, bool)

+ func (p StructProps) Keys() []string

v0.7.0

Mar 16, 2026

Changes in this version

+ const MsgComponentFailed

+ const MsgComponentRendered

+ var ErrConversion = errors.New("htmlc: conversion failed")

+ func DotPrefix(expr string) (string, error)

+ func Snippet(src string, line int) string

+ type ConversionError struct

+ Cause error

+ Component string

+ Directive string

+ Location *SourceLocation

+ Message string

+ func (e *ConversionError) Error() string

+ func (e *ConversionError) Unwrap() error

type Engine

+ func (e *Engine) CompileToTemplate(componentName string) (*htmltmpl.Template, error)

+ func (e *Engine) PublishExpvars(prefix string) *Engine

+ func (e *Engine) RegisterTemplate(name string, tmpl *htmltmpl.Template) error

+ func (e *Engine) SetComponentDir(dir string) error

+ func (e *Engine) SetDebug(enabled bool)

+ func (e *Engine) SetFS(fsys fs.FS) error

+ func (e *Engine) SetReload(enabled bool)

+ func (e *Engine) TemplateText(componentName string) (text string, warnings []string, err error)

+ type ExprKind int

+ const ExprComplex

+ const ExprDotPath

+ const ExprSimpleIdent

+ func ClassifyExpr(expr string) ExprKind

type Options

+ Logger *slog.Logger

type Renderer

+ func (r *Renderer) WithLogger(l *slog.Logger) *Renderer

+ type TemplateToVueResult struct

+ Text string

+ Warnings []string

+ func TemplateToVue(src, componentName string) (*TemplateToVueResult, error)

+ type VueToTemplateResult struct

+ Text string

+ Warnings []string

+ func VueToTemplate(tmpl *html.Node, componentName string) (*VueToTemplateResult, error)

v0.6.0

Mar 14, 2026

Changes in this version

type DirectiveContext

+ RenderedChildHTML string

type Renderer

+ func (r *Renderer) WithNSComponents(ns map[string]map[string]*Component, componentDir string) *Renderer

v0.5.0

Mar 13, 2026

Changes in this version

+ type DirectiveWithContent interface

+ InnerHTML func() (html string, ok bool)

v0.4.0

Mar 13, 2026

v0.3.0

Mar 13, 2026

Changes in this version

+ type VHighlight struct

+ func (v *VHighlight) Created(node *html.Node, binding DirectiveBinding, ctx DirectiveContext) error

+ func (v *VHighlight) Mounted(_ io.Writer, _ *html.Node, _ DirectiveBinding, _ DirectiveContext) error

v0.2.3

Mar 12, 2026

Changes in this version

type SlotDefinition

+ SlotDefs map[string]*SlotDefinition

v0.2.2

Mar 10, 2026

Changes in this version

type Renderer

+ func (r *Renderer) WithFuncs(funcs map[string]any) *Renderer

type SlotDefinition

+ Component *Component

v0.2.0

Mar 10, 2026

Changes in this version

+ func ErrorOnMissingProp(name string) (any, error)

type Component

+ Source string

+ Warnings []string

type Options

+ Debug bool

type ParseError

+ Location *SourceLocation

type RenderError

+ Location *SourceLocation

+ type SourceLocation struct

+ Column int

+ File string

+ Line int

+ Snippet string

v0.1.1

Mar 9, 2026

v0.1.0

Mar 9, 2026

Changes in this version

+ var ErrComponentNotFound = errors.New("htmlc: component not found")

+ var ErrMissingProp = errors.New("htmlc: missing required prop")

+ func Render(w io.Writer, c *Component, scope map[string]any) error

+ func RenderString(c *Component, scope map[string]any) (string, error)

+ func ScopeCSS(css, scopeAttr string) string

+ func ScopeID(path string) string

+ func SubstituteMissingProp(name string) (any, error)

+ type Component struct

+ Path string

+ Scoped bool

+ Script string

+ Style string

+ Template *html.Node

+ func ParseFile(path, src string) (*Component, error)

+ func (c *Component) Props() []PropInfo

+ type Directive interface

+ Created func(node *html.Node, binding DirectiveBinding, ctx DirectiveContext) error

+ Mounted func(w io.Writer, node *html.Node, binding DirectiveBinding, ctx DirectiveContext) error

+ type DirectiveBinding struct

+ Arg string

+ Modifiers map[string]bool

+ RawExpr string

+ Value any

+ type DirectiveContext struct

+ Registry Registry

+ type DirectiveRegistry map[string]Directive

+ type Engine struct

+ func New(opts Options) (*Engine, error)

+ func (e *Engine) Components() []string

+ func (e *Engine) Has(name string) bool

+ func (e *Engine) Mount(mux *http.ServeMux, routes map[string]string)

+ func (e *Engine) Register(name, path string) error

+ func (e *Engine) RegisterDirective(name string, dir Directive)

+ func (e *Engine) RegisterFunc(name string, fn func(...any) (any, error)) *Engine

+ func (e *Engine) RenderFragment(w io.Writer, name string, data map[string]any) error

+ func (e *Engine) RenderFragmentContext(ctx context.Context, w io.Writer, name string, data map[string]any) error

+ func (e *Engine) RenderFragmentString(name string, data map[string]any) (string, error)

+ func (e *Engine) RenderPage(w io.Writer, name string, data map[string]any) error

+ func (e *Engine) RenderPageContext(ctx context.Context, w io.Writer, name string, data map[string]any) error

+ func (e *Engine) RenderPageString(name string, data map[string]any) (string, error)

+ func (e *Engine) ServeComponent(name string, data func(*http.Request) map[string]any) http.HandlerFunc

+ func (e *Engine) ServePageComponent(name string, data func(*http.Request) (map[string]any, int)) http.HandlerFunc

+ func (e *Engine) ValidateAll() []ValidationError

+ func (e *Engine) WithDataMiddleware(fn func(*http.Request, map[string]any) map[string]any) *Engine

+ func (e *Engine) WithMissingPropHandler(fn MissingPropFunc) *Engine

+ type MissingPropFunc func(name string) (any, error)

+ type Options struct

+ ComponentDir string

+ Directives DirectiveRegistry

+ FS fs.FS

+ Reload bool

+ type ParseError struct

+ Msg string

+ Path string

+ func (e *ParseError) Error() string

+ type PropInfo struct

+ Expressions []string

+ Name string

+ type Registry map[string]*Component

+ type RenderError struct

+ Component string

+ Expr string

+ Wrapped error

+ func (e *RenderError) Error() string

+ func (e *RenderError) Unwrap() error

+ type Renderer struct

+ func NewRenderer(c *Component) *Renderer

+ func (r *Renderer) Render(w io.Writer, scope map[string]any) error

+ func (r *Renderer) RenderString(scope map[string]any) (string, error)

+ func (r *Renderer) WithComponents(reg Registry) *Renderer

+ func (r *Renderer) WithContext(ctx context.Context) *Renderer

+ func (r *Renderer) WithDirectives(dr DirectiveRegistry) *Renderer

+ func (r *Renderer) WithMissingPropHandler(fn MissingPropFunc) *Renderer

+ func (r *Renderer) WithStyles(sc *StyleCollector) *Renderer

+ type SlotDefinition struct

+ BindingVar string

+ Bindings []string

+ Nodes []*html.Node

+ ParentScope map[string]any

+ type StyleCollector struct

+ func (sc *StyleCollector) Add(c StyleContribution)

+ func (sc *StyleCollector) All() []StyleContribution

+ type StyleContribution struct

+ CSS string

+ ScopeID string

+ type VSwitch struct

+ func (v *VSwitch) Created(node *html.Node, binding DirectiveBinding, ctx DirectiveContext) error

+ func (v *VSwitch) Mounted(_ io.Writer, _ *html.Node, _ DirectiveBinding, _ DirectiveContext) error

+ type ValidationError struct

+ Component string

+ Message string

+ func (e ValidationError) Error() string

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