Skip to content

Commit d4d64ae

Browse files
authored
chore: add docs about about new field (#1062)
1 parent 56e6e3b commit d4d64ae

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

navigation.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -584,6 +584,34 @@ Style pages with breadcrumbs to display the full navigation path at the top of p
584584
}
585585
```
586586

587+
## Interaction Configuration
588+
589+
Control how users interact with navigation elements using the `interaction` property in your `docs.json`.
590+
591+
### Auto Navigation on Expand
592+
593+
Different themes have different default behavior when clicking on navigation groups. You can override this behavior using the `drilldown` option:
594+
595+
```json
596+
{
597+
"interaction": {
598+
"drilldown": true // Force navigation to first page when a user expands a dropdown
599+
}
600+
}
601+
```
602+
603+
```json
604+
{
605+
"interaction": {
606+
"drilldown": false // Never navigate, only expand/collapse
607+
}
608+
}
609+
```
610+
611+
- Set to `true` to force automatic navigation to the first page when clicking navigation groups
612+
- Set to `false` to prevent navigation and only expand or collapse the group
613+
- Leave unset to use the theme's default behavior
614+
587615
## FAQ
588616

589617
<Accordion title="What navigation folders should I avoid?">

settings.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -446,6 +446,16 @@ See [Themes](themes) for more information.
446446
</Expandable>
447447
</ResponseField>
448448

449+
<ResponseField name="interaction" type="object">
450+
User interaction settings for navigation elements.
451+
452+
<Expandable title="Interaction">
453+
<ResponseField name="drilldown" type="boolean">
454+
Control automatic navigation behavior when clicking on navigation groups. Set to `true` to force navigation to the first page when expanding groups, `false` to only expand/collapse without navigation, or leave unset to use the theme's default behavior.
455+
</ResponseField>
456+
</Expandable>
457+
</ResponseField>
458+
449459
<ResponseField name="footer" type="object">
450460
Footer content and social media links.
451461

0 commit comments

Comments
 (0)