Skip to content

Commit 8eb26e7

Browse files
authored
Document Panel component (#696)
* Create Panel file * Add info on using `Panel` * Make less redundant * Add reviewer feedback * Update panel.mdx
1 parent f41b71b commit 8eb26e7

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

components/panel.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: 'Panel'
3+
description: 'Specify the content of the right side panel'
4+
icon: 'panel-right'
5+
---
6+
7+
You can use the `<Panel>` component to customize the right side panel of a page with any components that you want.
8+
9+
If a page has a `<Panel>` component, any [`<RequestExample>`](/components/examples#request-example) and [`<ResponseExample>`](/components/examples#response-example) components must be inside `<Panel>`.
10+
11+
The components in a `<Panel>` will replace a page's table of contents.
12+
13+
````md
14+
<Panel>
15+
<Info>Pin info to the side panel. Or add any other component.</Info>
16+
</Panel>
17+
````
18+
19+
<Panel>
20+
<Info>Pin info to the side panel. Or add any other component.</Info>
21+
</Panel>

docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@
5757
"components/frames",
5858
"components/icons",
5959
"components/mermaid-diagrams",
60+
"components/panel",
6061
"components/steps",
6162
"components/tabs",
6263
"components/tooltips",

0 commit comments

Comments
 (0)