template

Documentation

Index

• Constants
• func MakePagination(c *libtemplate.PaginationConfig) libtemplate.Pagination
• func New(tokz *token.Tokenizer) (*template.Template, error)
• type AdminAccount
• type AdminHome
• type AdminInstance
• type AdminInstanceView
• type Breadcrumb
• type Common
  • func (t *Common) AddFooterExtraScript(s string)
  • func (t *Common) AddFooterScript(s libtemplate.Script)
  • func (t *Common) AddHeadLink(l libtemplate.HeadLink)
  • func (t *Common) SetAccount(account *models.Account)
  • func (t *Common) SetLanguage(l string)
  • func (t *Common) SetLocalizer(l *language.Localizer)
  • func (t *Common) SetNavbar(nodes Navbar)
  • func (t *Common) SetNavbarDark(dark bool)
• type Error
• type Home
• type InitTemplate
• type Login
• type Navbar
  • func (n *Navbar) ActivateFromPath(path string)
  • func (n *Navbar) GetChildren(i int) libtemplate.ActivableSlice
  • func (n *Navbar) GetMatcher(i int) *regexp.Regexp
  • func (n *Navbar) Len() int
  • func (n *Navbar) SetActive(i int, a bool)
• type NavbarNode
• type Settings

Constants

const AdminAccountName = "admin_account"

AdminAccountName is the name of the admin block list template.

const AdminHomeName = "admin_home"

AdminHomeName is the name of the admin home template.

const AdminInstanceName = "admin_instance"

AdminInstanceName is the name of the admin block list template.

const AdminInstanceViewName = "admin_instance_view"

AdminInstanceViewName is the name of the admin block list template.

const ErrorName = "error"

ErrorName is the name of the error template.

const HomeName = "home"

HomeName is the name of the home template.

const LoginName = "login"

LoginName is the name of the login template.

const SettingsName = "settings"

SettingsName is the name of the home template.

Functions

func MakePagination

func MakePagination(c *libtemplate.PaginationConfig) libtemplate.Pagination

MakePagination creates a pagination element from the provided parameters.

func New

func New(tokz *token.Tokenizer) (*template.Template, error)

New creates a new template.

Types

type AdminAccount

type AdminAccount struct {
	Common

	Accounts   []*models.Account
	Pagination libtemplate.Pagination
}

AdminAccount contains the variables for the admin block list template.

type AdminHome

type AdminHome struct {
	Common
}

AdminHome contains the variables for the admin home template.

type AdminInstance

type AdminInstance struct {
	Common

	Instances  []*models.Instance
	Pagination libtemplate.Pagination
}

AdminInstance contains the variables for the admin block list template.

type AdminInstanceView

type AdminInstanceView struct {
	Common

	Instance    *models.Instance
	Breadcrumbs *[]Breadcrumb

	FormAddTeamMemberError   *libtemplate.Alert
	FormAddTeamMemberAction  libtemplate.FormInput
	FormAddTeamMemberAccount libtemplate.FormInput

	FormDeleteTeamMemberError  *libtemplate.Alert
	FormDeleteTeamMemberAction libtemplate.FormInput
	FormDeleteTeamMemberToken  libtemplate.FormInput

	FormTransferOwnershipError  *libtemplate.Alert
	FormTransferOwnershipAction libtemplate.FormInput
	FormTransferOwnershipToken  libtemplate.FormInput

	FormToggleS3CDNError  *libtemplate.Alert
	FormToggleS3CDNAction libtemplate.FormInput
}

AdminInstanceView contains the variables for the admin block list template.

type Breadcrumb

type Breadcrumb struct {
	HRef string
	Text string
}

type Common

type Common struct {
	Language  string
	Localizer *language.Localizer

	Account *models.Account

	Alerts             *[]libtemplate.Alert
	FooterExtraScripts []string
	FooterScripts      []libtemplate.Script
	HeadLinks          []libtemplate.HeadLink

	NavBar     Navbar
	NavBarDark bool
	PageTitle  string
}

Common contains the variables used in nearly every template.

func (*Common) AddFooterExtraScript

func (t *Common) AddFooterExtraScript(s string)

AddFooterExtraScript adds a footer script to the template.

func (*Common) AddFooterScript

func (t *Common) AddFooterScript(s libtemplate.Script)

AddFooterScript adds a footer script to the template.

func (*Common) AddHeadLink

func (t *Common) AddHeadLink(l libtemplate.HeadLink)

AddHeadLink adds a headder link to the template.

func (*Common) SetAccount

func (t *Common) SetAccount(account *models.Account)

SetAccount sets the currently logged-in account.

func (*Common) SetLanguage

func (t *Common) SetLanguage(l string)

SetLanguage sets the template's default language.

func (*Common) SetLocalizer

func (t *Common) SetLocalizer(l *language.Localizer)

SetLocalizer sets the localizer the template will use to generate text.

func (*Common) SetNavbar

func (t *Common) SetNavbar(nodes Navbar)

SetNavbar sets the top level navbar used by the template.

func (*Common) SetNavbarDark

func (t *Common) SetNavbarDark(dark bool)

SetNavbarDark sets the navbar theme.

type Error

type Error struct {
	Common

	Header      string
	Image       string
	SubHeader   string
	Paragraph   string
	ButtonHRef  string
	ButtonLabel string
}

Error contains the variables for the error template.

type Home

type Home struct {
	Common
}

Home contains the variables for the home template.

type InitTemplate

type InitTemplate interface {
	AddHeadLink(l libtemplate.HeadLink)
	AddFooterScript(s libtemplate.Script)
	SetAccount(account *models.Account)
	SetLanguage(l string)
	SetLocalizer(l *language.Localizer)
	SetNavbar(nodes Navbar)
	SetNavbarDark(dark bool)
}

InitTemplate are the functions a template implementing Common will have.

type Login

type Login struct {
	Common

	FormError   string
	FormAccount string
}

Login contains the variables for the "login" template.

type Navbar

type Navbar []NavbarNode

Navbar is a navbar that can be added to a page.

func (*Navbar) ActivateFromPath

func (n *Navbar) ActivateFromPath(path string)

ActivateFromPath sets the active bool based on the match regex.

func (*Navbar) GetChildren

func (n *Navbar) GetChildren(i int) libtemplate.ActivableSlice

GetChildren returns the children of the node or nil if no children.

func (*Navbar) GetMatcher

func (n *Navbar) GetMatcher(i int) *regexp.Regexp

GetMatcher returns the matcher of the node or nil if no matcher.

func (*Navbar) Len

func (n *Navbar) Len() int

Len returns the matcher of the node or nil if no matcher.

func (*Navbar) SetActive

func (n *Navbar) SetActive(i int, a bool)

SetActive sets the active bool based on the match regex.

type NavbarNode

type NavbarNode struct {
	Text     string
	URL      string
	MatchStr *regexp.Regexp
	Icon     string

	Active   bool
	Disabled bool
	Divider  bool

	Children Navbar
}

NavbarNode is an entry on a navbar, can be nested one level.

type Settings

type Settings struct {
	Common

	FormGeneralAccount libtemplate.FormInput
	FormGeneralIsMod   libtemplate.FormInput
	FormGeneralIsAdmin libtemplate.FormInput
}

Settings contains the variables for the home template.