template

Documentation

Index

• func Add(name string, temp Template)
• func AddComp(comp Component)
• func AddFromPlugin(name string, mod string)
• func AddLoginComp(comp Component)
• func DefaultFuncMap() template.FuncMap
• func Execute(tmpl *template.Template, tmplName string, user models.UserModel, ...) *bytes.Buffer
• func GetAsset(path string) ([]byte, error)
• func GetComponentAssetLists() []string
• func GetComponentAssetListsHTML() (res template.HTML)
• func GetComponentAssetListsWithinPage() []string
• func SetComp(name string, comp Component)
• type BaseComponent
  • func (b BaseComponent) GetAsset(name string) ([]byte, error)
  • func (b BaseComponent) GetAssetList() []string
• type Component
  • func GetComp(name string) Component
• type Template
  • func Default() Template
  • func Get(theme string) Template

Functions

func Add

func Add(name string, temp Template)

Add makes a template available by the provided theme name. If Add is called twice with the same name or if template is nil, it panics.

func AddComp

func AddComp(comp Component)

AddComp makes a component available by the provided name. If Add is called twice with the same name or if component is nil, it panics.

func AddFromPlugin

func AddFromPlugin(name string, mod string)

func AddLoginComp

func AddLoginComp(comp Component)

AddLoginComp add the specified login component.

func DefaultFuncMap

func DefaultFuncMap() template.FuncMap

func Execute

func Execute(tmpl *template.Template,
	tmplName string,
	user models.UserModel,
	panel types.Panel,
	config c.Config,
	globalMenu *menu.Menu) *bytes.Buffer

func GetAsset

func GetAsset(path string) ([]byte, error)

func GetComponentAssetLists

func GetComponentAssetLists() []string

func GetComponentAssetListsHTML

func GetComponentAssetListsHTML() (res template.HTML)

func GetComponentAssetListsWithinPage

func GetComponentAssetListsWithinPage() []string

func SetComp

func SetComp(name string, comp Component)

SetComp makes a component available by the provided name. If the value corresponding to the key is empty or if component is nil, it panics.

Types

type BaseComponent

type BaseComponent struct {
}

func (BaseComponent) GetAsset

func (b BaseComponent) GetAsset(name string) ([]byte, error)

func (BaseComponent) GetAssetList

func (b BaseComponent) GetAssetList() []string

type Component

type Component interface {
	// GetTemplate return a *template.Template and a given key.
	GetTemplate() (*template.Template, string)

	// GetAssetList return the assets url suffix used in the component.
	// example:
	//
	// {{.UrlPrefix}}/assets/login/css/bootstrap.min.css => login/css/bootstrap.min.css
	//
	// See:
	// https://github.com/GoAdminGroup/go-admin/blob/master/template/login/theme1.tmpl#L32
	// https://github.com/GoAdminGroup/go-admin/blob/master/template/login/list.go
	GetAssetList() []string

	// GetAsset return the asset content according to the corresponding url suffix.
	// Asset content is recommended to use the tool go-bindata to generate.
	//
	// See: http://github.com/jteeuwen/go-bindata
	GetAsset(string) ([]byte, error)

	GetContent() template.HTML

	IsAPage() bool

	GetName() string
}

Component is the interface which stand for a ui component.

func GetComp

func GetComp(name string) Component

GetComp gets the component by registered name. If the name is not found, it panics.

type Template

type Template interface {

	// layout
	Col() types.ColAttribute
	Row() types.RowAttribute

	// form and table
	Form() types.FormAttribute
	Table() types.TableAttribute
	DataTable() types.DataTableAttribute

	Tree() types.TreeAttribute
	Tabs() types.TabsAttribute
	Alert() types.AlertAttribute

	Paginator() types.PaginatorAttribute
	Popup() types.PopupAttribute
	Box() types.BoxAttribute

	Label() types.LabelAttribute
	Image() types.ImgAttribute

	// Builder methods
	GetTmplList() map[string]string
	GetAssetList() []string
	GetAsset(string) ([]byte, error)
	GetTemplate(bool) (*template.Template, string)
}

Template is the interface which contains methods of ui components. It will be used in the plugins for custom the ui.

func Default

func Default() Template

Get the default template with the theme name set with the global config. If the name is not found, it panics.

func Get

func Get(theme string) Template

Get the template interface by theme name. If the name is not found, it panics.