Files
hugo/docs/content/en/functions/collections/First.md
T
Bjørn Erik Pedersen 30a20122b7 Merge commit '8f3c066d23f431fb2c53d97ea489e4c28b42bd82'
# Conflicts:
#	docs/data/docs.yaml
2026-02-14 12:14:33 +01:00

1.3 KiB

title, description, categories, keywords, params, aliases
title description categories keywords params aliases
collections.First Returns the first N elements of the given slice or string.
functions_and_methods
aliases returnType signatures
first
any
collections.First N SLICE|STRING
/functions/first
{{ slice "a" "b" "c" | first 1 }} → [a]
{{ slice "a" "b" "c" | first 2 }} → [a b]

Given that a string is in effect a read-only slice of bytes, this function can be used to return the specified number of bytes from the beginning of the string:

{{ "abc" | first 1 }} → a
{{ "abc" | first 2 }} → ab

Note that a character may consist of multiple bytes:

{{ "Schön" | first 3 }} → Sch
{{ "Schön" | first 4 }} → Sch\xc3
{{ "Schön" | first 5 }} → Schö

To use the collections.First function with a page collection:

{{ range first 5 .Pages }}
  {{ .Render "summary" }}
{{ end }}

Set N to zero to return an empty slice:

{{ $emptyPageCollection := first 0 .Pages }}

Use first and where together:

{{ range where .Pages "Section" "articles" | first 5 }}
  {{ .Render "summary" }}
{{ end }}