Jamdesk Documentation logo

面板

使用面板将警告或快速参考等自定义内容固定在侧边栏中,读者滚动页面时内容始终可见。

面板在右侧边栏中显示自定义内容,取代目录。读者滚动页面时,内容始终保持可见。可用于快速参考、重要警告或支持链接。

在以下情况使用面板:

  • 关键信息不应滚动出视野
  • 快速参考材料需要对主要内容起补充作用
  • 持续性行动号召需要保持可见(如支持链接、API 密钥)

此提示显示在侧边栏面板中!

向下滚动,查看面板保持可见。

基本用法

将内容包裹在面板中,即可在右侧边栏中显示:

<Panel>
  <Info>This content appears in the sidebar!</Info>
</Panel>

常见使用场景

面板可以容纳固定的警告、快速参考卡片和支持链接:

<Panel>
  <Warning>

    API rate limits: 100 requests/minute

</Warning>
  <Card title="Quick Reference" icon="list">

    **Methods:** GET, POST, PUT, DELETE
    **Auth:** Bearer token required

</Card>
  <Card title="Need Help?" icon="circle-question" href="https://example.com/support">

    Contact our support team

</Card>
</Panel>

不应使用 Panel 的情况

  • 短页面:目录有助于读者导航。只有在有更有价值的内容时才替换它
  • 标准文档:大多数页面使用默认目录效果更好
  • 移动端:面板内容在较小屏幕上会隐藏。请同时将关键信息放在主要内容中

行为

  • 在桌面端(1280px 及以上)显示在右侧边栏中,在较小屏幕上隐藏
  • 每个页面只能有一个面板,它会取代目录
  • 可容纳任意组件:Callout、Card、CodeGroup、Accordion 等

接下来?

组件概览

浏览所有可用组件

MDX 基础

了解如何在 MDX 中使用组件