Documentation
¶
Overview ¶
templ: version: v0.3.1001
templ: version: v0.3.1001
templ: version: v0.3.1001
templ: version: v0.3.1001
templ: version: v0.3.1001
Index ¶
- Variables
- func AppDescFromContext(ctx context.Context) string
- func AppNameFromContext(ctx context.Context) string
- func Layout(title string) templ.Component
- func Navbar(user *entity.User) templ.Component
- func NotFoundPage(user *entity.User) templ.Component
- func Palette() templ.Component
- func RenderNotFound(w http.ResponseWriter, r *http.Request, user *entity.User, status int)
- func ScopedSetupBanner(entry *MissingEntry, isAdmin bool) templ.Component
- func StaticHandler(prefix string, fsys fs.FS) http.Handler
- func ThemeFromContext(ctx context.Context) string
- func ThemePicker(current Theme, lightPref, darkPref string) templ.Component
- func ToolChrome(toolKey string, hasConfigs bool, isAdmin bool) templ.Component
- func UserMenu(user *entity.User) templ.Component
- func WithAppDescription(ctx context.Context, desc string) context.Context
- func WithAppName(ctx context.Context, name string) context.Context
- func WithGuestTheme(ctx context.Context, g GuestTheme) context.Context
- func WithTheme(ctx context.Context, id string) context.Context
- type GuestTheme
- type MissingEntry
- type Theme
Constants ¶
This section is empty.
Variables ¶
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 AppNameFromContext ¶
AppNameFromContext returns the app name set via WithAppName, or "Wick Mini Tools" as the fallback.
func NotFoundPage ¶
NotFoundPage is shown for both 404 (missing) and 403 (forbidden) so a signed-in user cannot distinguish "tool doesn't exist" from "tool exists but I'm not allowed". The message is intentionally vague.
func Palette ¶
Palette renders the global command palette shell. Tool items are populated on first open via GET /api/tools (see web/public/js/palette.js).
func RenderNotFound ¶
RenderNotFound writes the NotFoundPage with the given status code. Use 404 for unknown paths, and 404 (not 403) for forbidden resources so the two cases are indistinguishable to the client.
func ScopedSetupBanner ¶
func ScopedSetupBanner(entry *MissingEntry, isAdmin bool) templ.Component
ScopedSetupBanner renders a single-module caution strip below the navbar when the module the user is currently viewing still has Required configs empty. nil entry suppresses the banner entirely. Admins get a Configure → link straight to the module's manager page; non-admins see a read-only nudge.
func StaticHandler ¶
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 ¶
ThemeFromContext reads the theme id previously set via WithTheme.
func ThemePicker ¶
ThemePicker is the navbar control for switching themes. The left button is the quick toggle between Light and Dark (cycles based on the current theme's IsDark flag). The caret opens a dropdown listing every theme in Themes so the user can pick a custom palette. Posts go to /theme; the handler saves to user metadata and redirects back.
func ToolChrome ¶
ToolChrome renders the per-tool strip that floats above a tool's body: a pill-shaped [⚙ Settings] shortcut to /admin/tools/{toolKey}, shown to admins when the tool declared at least one config row. The pill is fixed (not in flow) so it never steals page height; it sits flush with the right edge of the page container.
Setup-required warnings are rendered per-module on the admin detail pages and the operator /jobs/{key} page via ScopedSetupBanner — not here, because the tool surface itself is where the operator runs the tool.
func UserMenu ¶
UserMenu renders the user avatar dropdown used in all navbars. Shows avatar + dropdown (Profile, Sign out) when logged in, or a Sign in link.
func WithAppName ¶
WithAppName stores the configurable app name in ctx so templates can render it without an explicit parameter.
func WithGuestTheme ¶
func WithGuestTheme(ctx context.Context, g GuestTheme) context.Context
WithGuestTheme stores guest theme prefs in ctx (populated by Session middleware).
Types ¶
type GuestTheme ¶
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 MissingEntry ¶
type MissingEntry struct {
Scope string // "variables", "tool", "job"
Key string // owner key; "" for variables
Name string // display label
Icon string
URL string // where to go to fix
Missing []string
}
MissingEntry names a single owner (variables / tool / job) plus the config keys that are Required but empty. Collected app-wide and rendered globally by GlobalSetupBanner so operators see every incomplete module in one place — regardless of which page they're on.
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.
Source Files