Hugo/themes/hextra/docs/content/docs/guide/shortcodes/tabs.md

title, next

title	next
Tabs	/docs/guide/term

Example

{{< tabs >}} {{< tab name="JSON" >}}JSON: JavaScript Object Notation (JSON) is a standard text-based format for representing structured data based on JavaScript object syntax.{{< /tab >}} {{< tab name="YAML" >}}YAML: YAML is a human-readable data serialization language.{{< /tab >}} {{< tab name="TOML" >}}TOML: TOML aims to be a minimal configuration file format that's easy to read due to obvious semantics.{{< /tab >}} {{< /tabs >}}

Usage

Default

{{</* tabs */>}}

  {{</* tab name="JSON" */>}}**JSON**: JavaScript Object Notation (JSON) is a standard text-based format for representing structured data based on JavaScript object syntax.{{</* /tab */>}}
  {{</* tab name="YAML" */>}}**YAML**: YAML is a human-readable data serialization language.{{</* /tab */>}}
  {{</* tab name="TOML" */>}}**TOML**: TOML aims to be a minimal configuration file format that's easy to read due to obvious semantics.{{</* /tab */>}}

{{</* /tabs */>}}

Specify Selected Tab

Use selected property to specify the selected tab.

{{</* tabs */>}}

  {{</* tab name="JSON" */>}}**JSON**: JavaScript Object Notation (JSON) is a standard text-based format for representing structured data based on JavaScript object syntax.{{</* /tab */>}}
  {{</* tab name="YAML" selected=true */>}}**YAML**: YAML is a human-readable data serialization language.{{</* /tab */>}}
  {{</* tab name="TOML" */>}}**TOML**: TOML aims to be a minimal configuration file format that's easy to read due to obvious semantics.{{</* /tab */>}}

{{</* /tabs */>}}

The YAML tab will be selected by default.

{{< tabs >}} {{< tab name="JSON" >}}JSON: JavaScript Object Notation (JSON) is a standard text-based format for representing structured data based on JavaScript object syntax.{{< /tab >}} {{< tab name="YAML" selected=true >}}YAML: YAML is a human-readable data serialization language.{{< /tab >}} {{< tab name="TOML" >}}TOML: TOML aims to be a minimal configuration file format that's easy to read due to obvious semantics.{{< /tab >}} {{< /tabs >}}

Add Icons

Use the icon property on each tab to display an icon before the label. See the Icon shortcode page for the list of available icons.

{{</* tabs */>}}

  {{</* tab name="Photos" icon="photograph" */>}}Manage and organize your photo library.{{</* /tab */>}}
  {{</* tab name="Music" icon="music-note" */>}}Browse and play your favorite tracks.{{</* /tab */>}}
  {{</* tab name="Videos" icon="film" */>}}Watch and stream video content.{{</* /tab */>}}

{{</* /tabs */>}}

{{< tabs >}} {{< tab name="Photos" icon="photograph" >}}Manage and organize your photo library.{{< /tab >}} {{< tab name="Music" icon="music-note" >}}Browse and play your favorite tracks.{{< /tab >}} {{< tab name="Videos" icon="film" >}}Watch and stream video content.{{< /tab >}} {{< /tabs >}}

Use Markdown

Markdown syntax including code block is also supported:

{{</* tabs */>}}

  {{</* tab name="JSON" */>}}
  ```json
  { "hello": "world" }
  ```
  {{</* /tab */>}}

  ... add other tabs similarly

{{</* /tabs */>}}

{{< tabs >}}

{{< tab name="JSON" >}}

{ "hello": "world" }

{{< /tab >}}

{{< tab name="YAML" >}}

hello: world

{{< /tab >}}

{{< tab name="TOML" >}}

hello = "world"

{{< /tab >}}

{{< /tabs >}}

Sync Tabs

Tabs with the same list of items can be synchronized. When enabled, selecting a tab updates all other tabs with the same items and remembers the selection across pages.

Enable/disable globally in your hugo.yaml under the page section:

params:
  page:
    tabs:
      sync: true

Enable/disable per page inside the front matter:

---
title: My page
params:
  tabs:
    sync: true
---

Example content.

With this enabled, the following two tab blocks will always display the same selected item:

{{</* tabs */>}}

  {{</* tab name="A" */>}}A content{{</* /tab */>}}
  {{</* tab name="B" */>}}B content{{</* /tab */>}}

{{</* /tabs */>}}

{{</* tabs */>}}

  {{</* tab name="A" */>}}Second A content{{</* /tab */>}}
  {{</* tab name="B" */>}}Second B content{{</* /tab */>}}

{{</* /tabs */>}}