backy/tabs.en.md at a300f696d3f35aade3804f6c41058387cddf724b

* Getting environment variables and passwords from Vault (not tested
yet)
* Vault configuration to config (not tested yet)
* Ability to run scripts from file on local machine on the remote host
* Ability to get ouput in the notification of a list for individual
commands or all commands
* Make SSH connections close after all commands have been run; reuse
previous connections if needed

2023-07-01 21:46:54 -05:00

6.8 KiB

Raw Blame History

+++ description = "Show content in tabbed views" title = "Tabs" +++

The tabs shortcode displays arbitrary content in an unlimited number of tabs.

This comes in handy eg. for providing code snippets for multiple languages.

If you just want a single tab you can instead call the [tab shortcode]({{% relref "shortcodes/tab" %}}) standalone.

print("Hello World!")

echo "Hello World!"

printf("Hello World!");

Usage

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

See the [tab shortcode]({{% relref "shortcodes/tab" %}}) for a description of the parameter for nested tabs.

{{</* tabs title="hello." */>}}
{{%/* tab title="py" */%}}
```python
print("Hello World!")
```
{{%/* /tab */%}}
{{%/* tab title="sh" */%}}
```bash
echo "Hello World!"
```
{{%/* /tab */%}}
{{%/* tab title="c" */%}}
```c
printf"Hello World!");
```
{{%/* /tab */%}}
{{</* /tabs */>}}

{{ partial "shortcodes/tabs.html" (dict
  "context" .
  "title" "hello."
  "content" (slice
    (dict
      "title" "py"
      "content" ("```python\nprint(\"Hello World!\")\n```" | .RenderString)
    )
    (dict
      "title" "sh"
      "content" ("```bash\necho \"Hello World!\"\n```" | .RenderString)
    )
    (dict
      "title" "c"
      "content" ("```c\nprintf(\"Hello World!\");\n```" | .RenderString)
    )
  )
)}}

Parameter

Name	Default	Notes
groupid	<random>	Arbitrary name of the group the tab view belongs to. Tab views with the same groupid sychronize their selected tab. The tab selection is restored automatically based on the `groupid` for tab view. If the selected tab can not be found in a tab group the first tab is selected instead. This sychronization applies to the whole site!
style	<empty>	Sets a default value for every contained tab. Can be overridden by each tab. See the [`tab` shortcode]({{% relref "shortcodes/tab#parameter" %}}) for possible values.
color	<empty>	Sets a default value for every contained tab. Can be overridden by each tab. See the [`tab` shortcode]({{% relref "shortcodes/tab#parameter" %}}) for possible values.
title	<empty>	Arbitrary title written in front of the tab view.
icon	<empty>	[Font Awesome icon name]({{%relref "shortcodes/icon#finding-an-icon" %}}) set to the left of the title.
<content>	<empty>	Arbitrary number of tabs defined with the `tab` sub-shortcode.

Examples

Behavior of the `groupid`

See what happens to the tab views while you select different tabs.

While pressing a tab of Group A switches all tab views of Group A in sync (if the tab is available), the tabs of Group B are left untouched.

{{</* tabs groupid="a" */>}}
{{%/* tab title="json" */%}}
```json
{ "Hello": "World" }
```
{{%/* /tab */%}}
{{%/* tab title="_**XML**_ stuff" */%}}
```xml
<Hello>World</Hello>
```
{{%/* /tab */%}}
{{%/* tab title="text" */%}}
    Hello World
{{%/* /tab */%}}
{{</* /tabs */>}}

{{</* tabs groupid="a" */>}}
{{%/* tab title="json" */%}}
```json
{ "Hello": "World" }
```
{{%/* /tab */%}}
{{%/* tab title="XML stuff" */%}}
```xml
<Hello>World</Hello>
```
{{%/* /tab */%}}
{{</* /tabs */>}}

{{</* tabs groupid="b" */>}}
{{%/* tab title="json" */%}}
```json
{ "Hello": "World" }
```
{{%/* /tab */%}}
{{%/* tab title="XML stuff" */%}}
```xml
<Hello>World</Hello>
```
{{%/* /tab */%}}
{{</* /tabs */>}}

Group A, Tab View 1

{ "Hello": "World" }

<Hello>World</Hello>

Hello World

Group A, Tab View 2

{ "Hello": "World" }

<Hello>World</Hello>

Group B

{ "Hello": "World" }

<Hello>World</Hello>

Nested Tab Views and Color

In case you want to nest tab views, the parent tab that contains nested tab views needs to be declared with {{</* tab */>}} instead of {{%/* tab */%}}. Note, that in this case it is not possible to put markdown in the parent tab.

You can also set style and color parameter for all tabs and overwrite them on tab level. See the [tab shortcode]({{% relref "shortcodes/tab#parameter" %}}) for possible values.

{{</* tabs groupid="main" style="primary" title="Rationale" icon="thumbtack" */>}}
{{</* tab title="Text" */>}}
  Simple text is possible here...
  {{</* tabs groupid="tabs-example-language" */>}}
  {{%/* tab title="python" */%}}
  Python is **super** easy.

  - most of the time.
  - if you don't want to output unicode
  {{%/* /tab */%}}
  {{%/* tab title="bash" */%}}
  Bash is for **hackers**.
  {{%/* /tab */%}}
  {{</* /tabs */>}}
{{</* /tab */>}}

{{</* tab title="Code" style="default" color="darkorchid" */>}}
  ...but no markdown
  {{</* tabs groupid="tabs-example-language" */>}}
  {{%/* tab title="python" */%}}
  ```python
  print("Hello World!")
  ```
  {{%/* /tab */%}}
  {{%/* tab title="bash" */%}}
  ```bash
  echo "Hello World!"
  ```
  {{%/* /tab */%}}
  {{</* /tabs */>}}
{{</* /tab */>}}
{{</* /tabs */>}}

{{< tabs groupid="main" style="primary" title="Rationale" icon="thumbtack" >}} {{< tab title="Text" >}} Simple text is possible here... {{< tabs groupid="tabs-example-language" >}} {{% tab title="python" %}} Python is super easy.

most of the time.
if you don't want to output unicode {{% /tab %}} {{% tab title="bash" %}} Bash is for hackers. {{% /tab %}} {{< /tabs >}} {{< /tab >}}

{{< tab title="Code" style="default" color="darkorchid" >}} ...but no markdown {{< tabs groupid="tabs-example-language" >}} {{% tab title="python" %}}

print("Hello World!")

echo "Hello World!"

6.8 KiB Raw Blame History