Edge 辅助函数和标签
在本指南中,我们将了解 AdonisJS 官方包为 Edge 提供的 辅助函数(helpers)和标签(tags)。Edge 自带的辅助函数不包含在本指南中,必须参考 Edge 文档。
request
引用正在进行的 HTTP 请求 的实例。该属性仅在使用 ctx.view.render 方法渲染模板时可用。
{{ request.url() }}
{{ request.input('signature') }}
route/signedRoute
使用 URL 构建器 为路由创建 URL 的辅助函数。与 URL 构建器不同,视图辅助函数没有流畅的 API,而是接受以下参数。
| 位置 | 描述 |
| 第 1 个 | 路由标识符或路由模式 |
| 第 2 个 | 定义为数组或对象的路由参数。 |
| 第 3 个 |
具有以下属性的选项对象。
|
<a href="{{ route('posts.show', [post.id]) }}">
View post
</a>
<a href="{{
signedRoute('unsubscribe', [user.id], {
expiresIn: '3 days',
prefixUrl: 'https://blog.adonisjs.com'
})
}}">
Unsubscribe
</a>
app
引用 Application 实例。
{{ app.getEnvironment() }}
config
在 Edge 模板中引用配置值的 辅助函数。你可以使用 config.has 方法检查键的值是否存在。
@if(config.has('app.appUrl'))
<a href="{{ config('app.appUrl') }}"> Home </a>
@else
<a href="/"> Home </a>
@end
session
session 对象 的只读副本。你不能在 Edge 模板中修改会话数据。session 属性仅在通过 ctx.view.render 方法渲染模板时可用。
Post views: {{ session.get(`post.${post.id}.visits`) }}
flashMessages
session flash messages 的只读副本。flashMessages 属性仅在通过 ctx.view.render 方法渲染模板时可用。
@if(flashMessages.has('inputErrorsBag.title'))
<p>{{ flashMessages.get('inputErrorsBag.title') }}</p>
@end
@if(flashMessages.has('notification'))
<div class="notification {{ flashMessages.get('notification').type }}">
{{ flashMessages.get('notification').message }}
</div>
@end
old
old 方法是 flashMessages.get 方法的简写。
<input
type="text"
name="email"
value="{{ old('name') || '' }}"
/>
t
t 方法由 @adonisjs/i18n 包提供,用于使用 i18n 类 显示翻译。该方法接受翻译键标识符、消息数据和回退消息作为参数。
<h1> {{ t('messages.greeting') }} </h1>
i18n
引用使用应用程序默认区域设置配置的 I18n 类实例。但是,DetectUserLocaleMiddleware 会用为当前 HTTP 请求区域设置创建的实例覆盖此属性。
{{ i18n.formatCurrency(200, { currency: 'USD' }) }}
auth
引用由 InitializeAuthMiddleware 共享的 ctx.auth 属性。你可以使用此属性访问有关已登录用户的信息。
@if(auth.isAuthenticated)
<p> {{ auth.user.email }} </p>
@end
如果你在公共页面(不受 auth 中间件保护)上显示已登录用户的信息,那么你可能希望先静默检查用户是否已登录。
{{-- Check if user is logged-in --}}
@eval(await auth.use('web').check())
@if(auth.use('web').isAuthenticated)
<p> {{ auth.use('web').user.email }} </p>
@end
asset
解析 Vite 处理的资产的 URL。了解更多关于 在 Edge 模板中引用资产 的信息。
<img src="{{ asset('resources/images/hero.jpg') }}" />
embedImage / embedImageData
embedImage 和 embedImageData 辅助函数由 mail 包添加,仅在渲染发送电子邮件的模板时可用。
<img src="{{
embedImage(app.makePath('assets/hero.jpg'))
}}" />
@flashMessage
@flashMessage 标签提供了更好的开发体验 (DX),用于有条件地读取给定键的 flash 消息。
而不是编写条件语句
@if(flashMessages.has('notification'))
<div class="notification {{ flashMessages.get('notification').type }}">
{{ flashMessages.get('notification').message }}
</div>
@end
你可能更喜欢使用标签
@flashMessage('notification')
<div class="notification {{ $message.type }}">
{{ $message.message }}
</div>
@end
@error
@error 标签提供了更好的开发体验 (DX),用于读取存储在 flashMessages 中 errorsBag 键内的错误消息。
而不是编写条件语句
@if(flashMessages.has('errorsBag.E_BAD_CSRF_TOKEN'))
<p>{{ flashMessages.get('errorsBag.E_BAD_CSRF_TOKEN') }}</p>
@end
你可能更喜欢使用标签
@error('E_BAD_CSRF_TOKEN')
<p>{{ $message }}</p>
@end
@inputError
@inputError 标签提供了更好的开发体验 (DX),用于读取存储在 flashMessages 中 inputErrorsBag 键内的验证错误消息。
而不是编写条件语句
@if(flashMessages.has('inputErrorsBag.title'))
@each(message in flashMessages.get('inputErrorsBag.title'))
<p>{{ message }}</p>
@end
@end
你可能更喜欢使用标签
@inputError('title')
@each(message in $messages)
<p>{{ message }}</p>
@end
@end
@vite
@vite 标签接受入口点路径数组,并返回相应的 script 和 link 标签。你提供给 @vite 标签的路径应与 vite.config.js 文件中注册的路径完全匹配。
export default defineConfig({
plugins: [
adonisjs({
entrypoints: ['resources/js/app.js'],
}),
]
})
@vite(['resources/js/app.js'])
你可以将 script 标签属性定义为第 2 个参数。例如:
@vite(['resources/js/app.js'], {
defer: true,
})
@viteReactRefresh
@viteReactRefresh 标签返回一个 启用 React HMR 的 script 标签,用于使用 @vitejs/plugin-react 包的项目。
@viteReactRefresh()
输出 HTML
<script type="module">
import RefreshRuntime from 'http://localhost:5173/@react-refresh'
RefreshRuntime.injectIntoGlobalHook(window)
window.$RefreshReg$ = () => {}
window.$RefreshSig$ = () => (type) => type
window.__vite_plugin_react_preamble_installed__ = true
</script>
@can/@cannot
@can 和 @cannot 标签允许你在 Edge 模板中通过引用能力名称或策略名称作为字符串来编写授权检查。
第一个参数是能力或策略引用,后跟检查所接受的参数。
另请参阅:预注册能力和策略
@can('editPost', post)
{{-- Can edit post --}}
@end
@can('PostPolicy.edit', post)
{{-- Can edit post --}}
@end
@cannot('editPost', post)
{{-- Cannot edit post --}}
@end
@cannot('editPost', post)
{{-- Cannot edit post --}}
@end