hugo/docs/content/en/methods/shortcode/Parent.md
2024-06-21 09:41:24 +02:00

1.3 KiB

title description categories keywords action
Parent Returns the parent shortcode context in nested shortcodes.
related returnType signatures
hugolib.ShortcodeWithPage
SHORTCODE.Parent

This is useful for inheritance of common shortcode arguments from the root.

In this contrived example, the "greeting" shortcode is the parent, and the "now" shortcode is child.

{{< code file=content/welcome.md lang=md >}} {{</* greeting dateFormat="Jan 2, 2006" />}} Welcome. Today is {{</ now />}}. {{</ /greeting */>}} {{< /code >}}

{{< code file=layouts/shortcodes/greeting.html >}}

{{ trim .Inner "\r\n" | .Page.RenderString }}
{{< /code >}}

{{< code file=layouts/shortcodes/now.html >}} {{- $dateFormat := "January 2, 2006 15:04:05" }}

{{- with .Params }} {{- with .dateFormat }} {{- $dateFormat = . }} {{- end }} {{- else }} {{- with .Parent.Params }} {{- with .dateFormat }} {{- $dateFormat = . }} {{- end }} {{- end }} {{- end }}

{{- now | time.Format $dateFormat -}} {{< /code >}}

The "now" shortcode formats the current time using:

  1. The dateFormat argument passed to the "now" shortcode, if present
  2. The dateFormat argument passed to the "greeting" shortcode, if present
  3. The default layout string defined at the top of the shortcode