Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pluginui

package

Go to main page

Versions in this module

v0

v0.9.0-wip

Jun 28, 2026

v0.8.3

May 13, 2026

Changes in this version

type PluginUI

+ func (u *PluginUI) SetBranding(branding *UIBrandingConfig) error

type Repository

+ func (r *Repository) UpdateAdminOverrides(id int64, customDomain *string, branding *UIBrandingConfig, userID int) (*PluginUI, error)

type UIBrandingConfig

+ func (b *UIBrandingConfig) Clean() *UIBrandingConfig

+ func (b *UIBrandingConfig) IsZero() bool

v0.8.3-wip

Apr 21, 2026

v0.8.2

Apr 19, 2026

v0.8.1

Apr 4, 2026

v0.8.0

Mar 28, 2026

Changes in this version

+ const AuthNone

+ const AuthPIN

+ const AuthSession

+ const AuthToken

+ const NavBottom

+ const NavSide

+ const NavTop

+ const ScopeAll

+ const ScopeOrg

+ const ScopeSelf

+ const ShellMinimal

+ const ShellNone

+ const ShellStandard

+ const TypeAdminPage

+ const TypeAgentApp

+ const TypeCustomerApp

+ const TypeKiosk

+ const TypePublicPage

+ func BuildFullID(pluginName, uiID string) string

+ func DefaultAuthMethod(uiType string) string

+ func DefaultShell(uiType string) string

+ func GenerateMenuItems(uis []PluginUI) map[string][]map[string]any

+ func IsValidShell(s string) bool

+ func IsValidUIType(t string) bool

+ func RegisterUIRoutes(eng *gin.Engine, repo *Repository, caller PluginCaller, ...) error

+ func UISpecToConfig(spec interface{}) (*json.RawMessage, error)

+ func ValidAuthMethods() []string

+ func ValidDataScopes() []string

+ func ValidNavPositions() []string

+ func ValidShells() []string

+ func ValidUITypes() []string

+ type PluginCaller interface

+ Call func(ctx context.Context, pluginName, fn string, args json.RawMessage) (json.RawMessage, error)

+ type PluginUI struct

+ ChangeBy int

+ ChangeTime time.Time

+ Config *json.RawMessage

+ CreateBy int

+ CreateTime time.Time

+ CustomDomain *string

+ Description *string

+ Enabled bool

+ FullID string

+ ID int64

+ Icon *string

+ Name string

+ PluginName string

+ Shell string

+ UIID string

+ UIType string

+ ValidID int

+ func (u *PluginUI) BasePath() string

+ func (u *PluginUI) IsActive() bool

+ func (u *PluginUI) ParsedConfig() (*UIConfig, error)

+ type Repository struct

+ func NewRepository() (*Repository, error)

+ func NewRepositoryWithDB(db *sql.DB) *Repository

+ func (r *Repository) Create(u *PluginUI, userID int) (int64, error)

+ func (r *Repository) Delete(id int64) error

+ func (r *Repository) GetByFullID(fullID string) (*PluginUI, error)

+ func (r *Repository) GetByID(id int64) (*PluginUI, error)

+ func (r *Repository) List(pluginName, uiType string, enabledOnly bool) ([]PluginUI, error)

+ func (r *Repository) ListActive() ([]PluginUI, error)

+ func (r *Repository) SetEnabled(id int64, enabled bool, userID int) error

+ func (r *Repository) Update(u *PluginUI, userID int) error

+ type TemplateRenderer interface

+ HTML func(c *gin.Context, code int, name string, data pongo2.Context)

+ type UIAuthConfig struct

+ Groups []string

+ Method string

+ type UIBrandingConfig struct

+ AppName string

+ Color string

+ Favicon string

+ Logo string

+ type UIConfig struct

+ Auth *UIAuthConfig

+ Branding *UIBrandingConfig

+ DataScope string

+ Nav *UINavConfig

+ PWA *UIPWAConfig

+ RateLimit int

+ Routes []UIRouteConfig

+ type UINavConfig struct

+ Items []UINavItemConfig

+ Position string

+ type UINavItemConfig struct

+ Badge string

+ Icon string

+ Label string

+ Order int

+ Path string

+ type UIPWAConfig struct

+ CacheRoutes []string

+ Display string

+ Enabled bool

+ StartURL string

+ ThemeColor string

+ type UIRouteConfig struct

+ Handler string

+ Method string

+ Path string