Skip to content

Add dropdowns #520

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 3 commits into from
Feb 12, 2025
Merged

Add dropdowns #520

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1906ecf
Add dropdowns
hahnbeelee Feb 8, 2025
a8d3017
Merge branch 'main' into hb/add-dropdowns
hahnbeelee Feb 12, 2025
5fd52b5
add images
hahnbeelee Feb 12, 2025
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
11 changes: 6 additions & 5 deletions docs.json
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

Make it maple and we can use it

Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@
},
"favicon": "/favicon.svg",
"navigation": {
"tabs": [
"dropdowns": [
{
"tab": "Documentation",
"dropdown": "Documentation",
"icon": "book-open",
"groups": [
{
"group": "Getting Started",
Expand Down Expand Up @@ -165,7 +166,7 @@
]
},
{
"tab": "Components",
"dropdown": "Components",
"groups": [
{
"group": "Components",
Expand Down Expand Up @@ -198,7 +199,7 @@
]
},
{
"tab": "Integrations",
"dropdown": "Integrations",
"groups": [
{
"group": "Analytics",
Expand Down Expand Up @@ -244,7 +245,7 @@
]
},
{
"tab": "Changelog",
"dropdown": "Changelog",
"groups": [
{
"group": "Changelog",
Expand Down
59 changes: 48 additions & 11 deletions navigation/divisions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Tabs and Anchors
title: Tabs, Anchors, Dropdowns
---

## Tabs
Expand Down Expand Up @@ -42,46 +42,83 @@ documentation.

## Anchors

Anchors are another way to section your content.
Anchors are another way to section your content. They show up on top of your side navigation.

<Frame>
<img className="block dark:hidden rounded-md" src="/images/anchor-light.png" />

<img className="hidden dark:block rounded-md" src="/images/anchor-dark.png" />
</Frame>

The configuration is very similar to the tab configuration.
The configuration is very similar to the tab configuration. We highly recommend that you set an `icon` field as well.
The icon values are [fontawesome icons](https://fontawesome.com/search)

```json docs.json
"navigation": {
"anchors": [
{
"anchor": "Documentation",
"icon": "book-open",
"pages": [
"quickstart",
"development",
"navigation"
]
}
{
"anchor": "API References",
"icon": "sqaure-terminal",
"pages": [
"api-reference/get",
"api-reference/post",
"api-reference/delete"
]
},
}
{
"anchor": "SDKs",
"anchor": "Blog",
"href": "https://external-link.com/blog"
}
]
}
```

## Dropdowns

Dropdowns show up in the same place as anchors, but are consolidated into a single dropdown.
We also recommend that you set an icon for each dropdown item ([options](https://fontawesome.com/search)).
```json docs.json
"navigation": {
"dropdowns": [
{
"dropdown": "Documentation",
"icon": "book-open",
"pages": [
"sdk/fetch",
"sdk/create",
"sdk/delete",
"quickstart",
"development",
"navigation"
]
},
}
{
"anchor": "Blog",
"dropdown": "API References",
"icon": "sqaure-terminal",
"pages": [
"api-reference/get",
"api-reference/post",
"api-reference/delete"
]
}
{
"dropdown": "Blog",
"href": "https://external-link.com/blog"
}
]
}
```


## Nested Hierarchy

You can use both anchors and tabs together - either one can be nested within each other interchangeably.
You can use any combination of anchors, tabs, and dropdowns - either one can be nested within each other interchangeably.

<CodeGroup>

Expand Down