Name: structpages
Author: jackielii

structpages

Documentation: https://jackielii.github.io/structpages/

Struct Pages provides a way to define routing using struct tags and methods. It integrates with Go's http.ServeMux, allowing you to quickly build web applications with minimal boilerplate.

Status: Beta - The API has settled and the library is battle-tested in production, carrying medium-to-large applications. Remaining breaking changes before v1 will be rare and called out in release notes.

Features

🏗️ Struct-based routing - Define routes using struct tags
🎨 Templ support - Built-in integration with Templ
⚡ HTMX-friendly - Automatic partial rendering support
🔧 Middleware - Standard Go middleware pattern
🎯 Type-safe URLs - Generate URLs from struct references
📦 Dependency injection - Pass dependencies to handlers via options

Installation

go get github.com/jackielii/structpages

Quick Start

Define your page structure using struct tags:

package main

import (
    "log"
    "net/http"
    "github.com/jackielii/structpages"
)

type index struct {
    product `route:"/product Product"`
    team    `route:"/team Team"`
    contact `route:"/contact Contact"`
}

// Implement the Page method using Templ
templ (index) Page() {
    <html>
        <body>
            <h1>Welcome</h1>
            <nav>
                <a href="/product">Product</a>
                <a href="/team">Team</a>
                <a href="/contact">Contact</a>
            </nav>
        </body>
    </html>
}

func main() {
    mux := http.NewServeMux()
    _, err := structpages.Mount(mux, index{}, "/", "Home")
    if err != nil {
        log.Fatal(err)
    }

    log.Println("Starting server on :8080")
    http.ListenAndServe(":8080", mux)
}

Route definitions use the format [method] path [Title]:

/path - All methods, no title
POST /path - POST requests only
GET /path Page Title - GET requests with title "Page Title"

Documentation

API Reference - Complete API documentation for Mount, options, and methods
Routing Patterns - Route definitions, path parameters, nested routes
Supported Request Flows - How requests are dispatched to handlers and components
Middleware - Using middleware with your pages
HTMX Integration - Partial rendering and HTMX support
URLFor & ID Generation - Type-safe URL and HTML id generation
Templ Patterns - Working with Templ templates
Advanced Features - Dependency injection, Init, dynamic Refs, type aliases
Testing renders - structpages.Parse + sp.PageContext(ctx) for unit tests that render templ components without an HTTP server

Examples

Check out the examples directory for complete working applications:

Simple - Basic routing and page rendering
HTMX - HTMX integration with partial updates
HTMX RenderTarget - Standalone-function components shared across pages, with per-component data loading via RenderTarget
Todo - Full TODO app: form actions via ServeHTTP returning RenderComponent(...) to re-render a sibling component (in-memory store)

Lint Tool

structpages-lint is a static analyzer that checks the most common ways structpages calls go wrong.

go install github.com/jackielii/structpages/tools/lint/cmd/structpages-lint@latest
structpages-lint ./...

Categories:

structpages

Popularity

What's Inside

README

structpages

Features

Installation

Quick Start

Documentation

Examples

Lint Tool

Confidence

Similar Plugins

go-web

WINGS Authoring

hono-guide

hono-routing

beagle-go

fabrik

Popularity

Health & Quality

Similar Plugins

go-web

WINGS Authoring

hono-guide

hono-routing

beagle-go

fabrik