Our review

g-sui is a server-rendered UI framework for Go that generates HTML on the server and uses server actions and WebSocket for interactivity.

Strengths

Server-centric rendering simplifies state management
String-based components are composable Go functions returning HTML strings
Real-time updates via WebSocket
Action-based handlers for user interaction

Limitations

Limited client-side interactivity compared to JavaScript frameworks
Steep learning curve for Go developers unfamiliar with server-rendered UI
Documentation scattered across separate files not provided here

When to use it

Use g-sui when building Go web apps that benefit from server-side rendering and real-time updates without complex client-side code.

When not to use it

Avoid g-sui for applications requiring rich client-side interactivity or heavy JavaScript dependencies.

Examples

Create a form with server action

Create a g-sui page with a form that submits a server action and displays the result.

Set up WebSocket for real-time updates

Set up a g-sui application with WebSocket for real-time data updates.

Build a data table with sorting and pagination

Build a data table with sorting and pagination using g-sui's data collation features.

name: g-sui description: Server-rendered Go UI framework. Use when building g-sui applications, creating UI components, handling forms with server actions, using data tables, setting up routes, or implementing WebSocket patches. Triggered by "g-sui", "server-rendered UI", "Go UI framework", form handling, or data collation. allowed-tools: Read, Grep, Glob, Bash, Edit, Write

g-sui Framework

Server-rendered UI framework for Go. All HTML generation, business logic, and state management occur on the server. Interactivity achieved through server actions and WebSocket patches.

Quick Start

package main

import "github.com/michalCapo/g-sui/ui"

func main() {
    app := ui.MakeApp("en")

    app.Page("/", func(ctx *ui.Context) string {
        return app.HTML("Home", "bg-gray-100",
            ui.Div("p-8")(
                ui.Div("text-2xl font-bold")("Hello World"),
            ),
        )
    })

    app.Listen(":8080")
}

Documentation Index

| Topic | File | Description | |-------|------|-------------| | Core Concepts | CORE.md | Architecture, Context, Actions, Targets, server rendering | | UI Components | COMPONENTS.md | Buttons, inputs, forms, tables, alerts, cards, tabs, etc. | | Data Management | DATA.md | Data collation, search, sort, filter, pagination, Excel export | | Server Setup | SERVER.md | App initialization, routes, WebSocket, PWA, assets | | Best Practices | PATTERNS.md | Testing, validation, security, state management |

Core Philosophy

Server-Centric Rendering - All HTML generated server-side as strings
String-Based Components - Components are Go functions returning HTML strings
Action-Based Interactivity - User interactions trigger server handlers returning HTML
WebSocket-Enhanced - Real-time updates via /__ws endpoint

Key Types

type Callable = func(*ui.Context) string  // All handlers return HTML
type Attr struct { ID, Class, Value, OnClick, OnSubmit, ... }  // HTML attributes

Common Imports

import "github.com/michalCapo/g-sui/ui"

Development Commands

go run examples/main.go      # Run example app
go test ./...                # Run all tests
go test ./ui/...             # Test UI package
go build                     # Build project
./deploy                     # Create and push new version tag

Releases

To create a new version release:

./deploy

The deploy script automatically:

Starts at version v0.100 if no tags exist
Increments the minor version by 1 (e.g., v0.100 → v0.101 → v0.102)
Ensures working tree is clean before tagging
Creates an annotated git tag and pushes to remote

Version numbering: v0.XXX format, auto-incremented from v0.100.

g-sui Go UI Framework

Recommended for