diff --git a/content/en/functions/keyvals.md b/content/en/functions/keyvals.md new file mode 100644 index 000000000..1fc2f1f5e --- /dev/null +++ b/content/en/functions/keyvals.md @@ -0,0 +1,44 @@ +--- +title: keyVals +description: Returns a KeyVals struct. +categories: [functions] +menu: + docs: + parent: functions +keywords: [] +namespace: collections +relatedFuncs: [] +signature: + - collections.KeyVals KEY VALUES... + - keyVals KEY VALUES... + +--- + +The primary application for this function is the definition of the `namedSlices` parameter in the options map passed to the `.Related` method on the `Page` object. + +See [related content](/content-management/related). + +```go-html-template +{{ $kv := keyVals "foo" "a" "b" "c" }} +``` + +The resulting data structure is: + +```json +{ + "Key": "foo", + "Values": [ + "a", + "b", + "c" + ] +} +``` + +To extract the key and values: + +```go-html-template + +{{ $kv.Key }} → foo +{{ $kv.Values }} → [a b c] +```