1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
---
title: partials.Include
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/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
layouts/
└── partials/
├── average.html
├── breadcrumbs.html
└── footer.html
```
The "average" partial returns the average of one or more numbers. We pass the numbers in context:
```go-html-template
{{ $numbers := slice 1 6 7 42 }}
{{ $average := partial "average.html" $numbers }}
```
The "breadcrumbs" partial renders [breadcrumb navigation], and needs to receive the current page in context:
```go-html-template
{{ partial "breadcrumbs.html" . }}
```
The "footer" partial renders the site footer. In this contrived example, the footer does not need access to the current page, so we can omit context:
```go-html-template
{{ partial "footer.html" }}
```
You can pass anything in context: a page, a page collection, a scalar value, a slice, or a map. In this example we pass the current page and three scalar values:
```go-html-template
{{ $ctx := dict
"page" .
"name" "John Doe"
"major" "Finance"
"gpa" 4.0
}}
{{ partial "render-student-info.html" $ctx }}
```
Then, within the partial template:
```go-html-template
<p>{{ .name }} is majoring in {{ .major }}.</p>
<p>Their grade point average is {{ .gpa }}.</p>
<p>See <a href="{{ .page.RelPermalink }}">details.</a></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 := "" }}
{{ 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/
|
