mirror
/
vapor-docs
mirror of https://github.com/vapor/docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
vapor-docs/build/2.0/leaf/leaf/index.html

2193 lines
52 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="shortcut icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-0.16.2, mkdocs-material-1.1.1">
<title>Overview - Vapor Docs</title>
<script src="../../assets/javascripts/modernizr-56ade86843.js"></script>
<link rel="stylesheet" href="../../assets/stylesheets/application-e5b48ab351.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto Slab:300,400,400i,700|Source+Code+Pro">
<style>body,input{font-family:"Roboto Slab","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Source Code Pro","Courier New",Courier,monospace}</style>
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<link rel="stylesheet" href="../../stylesheets/extra.css">
</head>
<body>
<svg class="md-svg">
<defs>
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
</defs>
</svg>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="drawer">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="search">
<label class="md-overlay" data-md-component="overlay" for="drawer"></label>
<header class="md-header">
<nav class="md-header-nav md-grid">
<div class="md-flex">
<div class="md-flex__cell md-flex__cell--shrink">
<a href="../.." title="Vapor Docs" class="md-logo md-header-nav__button">
<img src="../../images/droplet-white.svg" width="24" height="24">
</a>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
</div>
<div class="md-flex__cell md-flex__cell--stretch">
<span class="md-flex__ellipsis md-header-nav__title">
<span class="md-header-nav__parent">
Leaf
</span>
Overview
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
<div class="md-search" data-md-component="search">
<div class="md-search__overlay"></div>
<div class="md-search__inner">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" placeholder="Search" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
<label class="md-icon md-search__icon" for="search"></label>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="result"></div>
</div>
</div>
</div>
</div>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<div class="md-header-nav__source">
<a href="https://github.com/vapor/documentation" title="Go to repository" class="md-source" data-md-source="github">
<div class="md-source__icon">
<svg viewBox="0 0 24 24" width="24" height="24">
<use xlink:href="#github" width="24" height="24"></use>
</svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container">
<main class="md-main">
<div class="md-main__inner md-grid" data-md-component="container">
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" data-md-level="0">
<label class="md-nav__title md-nav__title--site" for="drawer">
<i class="md-logo md-nav__button">
<img src="../../images/droplet-white.svg">
</i>
Vapor Docs
</label>
<div class="md-nav__source">
<a href="https://github.com/vapor/documentation" title="Go to repository" class="md-source" data-md-source="github">
<div class="md-source__icon">
<svg viewBox="0 0 24 24" width="24" height="24">
<use xlink:href="#github" width="24" height="24"></use>
</svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." title="Overview" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">
<label class="md-nav__link" for="nav-2">
Getting started
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-2">
Getting started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../getting-started/install-on-macos/" title="Install: macOS" class="md-nav__link">
Install: macOS
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/install-on-ubuntu/" title="Install: Ubuntu" class="md-nav__link">
Install: Ubuntu
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/toolbox/" title="Toolbox" class="md-nav__link">
Toolbox
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/hello-world/" title="Hello, World" class="md-nav__link">
Hello, World
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/manual/" title="Manual" class="md-nav__link">
Manual
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/xcode/" title="Xcode" class="md-nav__link">
Xcode
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
<label class="md-nav__link" for="nav-3">
Vapor
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-3">
Vapor
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../vapor/folder-structure/" title="Folder Structure" class="md-nav__link">
Folder Structure
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/droplet/" title="Droplet" class="md-nav__link">
Droplet
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/views/" title="Views" class="md-nav__link">
Views
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/controllers/" title="Controllers" class="md-nav__link">
Controllers
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/hash/" title="Hash" class="md-nav__link">
Hash
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/log/" title="Log" class="md-nav__link">
Log
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/commands/" title="Commands" class="md-nav__link">
Commands
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
<label class="md-nav__link" for="nav-4">
Configs
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-4">
Configs
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../configs/config/" title="Config" class="md-nav__link">
Config
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
<label class="md-nav__link" for="nav-5">
JSON
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-5">
JSON
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../json/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../json/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
<label class="md-nav__link" for="nav-6">
Routing
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-6">
Routing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../routing/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../routing/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../../routing/parameters/" title="Parameters" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="../../routing/group/" title="Group" class="md-nav__link">
Group
</a>
</li>
<li class="md-nav__item">
<a href="../../routing/collection/" title="Collection" class="md-nav__link">
Collection
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
<label class="md-nav__link" for="nav-7">
Fluent
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-7">
Fluent
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../fluent/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/model/" title="Model" class="md-nav__link">
Model
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/database/" title="Database" class="md-nav__link">
Database
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/query/" title="Query" class="md-nav__link">
Query
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/relations/" title="Relations" class="md-nav__link">
Relations
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
<label class="md-nav__link" for="nav-8">
Cache
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-8">
Cache
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cache/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../cache/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
<label class="md-nav__link" for="nav-9">
MySQL
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-9">
MySQL
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../mysql/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../mysql/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
<li class="md-nav__item">
<a href="../../mysql/driver/" title="Driver" class="md-nav__link">
Driver
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
<label class="md-nav__link" for="nav-10">
Redis
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-10">
Redis
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../redis/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../redis/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-11" type="checkbox" id="nav-11">
<label class="md-nav__link" for="nav-11">
Auth
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-11">
Auth
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../auth/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/helper/" title="Helper" class="md-nav__link">
Helper
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/password/" title="Password" class="md-nav__link">
Password
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/persist/" title="Persist" class="md-nav__link">
Persist
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-12" type="checkbox" id="nav-12">
<label class="md-nav__link" for="nav-12">
Sessions
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-12">
Sessions
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../sessions/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../sessions/sessions/" title="Sessions" class="md-nav__link">
Sessions
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-13" type="checkbox" id="nav-13">
<label class="md-nav__link" for="nav-13">
HTTP
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-13">
HTTP
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../http/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../http/request/" title="Request" class="md-nav__link">
Request
</a>
</li>
<li class="md-nav__item">
<a href="../../http/response/" title="Response" class="md-nav__link">
Response
</a>
</li>
<li class="md-nav__item">
<a href="../../http/middleware/" title="Middleware" class="md-nav__link">
Middleware
</a>
</li>
<li class="md-nav__item">
<a href="../../http/body/" title="Body" class="md-nav__link">
Body
</a>
</li>
<li class="md-nav__item">
<a href="../../http/response-representable/" title="ResponseRepresentable" class="md-nav__link">
ResponseRepresentable
</a>
</li>
<li class="md-nav__item">
<a href="../../http/responder/" title="Responder" class="md-nav__link">
Responder
</a>
</li>
<li class="md-nav__item">
<a href="../../http/client/" title="Client" class="md-nav__link">
Client
</a>
</li>
<li class="md-nav__item">
<a href="../../http/server/" title="Server" class="md-nav__link">
Server
</a>
</li>
<li class="md-nav__item">
<a href="../../http/cors/" title="CORS" class="md-nav__link">
CORS
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-14" type="checkbox" id="nav-14" checked>
<label class="md-nav__link" for="nav-14">
Leaf
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-14">
Leaf
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="toc">
<label class="md-nav__link md-nav__link--active" for="toc">
Overview
</label>
<a href="./" title="Overview" class="md-nav__link md-nav__link--active">
Overview
</a>
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#syntax" title="Syntax" class="md-nav__link">
Syntax
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#structure" title="Structure" class="md-nav__link">
Structure
</a>
</li>
<li class="md-nav__item">
<a href="#using-the-token-in-html" title="Using the # token in HTML" class="md-nav__link">
Using the # token in HTML
</a>
</li>
<li class="md-nav__item">
<a href="#raw-html" title="Raw HTML" class="md-nav__link">
Raw HTML
</a>
</li>
<li class="md-nav__item">
<a href="#chaining" title="Chaining" class="md-nav__link">
Chaining
</a>
</li>
<li class="md-nav__item">
<a href="#leafs-built-in-tags" title="Leaf's built-in Tags" class="md-nav__link">
Leaf's built-in Tags
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#token" title="Token: #()" class="md-nav__link">
Token: #()
</a>
</li>
<li class="md-nav__item">
<a href="#raw-raw" title="Raw: #raw() {}" class="md-nav__link">
Raw: #raw() {}
</a>
</li>
<li class="md-nav__item">
<a href="#equal-equallhs-rhs" title="Equal: #equal(lhs, rhs) {}" class="md-nav__link">
Equal: #equal(lhs, rhs) {}
</a>
</li>
<li class="md-nav__item">
<a href="#variable-variable" title="Variable: #(variable)" class="md-nav__link">
Variable: #(variable)
</a>
</li>
<li class="md-nav__item">
<a href="#loop-loopobject-index" title="Loop: #loop(object, "index")" class="md-nav__link">
Loop: #loop(object, "index")
</a>
</li>
<li class="md-nav__item">
<a href="#index-indexobject-_-index-intstring" title="Index: #index(object, _ index: Int|String)" class="md-nav__link">
Index: #index(object, _ index: Int|String)
</a>
</li>
<li class="md-nav__item">
<a href="#if-else-ifbool-else-this" title="If - Else: #if(bool) ##else() { this }" class="md-nav__link">
If - Else: #if(bool) ##else() { this }
</a>
</li>
<li class="md-nav__item">
<a href="#import-importtemplate" title="Import: #import("template")" class="md-nav__link">
Import: #import("template")
</a>
</li>
<li class="md-nav__item">
<a href="#export-exporttemplate-leafhtml" title="Export: #export("template") { Leaf/HTML }" class="md-nav__link">
Export: #export("template") { Leaf/HTML }
</a>
</li>
<li class="md-nav__item">
<a href="#extend-extendtemplate" title="Extend: #extend("template")" class="md-nav__link">
Extend: #extend("template")
</a>
</li>
<li class="md-nav__item">
<a href="#embed-embedtemplate" title="Embed: #embed("template")" class="md-nav__link">
Embed: #embed("template")
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#custom-tags" title="Custom Tags" class="md-nav__link">
Custom Tags
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#syntax-highlighting" title="Syntax Highlighting" class="md-nav__link">
Syntax Highlighting
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#atom" title="Atom" class="md-nav__link">
Atom
</a>
</li>
<li class="md-nav__item">
<a href="#xcode" title="Xcode" class="md-nav__link">
Xcode
</a>
</li>
<li class="md-nav__item">
<a href="#vs-code" title="VS Code" class="md-nav__link">
VS Code
</a>
</li>
<li class="md-nav__item">
<a href="#clion-appcode" title="CLion &amp; AppCode" class="md-nav__link">
CLion &amp; AppCode
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-15" type="checkbox" id="nav-15">
<label class="md-nav__link" for="nav-15">
Validation
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-15">
Validation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../validation/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../validation/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-16" type="checkbox" id="nav-16">
<label class="md-nav__link" for="nav-16">
Node
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-16">
Node
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../node/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../node/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-17" type="checkbox" id="nav-17">
<label class="md-nav__link" for="nav-17">
Core
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-17">
Core
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../core/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../core/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-18" type="checkbox" id="nav-18">
<label class="md-nav__link" for="nav-18">
Bits
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-18">
Bits
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../bits/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../bits/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-19" type="checkbox" id="nav-19">
<label class="md-nav__link" for="nav-19">
Debugging
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-19">
Debugging
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../debugging/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../debugging/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-20" type="checkbox" id="nav-20">
<label class="md-nav__link" for="nav-20">
Deploy
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-20">
Deploy
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../deploy/nginx/" title="Nginx" class="md-nav__link">
Nginx
</a>
</li>
<li class="md-nav__item">
<a href="../../deploy/supervisor/" title="Supervisor" class="md-nav__link">
Supervisor
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-21" type="checkbox" id="nav-21">
<label class="md-nav__link" for="nav-21">
Version (2.0)
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-21">
Version (2.0)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../version/1_5/" title="1.5" class="md-nav__link">
1.5
</a>
</li>
<li class="md-nav__item">
<a href="../../version/2_0/" title="2.0" class="md-nav__link">
2.0
</a>
</li>
<li class="md-nav__item">
<a href="../../version/support/" title="Support" class="md-nav__link">
Support
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#syntax" title="Syntax" class="md-nav__link">
Syntax
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#structure" title="Structure" class="md-nav__link">
Structure
</a>
</li>
<li class="md-nav__item">
<a href="#using-the-token-in-html" title="Using the # token in HTML" class="md-nav__link">
Using the # token in HTML
</a>
</li>
<li class="md-nav__item">
<a href="#raw-html" title="Raw HTML" class="md-nav__link">
Raw HTML
</a>
</li>
<li class="md-nav__item">
<a href="#chaining" title="Chaining" class="md-nav__link">
Chaining
</a>
</li>
<li class="md-nav__item">
<a href="#leafs-built-in-tags" title="Leaf's built-in Tags" class="md-nav__link">
Leaf's built-in Tags
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#token" title="Token: #()" class="md-nav__link">
Token: #()
</a>
</li>
<li class="md-nav__item">
<a href="#raw-raw" title="Raw: #raw() {}" class="md-nav__link">
Raw: #raw() {}
</a>
</li>
<li class="md-nav__item">
<a href="#equal-equallhs-rhs" title="Equal: #equal(lhs, rhs) {}" class="md-nav__link">
Equal: #equal(lhs, rhs) {}
</a>
</li>
<li class="md-nav__item">
<a href="#variable-variable" title="Variable: #(variable)" class="md-nav__link">
Variable: #(variable)
</a>
</li>
<li class="md-nav__item">
<a href="#loop-loopobject-index" title="Loop: #loop(object, "index")" class="md-nav__link">
Loop: #loop(object, "index")
</a>
</li>
<li class="md-nav__item">
<a href="#index-indexobject-_-index-intstring" title="Index: #index(object, _ index: Int|String)" class="md-nav__link">
Index: #index(object, _ index: Int|String)
</a>
</li>
<li class="md-nav__item">
<a href="#if-else-ifbool-else-this" title="If - Else: #if(bool) ##else() { this }" class="md-nav__link">
If - Else: #if(bool) ##else() { this }
</a>
</li>
<li class="md-nav__item">
<a href="#import-importtemplate" title="Import: #import("template")" class="md-nav__link">
Import: #import("template")
</a>
</li>
<li class="md-nav__item">
<a href="#export-exporttemplate-leafhtml" title="Export: #export("template") { Leaf/HTML }" class="md-nav__link">
Export: #export("template") { Leaf/HTML }
</a>
</li>
<li class="md-nav__item">
<a href="#extend-extendtemplate" title="Extend: #extend("template")" class="md-nav__link">
Extend: #extend("template")
</a>
</li>
<li class="md-nav__item">
<a href="#embed-embedtemplate" title="Embed: #embed("template")" class="md-nav__link">
Embed: #embed("template")
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#custom-tags" title="Custom Tags" class="md-nav__link">
Custom Tags
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#syntax-highlighting" title="Syntax Highlighting" class="md-nav__link">
Syntax Highlighting
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#atom" title="Atom" class="md-nav__link">
Atom
</a>
</li>
<li class="md-nav__item">
<a href="#xcode" title="Xcode" class="md-nav__link">
Xcode
</a>
</li>
<li class="md-nav__item">
<a href="#vs-code" title="VS Code" class="md-nav__link">
VS Code
</a>
</li>
<li class="md-nav__item">
<a href="#clion-appcode" title="CLion &amp; AppCode" class="md-nav__link">
CLion &amp; AppCode
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/vapor/documentation/edit/master/2.0/docs/leaf/leaf.md" title="Edit this page" class="md-icon md-content__edit">edit</a>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This section may contain outdated information.</p>
</div>
<h1 id="leaf">Leaf<a class="headerlink" href="#leaf" title="Permanent link">&para;</a></h1>
<p>Welcome to Leaf. Leaf's goal is to be a simple templating language that can make generating views easier. There's a lot of great templating languages, use what's best for you, maybe that's Leaf! The goals of Leaf are as follows:</p>
<ul>
<li>Small set of strictly enforced rules</li>
<li>Consistency</li>
<li>Parser first mentality</li>
<li>Extensibility</li>
</ul>
<h2 id="syntax">Syntax<a class="headerlink" href="#syntax" title="Permanent link">&para;</a></h2>
<h3 id="structure">Structure<a class="headerlink" href="#structure" title="Permanent link">&para;</a></h3>
<p>Leaf Tags are made up of 4 Elements:
- Token: <code>#</code> is the Token
- Name: A <code>string</code> that identifies the tag
- Parameter List: <code>()</code> May accept 0 or more arguments
- Body (optional): <code>{}</code> Must be separated from the Parameter List by a space</p>
<p>There can be many different usages of these 4 elements depending on the Tag's implementation. Let's look at a few examples of how Leaf's built-in Tags might be used:</p>
<ul>
<li><code>#()</code></li>
<li><code>#(variable)</code></li>
<li><code>#import("template")</code></li>
<li><code>#export("link") { &lt;a href="#()"&gt;&lt;/a&gt; }</code></li>
<li><code>#index(friends, "0")</code></li>
<li><code>#loop(friends, "friend") { &lt;li&gt;#(friend.name)&lt;/li&gt; }</code></li>
<li><code>#raw() { &lt;a href="#raw"&gt;Anything goes!@#$%^&amp;*&lt;/a&gt; }</code></li>
</ul>
<h3 id="using-the-token-in-html">Using the <code>#</code> token in HTML<a class="headerlink" href="#using-the-token-in-html" title="Permanent link">&para;</a></h3>
<p>The <code>#</code> token cannot be escaped. Use the <code>#()</code> or <code>#raw() {}</code> Tag to output a <code>#</code> in a Leaf Template. <code>#()</code> =&gt; <code>#</code></p>
<h3 id="raw-html">Raw HTML<a class="headerlink" href="#raw-html" title="Permanent link">&para;</a></h3>
<p>All Leaf output is escaped by default. Use the <code>#raw() {}</code> Tag for unescaped output.
<code>#raw() { &lt;a href="#link"&gt;Link&lt;/a&gt; }</code> =&gt; <code>&lt;a href="#link"&gt;Link&lt;/a&gt;</code></p>
<blockquote>
<p>IMPORTANT! Make sure you are not using the <code>#raw() {}</code> Tag with user input.</p>
</blockquote>
<h3 id="chaining">Chaining<a class="headerlink" href="#chaining" title="Permanent link">&para;</a></h3>
<p>The double token: <code>##</code> indicates a chain. It can be applied to any standard Tag. If the previous Tag fails, the chained Tag will be given an opportunity to run.</p>
<div class="codehilite"><pre><span></span>#if(hasFriends) ##embed(&quot;getFriends&quot;)
</pre></div>
<h3 id="leafs-built-in-tags">Leaf's built-in Tags<a class="headerlink" href="#leafs-built-in-tags" title="Permanent link">&para;</a></h3>
<h4 id="token">Token: <code>#()</code><a class="headerlink" href="#token" title="Permanent link">&para;</a></h4>
<div class="codehilite"><pre><span></span>#() #()hashtags #()FTW =&gt; # #Hashtags #FTW
</pre></div>
<h4 id="raw-raw">Raw: <code>#raw() {}</code><a class="headerlink" href="#raw-raw" title="Permanent link">&para;</a></h4>
<div class="codehilite"><pre><span></span>#raw() {
Do whatever w/ #&#39;s here, this code won&#39;t be rendered as leaf document and is not escaped.
It&#39;s a great place for things like Javascript or large HTML sections.
}
</pre></div>
<h4 id="equal-equallhs-rhs">Equal: <code>#equal(lhs, rhs) {}</code><a class="headerlink" href="#equal-equallhs-rhs" title="Permanent link">&para;</a></h4>
<div class="codehilite"><pre><span></span>#equal(leaf, leaf) { Leaf == Leaf } =&gt; Leaf == Leaf
#equal(leaf, mustache) { Leaf == Mustache } =&gt;
</pre></div>
<h4 id="variable-variable">Variable: <code>#(variable)</code><a class="headerlink" href="#variable-variable" title="Permanent link">&para;</a></h4>
<div class="codehilite"><pre><span></span>Hello, #(name)!
</pre></div>
<h4 id="loop-loopobject-index">Loop: <code>#loop(object, "index")</code><a class="headerlink" href="#loop-loopobject-index" title="Permanent link">&para;</a></h4>
<div class="codehilite"><pre><span></span>#loop(friends, &quot;friend&quot;) {
Hello, #(friend.name)!
}
</pre></div>
<h4 id="index-indexobject-_-index-intstring">Index: <code>#index(object, _ index: Int|String)</code><a class="headerlink" href="#index-indexobject-_-index-intstring" title="Permanent link">&para;</a></h4>
<div class="codehilite"><pre><span></span>Hello, #index(friends, 0)!
Hello, #index(friends, &quot;best&quot;)!
</pre></div>
<h4 id="if-else-ifbool-else-this">If - Else: <code>#if(bool) ##else() { this }</code><a class="headerlink" href="#if-else-ifbool-else-this" title="Permanent link">&para;</a></h4>
<div class="codehilite"><pre><span></span>#if(entering) {
Hello, there!
} ##if(leaving) {
Goodbye!
} ##else() {
I&#39;ve been here the whole time.
}
</pre></div>
<h4 id="import-importtemplate">Import: <code>#import("template")</code><a class="headerlink" href="#import-importtemplate" title="Permanent link">&para;</a></h4>
<h4 id="export-exporttemplate-leafhtml">Export: <code>#export("template") { Leaf/HTML }</code><a class="headerlink" href="#export-exporttemplate-leafhtml" title="Permanent link">&para;</a></h4>
<h4 id="extend-extendtemplate">Extend: <code>#extend("template")</code><a class="headerlink" href="#extend-extendtemplate" title="Permanent link">&para;</a></h4>
<h4 id="embed-embedtemplate">Embed: <code>#embed("template")</code><a class="headerlink" href="#embed-embedtemplate" title="Permanent link">&para;</a></h4>
<blockquote>
<p>When using these Layout Tags, omit the template file's .leaf extension.</p>
</blockquote>
<div class="codehilite"><pre><span></span>/// base.leaf
&lt;!DOCTYPE html&gt;
#import(&quot;html&quot;)
/// html.leaf
#extend(&quot;base&quot;)
#export(&quot;html&quot;) { &lt;html&gt;#embed(&quot;body&quot;)&lt;/html&gt; }
/// body.leaf
&lt;body&gt;&lt;/body&gt;
</pre></div>
<p>Leaf renders <code>html.leaf</code> as:</p>
<div class="codehilite"><pre><span></span>&lt;!DOCTYPE html&gt;
&lt;html&gt;&lt;body&gt;&lt;/body&gt;&lt;/html&gt;
</pre></div>
<h3 id="custom-tags">Custom Tags<a class="headerlink" href="#custom-tags" title="Permanent link">&para;</a></h3>
<p>Look at the existing tags for advanced scenarios, let's look at a basic example by creating <code>Index</code> together. This tag will take two arguments, an array, and an index to access.</p>
<div class="codehilite"><pre><span></span><span class="kd">class</span> <span class="nc">Index</span><span class="p">:</span> <span class="n">BasicTag</span> <span class="p">{</span>
<span class="kd">let</span> <span class="nv">name</span> <span class="p">=</span> <span class="s">&quot;index&quot;</span>
<span class="kd">func</span> <span class="nf">run</span><span class="p">(</span><span class="n">arguments</span><span class="p">:</span> <span class="p">[</span><span class="n">Argument</span><span class="p">])</span> <span class="kr">throws</span> <span class="p">-&gt;</span> <span class="n">Node</span><span class="p">?</span> <span class="p">{</span>
<span class="k">guard</span>
<span class="n">arguments</span><span class="p">.</span><span class="bp">count</span> <span class="p">==</span> <span class="mi">2</span><span class="p">,</span>
<span class="kd">let</span> <span class="nv">array</span> <span class="p">=</span> <span class="n">arguments</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="n">value</span><span class="p">?.</span><span class="n">nodeArray</span><span class="p">,</span>
<span class="kd">let</span> <span class="nv">index</span> <span class="p">=</span> <span class="n">arguments</span><span class="p">[</span><span class="mi">1</span><span class="p">].</span><span class="n">value</span><span class="p">?.</span><span class="n">int</span><span class="p">,</span>
<span class="n">index</span> <span class="o">&lt;</span> <span class="n">array</span><span class="p">.</span><span class="bp">count</span>
<span class="k">else</span> <span class="p">{</span> <span class="k">return</span> <span class="kc">nil</span> <span class="p">}</span>
<span class="k">return</span> <span class="n">array</span><span class="p">[</span><span class="n">index</span><span class="p">]</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
<p>We can now register this Tag in our <code>main.swift</code> file with:</p>
<div class="codehilite"><pre><span></span><span class="k">if</span> <span class="kd">let</span> <span class="nv">leaf</span> <span class="p">=</span> <span class="n">drop</span><span class="p">.</span><span class="n">view</span> <span class="k">as</span><span class="p">?</span> <span class="n">LeafRenderer</span> <span class="p">{</span>
<span class="n">leaf</span><span class="p">.</span><span class="n">stem</span><span class="p">.</span><span class="n">register</span><span class="p">(</span><span class="n">Index</span><span class="p">())</span>
<span class="p">}</span>
</pre></div>
<p>And use it just like we did <a href="#index">above</a>.</p>
<blockquote>
<p>Note: Use of non-alphanumeric characters in Tag Names is <strong>strongly discouraged</strong> and may be disallowed in future versions of Leaf.</p>
</blockquote>
<h2 id="syntax-highlighting">Syntax Highlighting<a class="headerlink" href="#syntax-highlighting" title="Permanent link">&para;</a></h2>
<h3 id="atom">Atom<a class="headerlink" href="#atom" title="Permanent link">&para;</a></h3>
<p><a href="https://atom.io/packages/language-leaf">language-leaf</a> by ButkiewiczP</p>
<h3 id="xcode">Xcode<a class="headerlink" href="#xcode" title="Permanent link">&para;</a></h3>
<p>It is not currently possible to implement Leaf Syntax Highlighting in Xcode, however, using Xcode's HTML Syntax Coloring can help a bit. Select one or more Leaf files and then choose Editor &gt; Syntax Coloring &gt; HTML. Your selected Leaf files will now use Xcode's HTML Syntax Coloring. Unfortunately the usefulness of this is limited because this association will be removed when <code>vapor xcode</code> is run.</p>
<p>There appears to be a way to <a href="http://stackoverflow.com/questions/9050035/how-to-make-xcode-recognize-a-custom-file-extension-as-objective-c-for-syntax-hi">make Xcode file associations persist</a> but that requires a bit more kung-fu.</p>
<h3 id="vs-code">VS Code<a class="headerlink" href="#vs-code" title="Permanent link">&para;</a></h3>
<p><a href="https://marketplace.visualstudio.com/items?itemName=Francisco.html-leaf">html-leaf</a> by FranciscoAmado</p>
<h3 id="clion-appcode">CLion &amp; AppCode<a class="headerlink" href="#clion-appcode" title="Permanent link">&para;</a></h3>
<p>Some preliminary work has been done to implement a Leaf Plugin for CLion &amp; AppCode but lack of skill and interest in Java has slowed progress! If you have IntelliJ SDK experience and want to help with this, message Tom Holland on <a href="http://vapor.team">Vapor Slack</a></p>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid">
<a href="../provider/" title="Provider" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
</div>
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Previous
</span>
Provider
</span>
</div>
</a>
<a href="../../validation/package/" title="Package" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Package
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
</div>
</a>
</nav>
</div>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
<div class="md-footer-copyright__highlight">
Copyright &copy; 2017 Qutheory, LLC
</div>
powered by
<a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
and
<a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs">
Material for MkDocs</a>
</div>
<div class="md-footer-social">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<a href="https://twitter.com/@codevapor" class="md-footer-social__link fa fa-twitter"></a>
<a href="http://vapor.team/" class="md-footer-social__link fa fa-slack"></a>
</div>
</div>
</div>
</footer>
</div>
<script src="../../assets/javascripts/application-f6cd941c96.js"></script>
<script>app.initialize({url:{base:"../.."}})</script>
<script>!function(e,t,n,a,o,c,i){e.GoogleAnalyticsObject=o,e[o]=e[o]||function(){(e[o].q=e[o].q||[]).push(arguments)},e[o].l=1*new Date,c=t.createElement(n),i=t.getElementsByTagName(n)[0],c.async=1,c.src=a,i.parentNode.insertBefore(c,i)}(window,document,"script","https://www.google-analytics.com/analytics.js","ga"),ga("create","UA-76177358-4","auto"),ga("set","anonymizeIp",!0),ga("send","pageview");var links=document.getElementsByTagName("a");Array.prototype.map.call(links,function(e){e.host!=document.location.host&&e.addEventListener("click",function(){var t=e.getAttribute("data-md-action")||"follow";ga("send","event","outbound",t,e.href)})}),document.forms.search.query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink