site

package module

v0.0.17 Latest Latest Go to latest Published: Feb 10, 2026 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tinywasm/site

Links

Open Source Insights

README ¶

tinywasm/site

Site rendering engine for Go (WASM-friendly).

A lightweight rendering layer built on top of tinywasm/dom, designed to generate web pages with minimal overhead. Provides small, efficient primitives for composing views, routing, and rendering UI structures while keeping WebAssembly binaries tiny and dependency-free.

📚 Documentation

Architecture: High-level overview and design goals.
Modules: Routes and modular structure.
Components: UI building blocks and icons.
Routing: Typed routing and path generation.
Access Control: Security and SSR vs SPA logic.
Assets: Bundling and resource management.
Module Creation (ES): Step-by-step guide to creating modules (Spanish).

🔄 Migration

See MIGRATION.md for changes in API (v0.2+).

✨ New Features

Nested Routes: Support for #module/param/action.
Lifecycle Hooks: BeforeNavigateAway and AfterNavigateTo.
Simplified API: site.Serve(":8080") and site.Mount("app").
Navigation Component: Navigation UI moved to components/nav.

Documentation ¶

Rendered for

Index ¶

func Mount(parentID string) error
func Navigate(parentID string, hash string) error
func RegisterHandlers(handlers ...any) error
func Render() error
func SetCacheSize(size int)
func SetDefaultRoute(route string)
func SetDevMode(enabled bool)
func SetOutputDir(dir string)
func SetUserRoles(fn func(data ...any) []byte)
func Start(parentID string) error
type Config
type Module
type ModuleLifecycle
type Parameterized

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Mount ¶

func Mount(parentID string) error

Mount hydrates the initial module and blocks forever.

func Navigate ¶ added in v0.0.17

func Navigate(parentID string, hash string) error

Navigate switches to a different module based on the hash.

func RegisterHandlers ¶

func RegisterHandlers(handlers ...any) error

RegisterHandlers registers all handlers with site and crudp

func Render ¶ added in v0.0.17

func Render() error

Render registers the site handlers with the provided mux and prepares assets. DEPRECATED: Use Mount(parentID) instead.

func SetCacheSize ¶ added in v0.0.17

func SetCacheSize(size int)

SetCacheSize configures module cache size (default: 3)

func SetDefaultRoute ¶ added in v0.0.17

func SetDefaultRoute(route string)

SetDefaultRoute configures default route (default: "home")

func SetDevMode ¶ added in v0.0.17

func SetDevMode(enabled bool)

SetDevMode configures development mode (default: false)

func SetOutputDir ¶ added in v0.0.17

func SetOutputDir(dir string)

SetOutputDir configures the output directory for assets (default: "./public")

func SetUserRoles ¶ added in v0.0.16

func SetUserRoles(fn func(data ...any) []byte)

SetUserRoles configures the function to extract user roles from the request context.

func Start ¶ added in v0.0.17

func Start(parentID string) error

Start initializes the site by hydrating the current module.

Types ¶

type Config ¶ added in v0.0.17

type Config struct {
	CacheSize    int
	DefaultRoute string
	OutputDir    string
	DevMode      bool
}

type Module ¶ added in v0.0.17

type Module interface {
	dom.Component
	HandlerName() string
	ModuleTitle() string
}

Module represents a top-level site module. It combines a DOM component with site-specific identifiers.

type ModuleLifecycle ¶ added in v0.0.17

type ModuleLifecycle interface {
	BeforeNavigateAway() bool // Return false to cancel navigation
	AfterNavigateTo()         // Called after module is mounted
}

ModuleLifecycle provides hooks for navigation events

type Parameterized ¶ added in v0.0.17

type Parameterized interface {
	SetParams(params []string)
}

Parameterized modules can receive route parameters

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
example
modules
modules/contact
modules/user
web command

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