Tab
You can use a tab
shortcode to display a single tab.
This is especially useful if you want to flag your code example with an explicit language.
If you want multiple tabs grouped together you can wrap your tabs into the tabs
shortcode.
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.
{{% tab title="c" %}}
```c
printf("Hello World!");
```
{{% /tab %}}
{{ partial "shortcodes/tab.html" (dict
"context" .
"title" "c"
"content" ("```c\nprintf(\"Hello World!\")\n```" | .RenderString)
)}}
Parameter
Name | Default | Notes |
---|---|---|
style | default |
The style scheme used for the tab. - by severity: info , note , tip , warning - by brand color: primary , secondary , accent - by color: blue , green , grey , orange , red - by special color: default , transparent |
color | see notes | The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default. - for severity styles: a nice matching color for the severity - for all other styles: the corresponding color |
title | see notes | Arbitrary title for the tab. Depending on the style there may be a default title. Any given value will overwrite the default. - for severity styles: the matching title for the severity - for all other styles: <empty> If you want no title for a severity style, you have to set this parameter to " " (a non empty string filled with spaces) |
icon | see notes | Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default. - for severity styles: a nice matching icon for the severity - for all other styles: <empty> If you want no icon for a severity style, you have to set this parameter to " " (a non empty string filled with spaces) |
<content> | <empty> | Arbitrary text to be displayed in the tab. |
Examples
Single Code Block with Collapsed Margins
printf("Hello World!");
Mixed Markdown Content
A tab can not only contain code but arbitrary text. In this case text and code will get a margin.
printf("Hello World!");
Understanding style
and color
Behavior
The style
parameter affects how the color
parameter is applied.
{{< tabs >}}
{{% tab title="just colored style" style="blue" %}}
The `style` parameter is set to a color style.
This will set the background to a lighter version of the chosen style color as configured in your theme variant.
{{% /tab %}}
{{% tab title="just color" color="blue" %}}
Only the `color` parameter is set.
This will set the background to a lighter version of the chosen CSS color value.
{{% /tab %}}
{{% tab title="default style and color" style="default" color="blue" %}}
The `style` parameter affects how the `color` parameter is applied.
The `default` style will set the background to your `--MAIN-BG-color` as configured for your theme variant resembling the default style but with different color.
{{% /tab %}}
{{% tab title="just severity style" style="info" %}}
The `style` parameter is set to a severity style.
This will set the background to a lighter version of the chosen style color as configured in your theme variant and also affects the chosen icon.
{{% /tab %}}
{{% tab title="severity style and color" style="info" color="blue" %}}
The `style` parameter affects how the `color` parameter is applied.
This will set the background to a lighter version of the chosen CSS color value and also affects the chosen icon.
{{% /tab %}}
{{< /tabs >}}
The style
parameter is set to a color style.
This will set the background to a lighter version of the chosen style color as configured in your theme variant.
Only the color
parameter is set.
This will set the background to a lighter version of the chosen CSS color value.
The style
parameter affects how the color
parameter is applied.
The default
style will set the background to your --MAIN-BG-color
as configured for your theme variant resembling the default style but with different color.
The style
parameter is set to a severity style.
This will set the background to a lighter version of the chosen style color as configured in your theme variant and also affects the chosen icon.
The style
parameter affects how the color
parameter is applied.
This will set the background to a lighter version of the chosen CSS color value and also affects the chosen icon.