github.com/go-floki/jade
-- import "github.com/go-floki/jade"
Jade is an elegant templating engine. This is Jade implementation for Go Programming Language. Most features are supported, except for javascript expressions. Code is based on the Amber project. This project is a part of the Floki Web application framework but can be easily used in a separate application.
./templates/index.jade
html
body
p Variable equals #{var}
test.go
import "github.com/go-floki/jade"
// compile templates
templates, err := jade.CompileDir("./templates", jade.DefaultDirOptions, jade.Options{})
if err != nil {
panic(err)
}
// then render some template
tpl := templates["index"]
tpl.Execute(writer, map[string]interface{}{
"var": "foo",
})
Look in test folder for sample templates.
A tag is simply a word:
html
is converted to
<html></html>
It is possible to add ID and CLASS attributes to tags:
div#main
span.time
are converted to
<div id="main"></div>
<span class="time"></span>
Any arbitrary attribute name / value pair can be added this way:
a(href="http://www.google.com")
a(href="http://domain.com/" + foo)
You can mix multiple attributes together
a#someid(href="/", title="Main Page").main.link Click Link
gets converted to
<a id="someid" class="main link" href="/" title="Main Page">Click Link</a>
It is also possible to define these attributes within the block of a tag
a
#someid
(href="/")
(title="Main Page")
.main
.link
| Click Link
To add a doctype, use !!! or doctype keywords:
!!! transitional
// <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
or use doctype
doctype 5
// <!DOCTYPE html>
Available options: 5, default, xml, transitional, strict, frameset, 1.1, basic, mobile
For single line tag text, you can just append the text after tag name:
p Testing!
would yield
<p>Testing!</p>
For multi line tag text, or nested tags, use indentation:
html
head
title Page Title
body
div#content
p
| This is a long page content
| These lines are all part of the parent p
a(href="/") Go To Main Page
Input template data can be reached by key names directly. For example, assuming the template has been executed with following JSON data:
{
"Name": "Ekin",
"LastName": "Koc",
"Repositories": [
"amber",
"dateformat"
],
"Avatar": "/images/ekin.jpg",
"Friends": 17
}
It is possible to interpolate fields using #{}
p Welcome #{Name}!
would print
<p>Welcome Ekin!</p>
Attributes can have field names as well
a(title=Name, href="/ekin.koc")
would print
<a title="Ekin" href="/ekin.koc"></a>
Jade can expand basic expressions. For example, it is possible to concatenate strings with + operator:
p Welcome #{Name + " " + LastName}
Arithmetic expressions are also supported:
p You need #{50 - Friends} more friends to reach 50!
Expressions can be used within attributes
img(alt=Name + " " + LastName, src=Avatar)
One of the most powerful components of Go templates is the ability to stack actions one after another. This is done by using pipes. Borrowed from Unix pipes, the concept is simple, each pipeline’s output becomes the input of the following pipe.
go-jade supports pipes as well.
p #{"foo" | upper}
becomes
<p>FOO</p>
It is possible to define dynamic variables within templates, all variables must start with a $ character and can be assigned as in the following example:
div
$fullname = Name + " " + LastName
p Welcome #{$fullname}
If you need to access the supplied data itself (i.e. the object containing Name, LastName etc fields.) you can use $ variable
p $.Name
For conditional blocks, it is possible to use if <expression>
div
if Friends > 10
p You have more than 10 friends
else if Friends > 5
p You have more than 5 friends
else
p You need more friends
Again, it is possible to use arithmetic and boolean operators
div
if Name == "Ekin" && LastName == "Koc"
p Hey! I know you..
There is a special syntax for conditional attributes. Only block attributes can have conditions;
div
.hasfriends ? Friends > 0
This would yield a div with hasfriends class only if the Friends > 0 condition holds. It is
perfectly fine to use the same method for other types of attributes:
div
#foo ? Name == "Ekin"
[bar=baz] ? len(Repositories) > 0
It is possible to iterate over arrays and maps using each:
each $repo in Repositories
p #{$repo}
would print
p amber
p dateformat
It is also possible to iterate over values and indexes at the same time
each $i, $repo in Repositories
p
.even ? $i % 2 == 0
.odd ? $i % 2 == 1
Mixins (reusable template blocks that accept arguments) can be defined:
mixin surprise
span Surprise!
mixin link($href, $title, $text)
a(href=$href, title=$title) #{$text}
and then called multiple times within a template (or even within another mixin definition):
div
+surprise
+surprise
+link("http://google.com", "Google", "Check out Google")
Template data, variables, expressions, etc., can all be passed as arguments:
+link(GoogleUrl, $googleTitle, "Check out " + $googleTitle)
A template can import other templates using import:
a.jade
p this is template a
b.jade
p this is template b
c.jade
div
import a
import b
gets compiled to
div
p this is template a
p this is template b
A template can inherit other templates. In order to inherit another template, an extends keyword should be used.
Parent template can define several named blocks and child template can modify the blocks.
master.jade
!!! 5
html
head
block meta
meta(name="description",content="This is a great website")
title
block title
| Default title
body
block content
subpage.jade
extends master
block title
| Some sub page!
block append meta
// This will be added after the description meta tag. It is also possible
// to prepend someting to an existing block
meta(name="keywords", content="foo bar")
block content
div#main
p Some content here
(The MIT License)
Copyright (c) 2014 frogprog Copyright (c) 2012 Ekin Koc ekin@eknkc.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
func Compile(input string, options Options) (*template.Template, error)
Parses and compiles the supplied amber template string. Returns corresponding Go Template (html/templates) instance. Necessary runtime functions will be injected and the template will be ready to be executed.
func CompileFile(filename string, options Options) (*template.Template, error)
Parses and compiles the contents of supplied filename. Returns corresponding Go Template (html/templates) instance. Necessary runtime functions will be injected and the template will be ready to be executed.
func CompileDir(dirname string, dopt DirOptions, opt Options) (map[string]*template.Template, error)
Parses and compiles the contents of a supplied directory name. Returns a mapping of template name (extension stripped) to corresponding Go Template (html/template) instance. Necessary runtime functions will be injected and the template will be ready to be executed.
If there are templates in subdirectories, its key in the map will be it's path relative to dirname. For example:
templates/
|-- index.jade
|-- layouts/
|-- base.jade
templates, err := jade.CompileDir("templates/", jade.DefaultDirOptions, jade.DefaultOptions)
templates["index"] // index.jade Go Template
templates["layouts/base"] // base.jade Go Template
By default, the search will be recursive and will match only files ending in ".jade". If recursive is turned off, it will only search the top level of the directory. Specified extension must start with a period.
type Compiler struct {
// Compiler options
Options
}
Compiler is the main interface of Jade Template Engine. In order to use an Jade template, it is required to create a Compiler and compile an Amber source to native Go template.
compiler := jade.New()
// Parse the input file
err := compiler.ParseFile("./input.jade")
if err == nil {
// Compile input file to Go template
tpl, err := compiler.Compile()
if err == nil {
// Check built in html/template documentation for further details
tpl.Execute(os.Stdout, somedata)
}
}
func New() *Compiler
Create and initialize a new Compiler
func (c *Compiler) Compile() (*template.Template, error)
Compile Jade file and create a Go Template (html/templates) instance. Necessary runtime functions will be injected and the template will be ready to be executed.
func (c *Compiler) CompileString() (string, error)
Compile template and return the Go Template source You would not be using this unless debugging / checking the output. Please use Compile method to obtain a template instance directly.
func (c *Compiler) CompileWriter(out io.Writer) (err error)
Compile Jade file and write the Go Template source into given io.Writer instance You would not be using this unless debugging / checking the output. Please use Compile method to obtain a template instance directly.
func (c *Compiler) Parse(input string) (err error)
Parse given raw Jade template string.
func (c *Compiler) ParseFile(filename string) (err error)
Parse the Jade template file in given path
type Options struct {
// Setting if pretty printing is enabled.
// Pretty printing ensures that the output html is properly indented and in human readable form.
// If disabled, produced HTML is compact. This might be more suitable in production environments.
// Default: true
PrettyPrint bool
// Setting if line number emiting is enabled
// In this form, Jade emits line number comments in the output template. It is usable in debugging environments.
// Default: false
LineNumbers bool
}
// Used to provide options to directory compilation
type DirOptions struct {
// File extension to match for compilation
// Default: ".jade"
Ext string
// Whether or not to walk subdirectories
Recursive bool
}
FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.