How to pass multiple data to Go template?

by

You may only pass a single value, but that value may be a composed value of multiple values, e.g. a struct, map or slice. So simply wrap your multiple data intended for the template in a struct or in a map.

Example with a struct:

type Data struct {
    Results []User // Must be exported!
    Other   []int  // Must be exported!
}

data := &Data{results, []int{1, 2, 3}}
if err := GetTemplate("list").Execute(w, data); err != nil {
    // Handle error
}

Also note that a new, named type is not required, you could also use an anonymous struct literal, which could look like this:

data := struct {
    Results []User // Must be exported!
    Other   []int  // Must be exported!
}{results, []int{1, 2, 3}}

Example with a map:

m := map[string]interface{}{
    "Results": results,
    "Other":   []int{1, 2, 3},
}

if err := GetTemplate("list").Execute(w, m); err != nil {
    // Handle error
}

Note that using a map, it is not required to use capitalized strings as keys, e.g. you could’ve used "results" and "other" too (but in my opinion it’s better to use keys with capital starting letters, should you move to struct sometimes in the future, you would have less corrections to make).

In both cases you may refer to the []User results with {{.Results}} and to the additional int slice with {{.Other}}.

So for example to range over the users:

{{range .Results}}
    User name:{{.Name}}
{{end}}

Example with a slice:

s := []interface{}{
    results,
    []int{1, 2, 3},
}

if err := GetTemplate("list").Execute(w, s); err != nil {
    // Handle error
}

This is less readable, but a viable solution. In the template you have to index the template data to get the “individual” values, e.g.:

{{range index . 0}}
    User name:{{.Name}}
{{end}}

Other: {{index . 1}}

Try it on the Go Playground.

Other ways…

There are other “theoretical” ways too, but I wouldn’t use them just because it works.

For example, you could also pass in a channel from which receives would provide the values.

Yet another solution could be to register custom functions which when called would return the values.

More Related Contents:

  1. Go template.ExecuteTemplate include html
  2. Access a map value using a variable key in a Go template
  3. In a Go template range loop, are variables declared outside the loop reset on each iteration?
  4. Go template name
  5. Is it possible to have nested templates in Go using the standard library?
  6. Capture or assign golang template output to variable
  7. Create a generic channel
  8. How to pipe several commands in Go?
  9. How to use a module that is outside of “GOPATH” in another module?
  10. How can I convert string to integer in golang
  11. How to dump goroutine stacktraces?
  12. Accessing struct fields inside a map value (without copying)
  13. Why do I get a “cannot assign” error when setting value to a struct as a value in a map? [duplicate]
  14. Can I concurrently write different slice elements
  15. Organize local code in packages using Go modules
  16. How to compare if two structs, slices or maps are equal?
  17. Golang defer behavior
  18. Stack vs heap allocation of structs in Go, and how they relate to garbage collection
  19. What is the meaning of “dot parenthesis” syntax? [duplicate]
  20. Can I construct a slice of a generic type with different type parameters?
  21. How to import local packages in go?
  22. How to compare Go errors
  23. How to delete an element from a Slice in Golang
  24. Does the Go language have function/method overloading?
  25. Go: panic: runtime error: invalid memory address or nil pointer dereference
  26. How to write a generic function that accepts any numerical type?
  27. How do you serve a static html file using a go web server?
  28. Meaning of a struct with embedded anonymous interface?
  29. Does Go have lambda expressions or anything similar?
  30. Registering packages in Go without cyclic dependency

Leave a Comment