hugo-theme-relearn/exampleSite/content/shortcodes/expand.en.md
2022-06-23 00:03:24 +02:00

2.5 KiB

+++ description = "Expandable/collapsible sections of text" title = "Expand" +++

The expand shortcode displays an expandable/collapsible section of text.

{{% expand title="Expand me..." %}}Thank you!{{% /expand %}}

Usage

While the examples are using shortcodes with named parameter you are free to use positional aswell or also call this shortcode from your own partials.

{{< tabs groupId="shortcode-parameter">}} {{% tab name="shortcode" %}}

{{%/* expand title="Expand me..." */%}}Thank you!{{%/* /expand */%}}

{{% /tab %}} {{% tab name="shortcode (positional)" %}}

{{%/* expand "Expand me..." */%}}Thank you!{{%/* /expand */%}}

{{% /tab %}} {{% tab name="partial" %}}

{{ partial "shortcodes/expand.html" (dict
  "context" .
  "title" "Expand me..."
  "content" "Thank you!"
)}}

{{% /tab %}} {{< /tabs >}}

Parameter

Name Position Default Notes
title 1 "Expand me..." Arbitray text to appear next to the expand/collapse icon.
open 2 false When true the content text will be initially shown as expanded.
<content> <empty> Arbitray text to be displayed on expand.

Examples

All Defaults

{{%/* expand */%}}Yes, you did it!{{%/* /expand */%}}

{{% expand %}}Yes, you did it!{{% /expand %}}

Initially Expanded

{{%/* expand title="Expand me..." open="true" */%}}No need to press you!{{%/* /expand */%}}

{{% expand title="Expand me..." open="true" %}}No need to press you!{{% /expand %}}

Arbitrary Text

{{%/* expand title="Show me almost endless possibilities" */%}}
You can add standard markdown syntax:

- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** and even **_bold emphasized_** text
- [links](https://example.com)
- etc.

```plaintext
...and even source code
```

> the possiblities are endless (almost - including other shortcodes may or may not work)
{{%/* /expand */%}}

{{% expand title="Show me almost endless possibilities" %}} You can add standard markdown syntax:

  • multiple paragraphs
  • bullet point lists
  • emphasized, bold and even bold emphasized text
  • links
  • etc.
...and even source code

the possiblities are endless (almost - including other shortcodes may or may not work) {{% /expand %}}