Skip to content

Document Panel component #696

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 5 commits into from
May 12, 2025
Merged

Document Panel component #696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
166d456
Create Panel file
ethanpalm May 12, 2025
ea754ff
Add info on using `Panel`
ethanpalm May 12, 2025
ca06361
Make less redundant
ethanpalm May 12, 2025
fd23c07
Add reviewer feedback
ethanpalm May 12, 2025
96da139
Update panel.mdx
ethanpalm May 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
21 changes: 21 additions & 0 deletions components/panel.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: 'Panel'
description: 'Specify the content of the right side panel'
icon: 'panel-right'
---

You can use the `<Panel>` component to customize the right side panel of a page with any components that you want.

If a page has a `<Panel>` component, any [`<RequestExample>`](/components/examples#request-example) and [`<ResponseExample>`](/components/examples#response-example) components must be inside `<Panel>`.

The components in a `<Panel>` will replace a page's table of contents.

````md
<Panel>
<Info>Pin info to the side panel. Or add any other component.</Info>
</Panel>
````

<Panel>
<Info>Pin info to the side panel. Or add any other component.</Info>
</Panel>
1 change: 1 addition & 0 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
"components/frames",
"components/icons",
"components/mermaid-diagrams",
"components/panel",
"components/steps",
"components/tabs",
"components/tooltips",
Expand Down