Documentation
¶
Index ¶
- Constants
- Variables
- func Add(name string, temp Template)
- func AddComp(comp Component)
- func AddFromPlugin(name string, mod string)
- func AddLoginComp(comp Component)
- func CSS(s string) template.CSS
- func CheckRequirements() (bool, bool)
- func CheckThemeRequirements() bool
- func Execute(ctx *context.Context, param *ExecuteParam) *bytes.Buffer
- func GetAsset(path string) ([]byte, error)
- func GetComponentAsset() []string
- func GetComponentAssetImportHTML(ctx *context.Context) (res template.HTML)
- func GetComponentAssetWithinPage() []string
- func GetPageContentFromPageType(ctx *context.Context, title, desc, msg string, pt PageType) (template.HTML, template.HTML, template.HTML)
- func HTML(s string) template.HTML
- func JS(s string) template.JS
- func SetComp(name string, comp Component)
- func Themes() []string
- func VersionCompare(toCompare string, versions []string) bool
- func WarningPanel(ctx *context.Context, msg string, pts ...PageType) types.Panel
- func WarningPanelWithDescAndTitle(ctx *context.Context, msg, desc, title string, pts ...PageType) types.Panel
- type BaseComponent
- func (b *BaseComponent) BindActionTo(ctx *context.Context, action types.Action, id string)
- func (b *BaseComponent) GetAsset(name string) ([]byte, error)
- func (b *BaseComponent) GetAssetList() []string
- func (b *BaseComponent) GetCSS() template.CSS
- func (b *BaseComponent) GetCallbacks() types.Callbacks
- func (b *BaseComponent) GetContentWithData(obj interface{}) template.HTML
- func (b *BaseComponent) GetJS() template.JS
- func (b *BaseComponent) GetName() string
- func (b *BaseComponent) GetTemplate() (*template.Template, string)
- func (b *BaseComponent) IsAPage() bool
- type Component
- type ExecuteOptions
- type ExecuteParam
- type PageType
- type Template
Constants ¶
const ( CompCol = "col" CompRow = "row" CompForm = "form" CompTable = "table" CompDataTable = "datatable" CompTree = "tree" CompTreeView = "treeview" CompTabs = "tabs" CompAlert = "alert" CompLink = "link" CompPaginator = "paginator" CompPopup = "popup" CompBox = "box" CompLabel = "label" CompImage = "image" CompButton = "button" )
Variables ¶
var DefaultFuncMap = template.FuncMap{ "lang": language.Get, "langHtml": language.GetFromHtml, "link": func(cdnUrl, prefixUrl, assetsUrl string) string { if cdnUrl == "" { return prefixUrl + assetsUrl } return cdnUrl + assetsUrl }, "isLinkUrl": func(s string) bool { return (len(s) > 7 && s[:7] == "http://") || (len(s) > 8 && s[:8] == "https://") }, "render": func(s, old, repl template.HTML) template.HTML { return template.HTML(strings.ReplaceAll(string(s), string(old), string(repl))) }, "renderJS": func(s template.JS, old, repl template.HTML) template.JS { return template.JS(strings.ReplaceAll(string(s), string(old), string(repl))) }, "divide": func(a, b int) int { return a / b }, "renderRowDataHTML": func(id, content template.HTML, value ...map[string]types.InfoItem) template.HTML { return template.HTML(types.ParseTableDataTmplWithID(id, string(content), value...)) }, "renderRowDataJS": func(id template.HTML, content template.JS, value ...map[string]types.InfoItem) template.JS { return template.JS(types.ParseTableDataTmplWithID(id, string(content), value...)) }, "attr": func(s template.HTML) template.HTMLAttr { return template.HTMLAttr(s) }, "js": func(s interface{}) template.JS { if ss, ok := s.(string); ok { return template.JS(ss) } if ss, ok := s.(template.HTML); ok { return template.JS(ss) } return "" }, "changeValue": func(f types.FormField, index int) types.FormField { if len(f.ValueArr) > 0 { f.Value = template.HTML(f.ValueArr[index]) } if len(f.OptionsArr) > 0 { f.Options = f.OptionsArr[index] } if f.FormType.IsSelect() { f.FieldClass += "_" + strconv.Itoa(index) } return f }, }
var DefaultThemeNames = []string{
"sword",
"adminlte",
}
Functions ¶
func Add ¶
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 AddLoginComp ¶
func AddLoginComp(comp Component)
AddLoginComp add the specified login component.
func CheckRequirements ¶
CheckRequirements check the theme and GoAdmin interdependence limit. The first return parameter means that whether GoAdmin version meets the requirement of the theme used or not. The second return parameter means that whether the version of theme used meets the requirement of GoAdmin or not.
func CheckThemeRequirements ¶
func CheckThemeRequirements() bool
func GetComponentAsset ¶
func GetComponentAsset() []string
func GetComponentAssetWithinPage ¶
func GetComponentAssetWithinPage() []string
func SetComp ¶
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.
func VersionCompare ¶
func WarningPanel ¶
Types ¶
type BaseComponent ¶
type BaseComponent struct {
Name string
HTMLData string
CSS template.CSS
JS template.JS
Callbacks types.Callbacks
}
func (*BaseComponent) BindActionTo ¶
func (*BaseComponent) GetAssetList ¶
func (b *BaseComponent) GetAssetList() []string
func (*BaseComponent) GetCSS ¶
func (b *BaseComponent) GetCSS() template.CSS
func (*BaseComponent) GetCallbacks ¶
func (b *BaseComponent) GetCallbacks() types.Callbacks
func (*BaseComponent) GetContentWithData ¶
func (b *BaseComponent) GetContentWithData(obj interface{}) template.HTML
func (*BaseComponent) GetJS ¶
func (b *BaseComponent) GetJS() template.JS
func (*BaseComponent) GetName ¶
func (b *BaseComponent) GetName() string
func (*BaseComponent) GetTemplate ¶
func (b *BaseComponent) GetTemplate() (*template.Template, string)
func (*BaseComponent) IsAPage ¶
func (b *BaseComponent) IsAPage() bool
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/go-hq/go-admin/blob/master/template/login/theme1.tmpl#L32
// https://github.com/go-hq/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
GetJS() template.JS
GetCSS() template.CSS
GetCallbacks() types.Callbacks
}
Component is the interface which stand for a ui component.
type ExecuteOptions ¶
type ExecuteOptions struct {
Animation bool
NoCompress bool
HideSideBar bool
HideHeader bool
UpdateMenu bool
}
func GetExecuteOptions ¶
func GetExecuteOptions(options []ExecuteOptions) ExecuteOptions
type ExecuteParam ¶
type Template ¶
type Template interface {
Name() string
// layout
Col() types.ColAttribute
Row() types.RowAttribute
// form and table
Form() types.FormAttribute
Table() types.TableAttribute
DataTable() types.DataTableAttribute
TreeView() types.TreeViewAttribute
Tree() types.TreeAttribute
Tabs() types.TabsAttribute
Alert() types.AlertAttribute
Link() types.LinkAttribute
Paginator() types.PaginatorAttribute
Popup() types.PopupAttribute
Box() types.BoxAttribute
Label() types.LabelAttribute
Image() types.ImgAttribute
Button() types.ButtonAttribute
// Builder methods
GetTmplList() map[string]string
GetAssetList() []string
GetAssetImportHTML(exceptComponents ...string) template.HTML
GetAsset(string) ([]byte, error)
GetTemplate(bool) (*template.Template, string)
GetVersion() string
GetRequirements() []string
GetHeadHTML() template.HTML
GetFootJS() template.HTML
Get404HTML() template.HTML
Get500HTML() template.HTML
Get403HTML() template.HTML
}
Template is the interface which contains methods of ui components. It will be used in the plugins for custom the ui.
Directories
¶
| Path | Synopsis |
|---|---|
|
Code generated by go-bindata.
|
Code generated by go-bindata. |
|
Code generated by go-bindata.
|
Code generated by go-bindata. |
|
Code generated by go-bindata.
|
Code generated by go-bindata. |