Leaf 备忘清单

Leaf 是一种强大的模板语言，其语法受 Swift 启发。

• Leaf 模板语言官方文档 (vapor.codes)
• LeafKit：Swift 模板引擎库 (github.com)
• Leaf：LeafKit 的 Vapor 集成模板系统 (github.com)

import Vapor
import Leaf

设置工作目录

app.directory.workingDirectory = "...."

设置模板目录

app.directory.viewsDirectory = "...."

设置模板引擎

app.views.use(.leaf)

配置自定义标签

app.leaf.tags["relative"] = CustomTag()

VaporApp
├── Package.swift
├── Resources
│   ├── Views
│   │   └── hello.leaf
├── Public
│   ├── images (images 资源)
│   ├── styles (css 资源)
└── Sources
    └── ...

• Views 文件夹来存储 .leaf 文件
• 配置 FileMiddleware 提供静态文件

app.middleware.use(FileMiddleware(
    publicDirectory: 
        app.directory.publicDirectory
))

app.get("hello") { 
    req -> EventLoopFuture<View> in
    return req.view.render("hello", [
        "name": "Leaf"
    ])
}
// 或
app.get("hello") { 
    req async throws -> View in
    return try await req.view.render(
        "hello", ["name": "Leaf"]
    )
}

在 hello.leaf 模板中使用 name

Hello, #(name)!

打开浏览器访问 /hello 显示 Hello, Leaf!。

一个基本的 Leaf 标签使用示例

There are #count(users) users.

可以使用冒号和结束标签为某些标签提供可选的正文。

• 标记 #：这表示 leaf 解析器开始寻找的标记。
• 名称 count：标签的标识符。
• 参数列表 (users)：可以接受零个或多个参数。

#(variable)
#extend("template"): 添加到模板中！#endextend
#export("title"): 欢迎使用 Vapor #endexport
#import("body")
#count(friends)
#for(friend in friends): 
    <li>#(friend.name)</li> 
#endfor

文件夹中的模板

#extend("partials/detail-layout"):
    #export("body"): 详情页面 #endexport
#endextend

• +
• %
• >
• ==
• ||

#if(1 + 1 == 2):
    Hello!
#endif

#if(index % 2 == 0):
    This is even index.
#else:
    This is odd index.
#endif

#if(title == "Welcome"):
    Hello new user!
#elseif(title == "Welcome back!"):
    Hello old user
#else:
    Unexpected page!
#endif

struct SolarSystem: Codable {
  let planets = ["Venus", "Earth", "Mars"]
}
return req.view.render(
  "solarSystem", SolarSystem()
)

在 Leaf 中循环它们：

<ul>
#for(planet in planets):
    <li>#(planet)</li>
#endfor
</ul>

Your search matched #count(matches) pages.

#count 标签返回数组中的项目数量

#lowercased(name)

#lowercased 标签将字符串转成小写字母。

#capitalized(name)

#capitalized 标签将字符串中每个单词的首字母大写，其他字母小写。

#if(contains(planets, "Earth")):
    Earth is here!
#else:
    Earth is not in this array.
#endif

#contains 标签接受一个数组和一个值作为其两个参数，如果参数一中的数组包含参数二中的值，则返回 true。

标签就像一个变量标签 - 例如 #(variable)。

The time is #unsafeHTML(styledTitle)

它不会转义任何 variable 可能包含的 HTML 标签

#dumpContext 标签将整个上下文渲染为可读的字符串。使用此标记来调试作为上下文提供给当前渲染的内容。

Hello, world!
#dumpContext

实现了 NowTag，告诉 Leaf 并设置标签名称为 #now

app.leaf.tags["now"] = NowTag()

现在可以在 Leaf 中使用我们的自定义标签 #now 了

The time is #now()