Skip to content

chore: add docs about about new field #1062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 30, 2025
Merged

chore: add docs about about new field #1062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions navigation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,6 +584,34 @@ Style pages with breadcrumbs to display the full navigation path at the top of p
}
```

## Interaction Configuration

Control how users interact with navigation elements using the `interaction` property in your `docs.json`.

### Auto Navigation on Expand

Different themes have different default behavior when clicking on navigation groups. You can override this behavior using the `drilldown` option:

```json
{
"interaction": {
"drilldown": true // Force navigation to first page when a user expands a dropdown
}
}
```

```json
{
"interaction": {
"drilldown": false // Never navigate, only expand/collapse
}
}
```
Comment on lines +595 to +609
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should also add this property in /settings page

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. I can move it there.


- Set to `true` to force automatic navigation to the first page when clicking navigation groups
- Set to `false` to prevent navigation and only expand or collapse the group
- Leave unset to use the theme's default behavior

## FAQ

<Accordion title="What navigation folders should I avoid?">
Expand Down
10 changes: 10 additions & 0 deletions settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

To get started, you only need to specify `theme`, `name`, `colors.primary`, and `navigation`. Other fields are optional and you can add them as your documentation needs grow.

For the best editing experience, include the schema reference at the top of your `docs.json` file. This enables autocomplete, validation, and helpful tooltips in most code editors:

Check warning on line 18 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L18 

Did you really mean 'tooltips'?

```json
{
Expand Down Expand Up @@ -446,6 +446,16 @@
</Expandable>
</ResponseField>

<ResponseField name="interaction" type="object">
User interaction settings for navigation elements.

<Expandable title="Interaction">
<ResponseField name="drilldown" type="boolean">
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.
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField name="footer" type="object">
Footer content and social media links.

Expand Down