The highest tagged major version is
Documentation
¶
Overview ¶
Package gview implements a template engine based on text/template.
Reserved template variable names:
I18nLanguage: Assign this variable to define i18n language for each page.
Index ¶
- Constants
- func ParseContent(content string, params Params) (string, error)
- type Config
- type FuncMap
- type Params
- type View
- func (view *View) AddPath(path string) error
- func (view *View) Assign(key string, value interface{})
- func (view *View) Assigns(data Params)
- func (view *View) BindFunc(name string, function interface{})
- func (view *View) BindFuncMap(funcMap FuncMap)
- func (view *View) Parse(file string, params ...Params) (result string, err error)
- func (view *View) ParseContent(content string, params ...Params) (string, error)
- func (view *View) ParseDefault(params ...Params) (result string, err error)
- func (view *View) SetAutoEncode(enable bool)
- func (view *View) SetConfig(config Config) error
- func (view *View) SetConfigWithMap(m map[string]interface{}) error
- func (view *View) SetDefaultFile(file string)
- func (view *View) SetDelimiters(left, right string)
- func (view *View) SetI18n(manager *gi18n.Manager)
- func (view *View) SetPath(path string) error
Constants ¶
const (
// Default group name for instance usage.
DEFAULT_NAME = "default"
)
Variables ¶
This section is empty.
Functions ¶
func ParseContent ¶
func ParseContent(content string, params Params) (string, error)
ParseContent parses the template content directly using the default view object and returns the parsed content.
Types ¶
type Config ¶ added in v1.10.0
type Config struct {
Paths []string // Searching array for path, NOT concurrent-safe for performance purpose.
Data map[string]interface{} // Global template variables.
DefaultFile string // Default template file for parsing.
Delimiters []string // Custom template delimiters.
AutoEncode bool // Automatically encodes and provides safe html output, which is good for avoiding XSS.
}
Config is the configuration object for template engine.
type View ¶
type View struct {
// contains filtered or unexported fields
}
View object for template engine.
func Instance ¶
func Instance(name ...string) *View
Instance returns an instance of View with default settings. The parameter <name> is the name for the instance.
func New ¶
func New(path ...string) *View
New returns a new view object. The parameter <path> specifies the template directory path to load template files.
func (*View) AddPath ¶
func (view *View) AddPath(path string) error
AddPath adds a absolute or relative path to the search paths.
func (*View) Assign ¶
func (view *View) Assign(key string, value interface{})
Assign binds a global template variable to current view object. Note that it's not concurrent-safe, which means it would panic if it's called in multiple goroutines in runtime.
func (*View) Assigns ¶
func (view *View) Assigns(data Params)
Assigns binds multiple global template variables to current view object. Note that it's not concurrent-safe, which means it would panic if it's called in multiple goroutines in runtime.
func (*View) BindFunc ¶
func (view *View) BindFunc(name string, function interface{})
BindFunc registers customized global template function named <name> with given function <function> to current view object. The <name> is the function name which can be called in template content.
func (*View) BindFuncMap ¶
func (view *View) BindFuncMap(funcMap FuncMap)
BindFuncMap registers customized global template functions by map to current view object. The key of map is the template function name and the value of map is the address of customized function.
func (*View) Parse ¶
func (view *View) Parse(file string, params ...Params) (result string, err error)
Parse parses given template file <file> with given template variables <params> and returns the parsed template content.
func (*View) ParseContent ¶
func (view *View) ParseContent(content string, params ...Params) (string, error)
ParseContent parses given template content <content> with template variables <params> and returns the parsed content in []byte.
func (*View) ParseDefault ¶ added in v1.10.0
func (view *View) ParseDefault(params ...Params) (result string, err error)
ParseDefault parses the default template file with params.
func (*View) SetAutoEncode ¶ added in v1.11.0
func (view *View) SetAutoEncode(enable bool)
SetAutoEncode enables/disables automatically html encoding feature. When AutoEncode feature is enables, view engine automatically encodes and provides safe html output, which is good for avoid XSS.
func (*View) SetConfig ¶ added in v1.10.0
func (view *View) SetConfig(config Config) error
SetConfig sets the configuration for view.
func (*View) SetConfigWithMap ¶ added in v1.10.0
func (view *View) SetConfigWithMap(m map[string]interface{}) error
SetConfigWithMap set configurations with map for the view.
func (*View) SetDefaultFile ¶ added in v1.10.0
func (view *View) SetDefaultFile(file string)
SetDefaultFile sets default template file for parsing.
func (*View) SetDelimiters ¶
func (view *View) SetDelimiters(left, right string)
SetDelimiters sets customized delimiters for template parsing.
Source Files