summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/collections/First.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/collections/First.md')
-rw-r--r--docs/content/en/functions/collections/First.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/content/en/functions/collections/First.md b/docs/content/en/functions/collections/First.md
new file mode 100644
index 000000000..ddb045382
--- /dev/null
+++ b/docs/content/en/functions/collections/First.md
@@ -0,0 +1,53 @@
+---
+title: collections.First
+linkTitle: first
+description: Slices an array to the first N elements.
+categories: [functions]
+keywords: []
+menu:
+ docs:
+ parent: functions
+function:
+ aliases: [first]
+ returnType: any
+ signatures: [collections.First LIMIT COLLECTION]
+relatedFunctions:
+ - collections.After
+ - collections.First
+ - collections.Last
+aliases: [/functions/first]
+---
+
+`first` works in a similar manner to the [`limit` keyword in
+SQL][limitkeyword]. It reduces the array to only the `first N`
+elements. It takes the array and number of elements as input.
+
+`first` takes two arguments:
+1. `number of elements`
+2. `array` *or* `slice of maps or structs`
+
+{{< code file="layout/_default/section.html" >}}
+{{ range first 10 .Pages }}
+ {{ .Render "summary" }}
+{{ end }}
+{{< /code >}}
+
+*Note: Exclusive to `first`, LIMIT can be '0' to return an empty array.*
+
+## `first` and `where` Together
+
+Using `first` and [`where`] together can be very
+powerful. Below snippet gets a list of posts only from [main
+sections], sorts it by the `title` parameter, and then
+ranges through only the first 5 posts in that list:
+
+{{< code file="first-and-where-together.html" >}}
+{{ range first 5 (where site.RegularPages "Type" "in" site.Params.mainSections).ByTitle }}
+ {{ .Content }}
+{{ end }}
+{{< /code >}}
+
+
+[limitkeyword]: https://www.techonthenet.com/sql/select_limit.php
+[`where`]: /functions/collections/where
+[main sections]: /functions/collections/where#mainsections