mirror of
https://github.com/tiennm99/hugoDocs.git
synced 2026-10-17 08:14:30 +00:00
Clarify data type returned by partial and partialCached
This commit is contained in:
1 parent
1de5a52dda
commit
ad2a82fbdd
4 files changed
+163
-12
No files matched your search
@@ -1,19 +1,24 @@
|
||||
---
|
||||
title: partials.Include
|
||||
description: Executes the given partial template, optionally passing context. If the partial contains a return statement, returns that value, else returns the rendered output.
|
||||
description: Executes the given partial template, optionally passing context. If the partial template contains a return statement, returns the given value, else returns the rendered output.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
aliases: [partial]
|
||||
related:
|
||||
- functions/go-template/template
|
||||
- functions/go-template/return
|
||||
- functions/partials/IncludeCached
|
||||
- functions/go-template/template
|
||||
- methods/page/Render
|
||||
returnType: any
|
||||
signatures: ['partials.Include NAME [CONTEXT]']
|
||||
aliases: [/functions/partial]
|
||||
---
|
||||
|
||||
Without a [`return`] statement, the `partial` function returns a string of type `template.HTML`. With a `return` statement, the `partial` function can return any data type.
|
||||
|
||||
[`return`]: /functions/go-template/return
|
||||
|
||||
In this example we have three partial templates:
|
||||
|
||||
```text
|
||||
@@ -60,4 +65,21 @@ Then, within the partial template:
|
||||
<p>{{ .name }} is majoring in {{ .major }}. Their grade point average is {{ .gpa }}.</p>
|
||||
```
|
||||
|
||||
To return a value from a partial template, it must contain only one `return` statement, placed at the end of the template:
|
||||
|
||||
```go-html-template
|
||||
{{ $result := false }}
|
||||
{{ if math.ModBool . 2 }}
|
||||
{{ $result = "even" }}
|
||||
{{ else }}
|
||||
{{ $result = "odd" }}
|
||||
{{ end }}
|
||||
{{ return $result }}
|
||||
```
|
||||
|
||||
See [details][`return`].
|
||||
|
||||
[`return`]: /functions/go-template/return
|
||||
|
||||
[breadcrumb navigation]: /content-management/sections/#ancestors-and-descendants
|
||||
[details]: /functions/go-template/return
|
||||
Reference in new issue
Block a user