ui

package
v1.2.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 7, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (
	DefaultTheme      = "github-light"
	DefaultLightTheme = "github-light"
	DefaultDarkTheme  = "github-dark"
)

Defaults applied when a user or guest has no stored preference, so first-time visitors land on GitHub Light with GitHub Dark as the paired dark variant instead of the device system preference.

View Source
const EmbedStyle = `<style>main{padding-top:1.25rem}</style>`

EmbedStyle is the tiny stylesheet injected in place of the stripped chrome. Tool bodies get their top padding from the tool header they sit under; without it the first row would touch the frame edge. The bare element selector loses to any Tailwind utility class, so a body that sets its own padding keeps it.

View Source
const SystemThemeScript = `` /* 181-byte string literal not displayed */

SystemThemeScript is the one-line inline script that applies the device prefers-color-scheme to <html> before first paint. It mirrors the no-preference branch of Layout so a standalone SPA shell behaves the same as a server-rendered page when no theme is stored. The returned string is the script body only (no <script> tags).

Variables

View Source
var Themes = []Theme{
	{ID: "light", Label: "Light", ClassName: "theme-light", IsDark: false},
	{ID: "dark", Label: "Dark", ClassName: "theme-dark", IsDark: true},
	{ID: "github-light", Label: "GitHub Light", ClassName: "theme-github-light", IsDark: false},
	{ID: "github-dark", Label: "GitHub Dark", ClassName: "theme-github-dark", IsDark: true},
	{ID: "material-light", Label: "Material Light", ClassName: "theme-material-light", IsDark: false},
	{ID: "material-dark", Label: "Material Dark", ClassName: "theme-material-dark", IsDark: true},
	{ID: "solarized-light", Label: "Solarized Light", ClassName: "theme-solarized-light", IsDark: false},
	{ID: "solarized-dark", Label: "Solarized Dark", ClassName: "theme-solarized-dark", IsDark: true},
	{ID: "dracula", Label: "Dracula", ClassName: "theme-dracula", IsDark: true},
	{ID: "nord", Label: "Nord", ClassName: "theme-nord", IsDark: true},
	{ID: "gruvbox-dark", Label: "Gruvbox Dark", ClassName: "theme-gruvbox-dark", IsDark: true},
	{ID: "monokai", Label: "Monokai", ClassName: "theme-monokai", IsDark: true},
}

Themes is the ordered list rendered in the theme picker. Add new themes by appending here and defining their tokens in input.css.

Functions

func AppDescFromContext

func AppDescFromContext(ctx context.Context) string

func AppNameFromContext

func AppNameFromContext(ctx context.Context) string

AppNameFromContext returns the app name set via WithAppName, or "Wick Mini Tools" as the fallback.

func DetectEmbedded added in v1.2.9

func DetectEmbedded(r *http.Request) bool

DetectEmbedded decides embed mode for one request: an explicit ?embed= wins, otherwise the Fetch Metadata destination decides.

func EffectiveDarkTheme added in v0.3.0

func EffectiveDarkTheme(id string) string

EffectiveDarkTheme returns the stored dark-mode theme id or DefaultDarkTheme when unset.

func EffectiveLightTheme added in v0.3.0

func EffectiveLightTheme(id string) string

EffectiveLightTheme returns the stored light-mode theme id or DefaultLightTheme when unset.

func EffectiveTheme added in v0.3.0

func EffectiveTheme(id string) string

EffectiveTheme returns the active theme id, falling back to DefaultTheme when unset.

func EmbedContext added in v1.2.9

func EmbedContext(next http.Handler) http.Handler

EmbedContext is the middleware that runs DetectEmbedded once and puts the answer in the request context, so no handler has to re-sniff it.

func EmbeddedFromContext added in v1.2.9

func EmbeddedFromContext(ctx context.Context) bool

EmbeddedFromContext reports whether the current request is being rendered inside a frame. False for any context that never passed through EmbedContext, so non-HTTP render paths keep full chrome.

func HTMLThemeClass added in v0.19.0

func HTMLThemeClass(ctx context.Context) string

HTMLThemeClass returns the class string that belongs on the root <html> element for the theme resolved from ctx, matching exactly what the server-rendered Layout applies via htmlThemeClasses. A standalone SPA shell (served outside Layout) injects this so it reflects the same theme as the rest of the app. An empty result means "no stored preference": the caller should fall back to the device color-scheme before first paint (see SystemThemeScript).

func SetAgentsAvailable added in v0.17.0

func SetAgentsAvailable(fn func() bool)

SetAgentsAvailable registers a function that reports whether the agents tool is running in this process. Called during server boot by the agents tool package. When not set, agents is treated as unavailable.

func SetNavParamsFn added in v0.18.0

func SetNavParamsFn(fn func(ctx context.Context, user *entity.User) NavParams)

SetNavParamsFn registers the hook that resolves per-user nav flags.

func StaticHandler

func StaticHandler(prefix string, fsys fs.FS) http.Handler

StaticHandler serves files from fsys, stripping prefix, and returns 404 for directory paths so embedded asset trees don't leak via index listings.

func ThemeFromContext

func ThemeFromContext(ctx context.Context) string

ThemeFromContext reads the theme id previously set via WithTheme.

func UIScaleFromContext added in v1.2.9

func UIScaleFromContext(ctx context.Context) int

UIScaleFromContext reads the size set via WithUIScale; 0 when unset.

