--- 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 "breadcrumbs.html" }} ``` You can pass anything in context: a page, a page collection, a scalar value, a slice, or a map. For example: ```go-html-template {{ $student := dict "name" "John Doe" "major" "Finance" "gpa" 4.0 }} {{ partial "render-student-info.html" $student }} ``` Then, within the partial template: ```go-html-template
{{ .name }} is majoring in {{ .major }}. Their grade point average is {{ .gpa }}.
``` 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