File: Params.md

package info (click to toggle)
hugo 0.131.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 45,580 kB
  • sloc: javascript: 31,172; xml: 248; makefile: 73; sh: 42
file content (33 lines) | stat: -rw-r--r-- 863 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
---
title: Params
description: Returns a collection of the shortcode arguments.
categories: []
keywords: []
action:
  related:
    - methods/shortcode/Get
  returnType: any
  signatures: [SHORTCODE.Params]
---

When you call a shortcode using positional arguments, the `Params` method returns a slice.

{{< code file=content/about.md lang=md >}}
{{</* myshortcode "Hello" "world" */>}}
{{< /code >}}

{{< code file=layouts/shortcodes/myshortcode.html  >}}
{{ index .Params 0 }} → Hello
{{ index .Params 1 }} → world
{{< /code >}}

When you call a shortcode using named arguments, the `Params` method returns a map.

{{< code file=content/about.md lang=md >}}
{{</* myshortcode greeting="Hello" name="world" */>}}
{{< /code >}}

{{< code file=layouts/shortcodes/myshortcode.html  >}}
{{ .Params.greeting }} → Hello
{{ .Params.name }} → world
{{< /code >}}