func WithAppDescription

func WithAppDescription(ctx context.Context, desc string) context.Context

func WithAppName

func WithAppName(ctx context.Context, name string) context.Context

WithAppName stores the configurable app name in ctx so templates can render it without an explicit parameter.

func WithEmbedded added in v1.2.9

func WithEmbedded(ctx context.Context, embedded bool) context.Context

WithEmbedded stamps the embed decision onto ctx. Set once per request by EmbedContext; components read it with EmbeddedFromContext.

func WithGuestTheme

func WithGuestTheme(ctx context.Context, g GuestTheme) context.Context

WithGuestTheme stores guest theme prefs in ctx (populated by Session middleware).

func WithImpersonation added in v1.0.0

func WithImpersonation(ctx context.Context, info ImpersonationInfo) context.Context

WithImpersonation stamps the flag onto the request context.

func WithTheme

func WithTheme(ctx context.Context, id string) context.Context

WithTheme stores the resolved theme id in ctx. Empty string means "no preference" and the layout falls back to the system-preference script.

func WithUIScale added in v1.2.9

func WithUIScale(ctx context.Context, pct int) context.Context

WithUIScale stores the signed-in user's interface size (percent) in ctx. Unset (guests) leaves <html> to the stylesheet's default.

func WithVersionInfo added in v0.25.2

func WithVersionInfo(ctx context.Context, v VersionInfo) context.Context

WithVersionInfo stores the version snapshot in ctx so the user-menu dropdown can render it without an explicit parameter (mirrors WithAppName).

Types

type GuestTheme

type GuestTheme struct {
	Current string
	Light   string
	Dark    string
}

GuestTheme holds the three theme preferences stored in the plain guest cookie. Current is the active theme; Light and Dark remember the last picked theme of each mode so the toggle button can cycle back to them.

func GuestThemeFromContext

func GuestThemeFromContext(ctx context.Context) GuestTheme

GuestThemeFromContext returns guest theme prefs set via WithGuestTheme.

type ImpersonationInfo added in v1.0.0

type ImpersonationInfo struct {
	// Active is true while the session belongs to an impersonated user.
	Active bool
	// ActingAs is the impersonated user's display name or email, so the banner
	// names who the admin currently is.
	ActingAs string
}

ImpersonationInfo describes an active "view as" session.

func ImpersonationFromContext added in v1.0.0

func ImpersonationFromContext(ctx context.Context) ImpersonationInfo

ImpersonationFromContext reads the flag. The zero value (not impersonating) is returned when nothing was stamped, so callers need no nil handling.

type NavParams struct {
	CanSeeAgents bool
}

NavParams holds per-user navigation visibility flags.

func NavParamsFor(ctx context.Context, user *entity.User) NavParams

NavParamsFor returns NavParams for the given user. CanSeeAgents is true only when the agents process is running AND navParamsFn grants access.

type Theme

type Theme struct {
	ID        string // stored in user metadata
	Label     string // shown in UI
	ClassName string // applied to <html>
	IsDark    bool
}

Theme represents a selectable UI theme. The ClassName is the CSS class applied to <html> that drives the color palette overrides in web/src/input.css. IsDark marks themes that should also receive the "dark" class so Tailwind's `dark:` variants activate.

func ThemeByID

func ThemeByID(id string) Theme

ThemeByID returns the theme for the given ID or the first matching default. Unknown IDs fall back to an empty Theme which callers should treat as "use system preference".

type VersionInfo added in v0.25.2

type VersionInfo struct {
	AppVersion     string // running app version, RAW for display (e.g. "v0.1.63" or "dev")
	AppDev         bool   // dev/pseudo build — show a neutral "dev" badge, no comparison
	AppLatest      string // latest app release, when known
	AppUpdate      bool   // a newer app release is available
	AppUpdateKnown bool   // app update state is known (release source configured)

	WickVersion     string // embedded wick framework version, RAW for display
	WickDev         bool   // dev/pseudo build — show a neutral "dev" badge
	WickLatest      string // latest wick release, when known
	WickUpdate      bool   // a newer wick release is available
	WickUpdateKnown bool   // wick update state is known (check succeeded)

	// IsOfficial: the app's release source IS the canonical wick repo, so
	// app == framework == one release. The dropdown then shows a SINGLE
	// version line ("Wick") instead of separate App + Wick rows.
	IsOfficial bool

	WebURL string // link target for the version row (public wick site)
}

VersionInfo is the minimal version + update state the user-menu dropdown renders. It is populated from a background-refreshed cache (see internal/updater.VersionCache) and injected per request via WithVersionInfo, so the dropdown reads it with zero network cost.

This type is intentionally defined in the ui package (not imported from updater) to keep the view layer free of a dependency on the updater package — the server maps the cache's snapshot into this.

func VersionInfoFromContext added in v0.25.2

func VersionInfoFromContext(ctx context.Context) VersionInfo

VersionInfoFromContext returns the version snapshot set via WithVersionInfo, or a zero value (no versions, no badges) when none was set — the dropdown then simply omits the version section.

func (VersionInfo) AnyUpdate added in v0.25.2

func (v VersionInfo) AnyUpdate() bool

AnyUpdate reports whether either the app or the wick framework has a known available update — used to show a single "update available" dot on the avatar/menu without the user opening the dropdown.

Jump to

Keyboard shortcuts

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