Documentation
¶
Index ¶
- Constants
- func New(tokz *token.Tokenizer) (*template.Template, error)
- type AdminAccount
- type AdminBlock
- type AdminHome
- type AdminInstance
- type AdminInstanceView
- type AdminJobs
- type AdminStatistics
- type Blocks
- 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 FormSelect
- type FormSelectOption
- type Home
- type InitTemplate
- type Instance
- type Login
- type Logs
- type Nav
- type NavNode
- type Navbar
- type NavbarNode
- type Settings
Constants ¶
const AdminAccountName = "admin_account"
AdminAccountName is the name of the admin block list template.
const AdminBlockName = "admin_block"
AdminBlockName 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 AdminJobsName = "admin_jobs"
AdminJobsName is the name of the admin jobs template.
const AdminStatisticsName = "admin_statistics"
AdminStatisticsName is the name of the admin statistics template.
const BlocksName = "blocks"
BlocksName is the name of the blocks template.
const ErrorName = "error"
ErrorPageName is the name of the error template.
const HomeName = "home"
HomeName is the name of the home template.
const InstanceName = "instance"
InstanceName is the name of the my instance template.
const LoginName = "login"
LoginName is the name of the login template.
const LogsName = "logs"
LogsName is the name of the logs template.
const SettingsName = "settings"
SettingsName is the name of the home template.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AdminAccount ¶ added in v0.4.2
type AdminAccount struct {
Common
Accounts []*models.Account
Pagination libtemplate.Pagination
}
AdminAccount contains the variables for the admin block list template.
type AdminBlock ¶
type AdminBlock struct {
Common
Blocks []*models.Block
Pagination libtemplate.Pagination
FormAddError *libtemplate.Alert
FormAddAction libtemplate.FormInput
FormAddDomain libtemplate.FormInput
FormAddObfuscatedDomain libtemplate.FormInput
FormAddBlockSubdomains libtemplate.FormInput
FormDeleteError *libtemplate.Alert
FormDeleteAction libtemplate.FormInput
FormDeleteToken libtemplate.FormInput
FormEditError *libtemplate.Alert
FormEditAction libtemplate.FormInput
FormEditToken libtemplate.FormInput
FormEditDomain libtemplate.FormInput
FormEditObfuscatedDomain libtemplate.FormInput
FormEditBlockSubdomains libtemplate.FormInput
FormImportError *libtemplate.Alert
FormImportAction libtemplate.FormInput
FormImportFile libtemplate.FormInput
FormImportBlockSubdomains libtemplate.FormInput
}
AdminBlock contains the variables for the admin block list template.
type AdminHome ¶
type AdminHome struct {
Common
FormHomeBody libtemplate.FormTextarea
FormRobotsAllowIndexing libtemplate.FormInput
FormNotificationTelegramEnabled libtemplate.FormInput
FormNotificationTelegramToken libtemplate.FormInput
}
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 ¶ added in v0.4.0
type AdminInstanceView struct {
Common
Instance *models.Instance
Breadcrumbs *[]Breadcrumb
FormKickError *libtemplate.Alert
FormKickAction libtemplate.FormInput
FormKickToken libtemplate.FormInput
}
AdminInstanceView contains the variables for the admin block list template.
type AdminJobs ¶ added in v0.6.0
type AdminJobs struct {
Common
Jobs []logic.SchedulerJob
FormRunJobError *libtemplate.Alert
FormRunJobAction libtemplate.FormInput
FormRunJobJob FormSelect
}
AdminJobs contains the variables for the admin jobs template.
type AdminStatistics ¶ added in v0.4.2
type AdminStatistics struct {
Common
}
AdminStatistics contains the variables for the admin statistics template.
type Breadcrumb ¶ added in v0.4.0
type Common ¶
type Common struct {
Language string
Localizer *language.Localizer
Account *models.Account
Alerts *[]libtemplate.Alert
HeadLinks []libtemplate.HeadLink
PageTitle string
}
Common contains the variables used in nearly every template.
func (*Common) AddFooterExtraScript ¶
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 ¶
SetAccount sets the currently logged-in account.
func (*Common) SetLanguage ¶
SetLanguage sets the template's default language.
func (*Common) SetLocalizer ¶
SetLocalizer sets the localizer the template will use to generate text.
func (*Common) SetNavbarDark ¶
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 FormSelect ¶ added in v0.6.0
type FormSelect struct {
ID string
Name string
Label *libtemplate.FormLabel
Options []FormSelectOption
Disabled bool
Required bool
Validation *libtemplate.FormValidation
}
type FormSelectOption ¶ added in v0.6.0
type InitTemplate ¶
type InitTemplate interface {
AddHeadLink(l libtemplate.HeadLink)
SetAccount(account *models.Account)
SetLanguage(l string)
SetLocalizer(l *language.Localizer)
}
InitTemplate are the functions a template implementing Common will have.
type Instance ¶ added in v0.7.0
type Instance struct {
Common
Instance *models.Instance
FormKickError *libtemplate.Alert
FormKickAction libtemplate.FormInput
FormKickToken libtemplate.FormInput
}
Instance contains the variables for the my instance template.
type Logs ¶ added in v0.3.0
type Logs struct {
Common
Logs []*models.LogEntry
Pagination libtemplate.Pagination
}
Logs contains the variables for the logs template.
type Navbar ¶
type Navbar []NavbarNode
Navbar is a navbar that can be added to a page.
func (*Navbar) ActivateFromPath ¶
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 ¶
GetMatcher returns the matcher of the node or nil if no matcher.
type NavbarNode ¶
type NavbarNode struct {
}
NavbarNode is an entry on a navbar, can be nested one level.
type Settings ¶ added in v0.2.0
type Settings struct {
Common
FormGeneralAccount libtemplate.FormInput
FormGeneralIsMod libtemplate.FormInput
FormGeneralIsAdmin libtemplate.FormInput
FormNotificationDisplay bool
FormNotificationTelegramEnabled libtemplate.FormInput
FormNotificationTelegramChatID libtemplate.FormInput
}
Settings contains the variables for the home template.