template

package
v0.14.0 Latest Latest
Warning

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

Go to latest
Published: Jul 29, 2022 License: GPL-3.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

New creates a new template.

func SetActive

func SetActive(a ActivableSlice, s string)

SetActive sets an active bit in a slice.

Types

type ActivableSlice

type ActivableSlice interface {
	GetChildren(i int) ActivableSlice
	GetMatcher(i int) *regexp.Regexp
	SetActive(i int, a bool)
	Len() int
}

ActivableSlice a slice where each element has an active bit which can be set based on a string.

type Alert

type Alert struct {
	Header string
	Level  string
	Text   string
}

Alert is a page alert.

type AlertBars

type AlertBars *[]Alert

AlertBars is a set of alerts to display together.

type FormInput

type FormInput struct {
	ID           string
	Type         FormInputType
	Name         string
	Placeholder  string
	Label        *liblanguage.LocalizedString
	LabelClass   string
	Value        string
	WrappedClass string
	Disabled     bool
	Required     bool
	Checked      bool
	Validation   *FormValidation
}

FormInput is a templated form input.

type FormInputType added in v0.12.0

type FormInputType string
const (
	// FormInputTypeCheckbox is a checkbox html input field.
	FormInputTypeCheckbox FormInputType = "checkbox"
	// FormInputTypeFile is a file html input field.
	FormInputTypeFile FormInputType = "file"
	// FormInputTypeHidden is a hidden html input field.
	FormInputTypeHidden FormInputType = "hidden"
	// FormInputTypePassword is a password html input field.
	FormInputTypePassword FormInputType = "password"
	// FormInputTypeText is a text html input field.
	FormInputTypeText FormInputType = "text"
)

type FormTextarea added in v0.14.0

type FormTextarea struct {
	ID         string
	Name       string
	Rows       int
	Label      *liblanguage.LocalizedString
	LabelClass string
	Value      string
	Disabled   bool
	Required   bool
	Validation *FormValidation
}

FormTextarea is a templated form textarea.

type FormValidation

type FormValidation struct {
	Valid    bool
	Response string
}

FormValidation is a validation response to a form input.

type HeadLink struct {
	HRef        string
	Rel         string
	Integrity   string
	CrossOrigin string
	Sizes       string
	Type        string
}

HeadLink is the data for a header link.

type Pagination

type Pagination []PaginationNode

Pagination is a pagination element that can be added to a webpage.

func MakePagination

func MakePagination(c *PaginationConfig) Pagination

MakePagination creates a pagination element from the provided parameters.

type PaginationConfig

type PaginationConfig struct {
	Count         int    // item count
	DisplayCount  int    // how many items to display per page
	HRef          string // href to add query to
	HRefCount     int    // count to include in the href, if 0 no count is added
	MaxPagination int    // the max number of pages to show
	Page          int    // current page
}

PaginationConfig contains the config to construct pagination.

type PaginationNode

type PaginationNode struct {
	Text string
	Icon string
	HRef string

	Active   bool
	Disabled bool
}

PaginationNode is an element in a pagination element.

type Script

type Script struct {
	Src         string
	Integrity   string
	CrossOrigin string
}

Script is a javascript script.

type Sidebar []SidebarNode

Sidebar is a sidebar that can be added to a page.

func (*Sidebar) ActivateFromPath

func (s *Sidebar) ActivateFromPath(path string)

ActivateFromPath sets the active bool based on the match regex.

func (*Sidebar) GetChildren

func (s *Sidebar) GetChildren(i int) ActivableSlice

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

func (*Sidebar) GetMatcher

func (s *Sidebar) GetMatcher(i int) *regexp.Regexp

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

func (*Sidebar) Len

func (s *Sidebar) Len() int

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

func (*Sidebar) SetActive

func (s *Sidebar) SetActive(i int, a bool)

SetActive sets the active bool based on the match regex.

type SidebarNode

type SidebarNode struct {
	Text    string
	URI     string
	Matcher *regexp.Regexp
	Icon    string
	Label   string

	Active   bool
	Disabled bool

	Children Sidebar
}

SidebarNode is an entry on a sidebar.

Jump to

Keyboard shortcuts

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