README
¶
xtemplate
a wrapper around text/template inspired by:
Overview
xtemplate wraps text/template to provide:
- file based inheritance
- optional caching
- syntax sugar on function/method calls (eg fn(arg1, arg2) instead of fn arg1 arg2)
- syntax sugar on template calls
- VueJs like components
<!-- master.html -->
<html>
<body>
<h1>
Hello from:
{{block "source" }} master {{end}}
</h1>
</body>
</html>
<!-- extras.html -->
{{ define "footer" }} footer {{end}}
<!-- child.html -->
{{ extends "master.html" }}
{{ include "extra.html" }}
{{ define "source" }}
child
{{ template footer }}
{{end}}
rendering child.html will output
Hello from child footer
Syntax sugar
C like function calls
{{ login("name", "password") }}
instead of
{{ login "name" "password" }}
make template calls look like calling functions
use defined template blocks (imported using the include directive)
{{define "hello"}}
Hello {{ .name }}, age: {{.age}}
{{end}}
{{define "button"}}
a {{ upper("button") }} {{ . }}
{{end}}
call the blocks as follows
{{ macro button("submit") }}
or
{{ template button("submit") }}
or
{{ macro hello("name"::"ayo", "age"::18) }}
Syntax sugar: custom tags
<tag type="field" label="name">
<input>
</tag>
gets translated to a function call to a user defined tag template function
which then generates the output
tag (type, attributes, content)
Components
The component feature transforms a template with the same name as the value of the type attribute must exist in the "_components" subfolder
Slots
A component can define a slot which can be overridden when it is called
<component type="card">
<slot name="title">A title</slot>
</component>
if a component defines a default slot the content of the component tag will be placed within the components default slot
<component type="card">
this will go in cards default slot if card defines one
</component>
Component Templates
Component templates are valid text/template file with special semantics
<div class="box">
{{block "#slot--default" .}}
default content
{{end}}
</div>
<component type="box">
lorem ipsum
</component>
Context and Attributes
The context passed into a component is of type map[string]interface{} the parent context is stored in '
ctx' (.ctx.Name) and component attributes such id|class|style are stored in 'props' (.props.style)
<component type="box" class="red">
lorem ipsum
</component>
<div class="box {{$.props.class}}">
{{block "#slot--default" .}}
default content
{{end}}
</div>
Documentation
¶
Index ¶
- Constants
- func IfEmpty(val interface{}, values ...interface{}) interface{}
- func IsEmpty(val interface{}) bool
- func IsMap(val interface{}) bool
- func IsSlice(val interface{}) bool
- func MixAsset(publicPath string) func(val string) string
- func NoCache(file string) string
- func StrListIncludes(str string, list []string) bool
- type Action
- type Attr
- type Config
- type Document
- type IncludeFile
- type Tag
- type TagAttr
- type XTemplate
- func (s *XTemplate) AddFunc(name string, fn interface{}) *XTemplate
- func (s *XTemplate) Delims(left, right string) *XTemplate
- func (s *XTemplate) Funcs(funcMap template.FuncMap) *XTemplate
- func (s *XTemplate) ListFuncs()
- func (s *XTemplate) Lookup(name string) *template.Template
- func (s *XTemplate) ParseFile(name string) error
- func (s *XTemplate) Render(wr io.Writer, name string, data interface{}, ignoreCache bool) error
- func (s *XTemplate) RenderString(tplStr string, data interface{}) (string, error)
Constants ¶
const ( OpeningTag tagType = iota ClosingTag )
const ( OpeningAction actionType = iota ClosingAction SingleAction )
Variables ¶
This section is empty.
Functions ¶
func IfEmpty ¶
func IfEmpty(val interface{}, values ...interface{}) interface{}
IfEmpty if val is empty return the first non-empty item in values
func IsEmpty ¶
func IsEmpty(val interface{}) bool
IsEmpty returns true if val is nil empty (nil or a zero value for its type)
func MixAsset ¶
MixAsset reads a laravel-mix mix-manifest.json file and returns the hashed filename. assumes that the file will be in ./static
func StrListIncludes ¶
Types ¶
type Document ¶
type Document []byte
func (*Document) AppendString ¶
func (*Document) CutAndInsert ¶
type IncludeFile ¶
type IncludeFile string
func (IncludeFile) FromTemplateAction ¶
func (i IncludeFile) FromTemplateAction() bool
func (IncludeFile) Name ¶
func (i IncludeFile) Name() string
func (*IncludeFile) SetTemplateActionFlag ¶
func (i *IncludeFile) SetTemplateActionFlag()
func (IncludeFile) String ¶
func (i IncludeFile) String() string
type Tag ¶
type XTemplate ¶
type XTemplate struct {
// contains filtered or unexported fields
}
XTemplate ...
func (*XTemplate) AddFunc ¶
AddFunc add a function the template's function map. must be called before templates are parsed
func (*XTemplate) Delims ¶
Delims sets the template delimiters to the specified strings, must be called before templates are parsed
func (*XTemplate) Funcs ¶
Funcs adds the elements of the argument map to the template's function map. must be called before templates are parsed
Source Files