Skip to content

Commit 28b853f

Browse files
Clarify layout requirement for tabs in navigation (#3522)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Devin Logan <devinannlogan@gmail.com>
1 parent ff1e646 commit 28b853f

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

  • fern/products/docs/pages/navigation

fern/products/docs/pages/navigation/tabs.mdx

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ Tabs let you group sections of your documentation together, while tab variants a
77

88
## Tabs
99

10-
Add `tabs` to group sections together. The example below shows tabs for `Help Center`, `API Reference`, and an external link to `Github`. Each tab has a `display-name` and `icon`.
10+
Add `tabs` to group sections together. The example below shows tabs for `Help Center`, `API Reference`, and an external link to `Github`. Each tab has a `display-name` and `icon`.
11+
12+
In the `navigation` section, each tab reference must include either a `layout` (for content) or `variants` (for [tab variants](#tab-variants)). Tabs with an `href` property are external links and must not include `layout` or `variants`.
1113

1214
<CodeBlock>
1315
{/* <!-- vale off --> */}
@@ -97,8 +99,16 @@ theme:
9799
Hide the tab from navigation
98100
</ParamField>
99101

102+
<ParamField path="layout" type="list">
103+
Navigation structure for the tab's content. Required unless the tab uses `variants` or `href`.
104+
</ParamField>
105+
106+
<ParamField path="variants" type="list">
107+
List of [tab variants](#tab-variants) for displaying different content perspectives. Use instead of `layout`.
108+
</ParamField>
109+
100110
<ParamField path="href" type="string">
101-
External URL. When set, clicking the tab redirects to this URL. Tabs with `href` must not have children in the navigation.
111+
External URL. When set, clicking the tab redirects to this URL. Tabs with `href` must not include `layout` or `variants`.
102112
</ParamField>
103113

104114
<ParamField path="target" type="string">

0 commit comments

Comments
 (0)