hugo/content/en/methods/shortcode/Params.md
Bjørn Erik Pedersen 9b0050e9aa Squashed 'docs/' content from commit 5c085a37b
git-subtree-dir: docs
git-subtree-split: 5c085a37b297bf12f59efeaae591418ec025c10d
2024-01-27 10:48:33 +01:00

866 B

title description categories keywords action
Params Returns a collection of the shortcode parameters.
related returnType signatures
methods/shortcode/Get
any
SHORTCODE.Params

When you call a shortcode using positional parameters, 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 parameters, 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 >}}