Jamdesk Documentation logo

Painel

Use o Panel para fixar conteúdo personalizado, como avisos ou referências rápidas, na barra lateral, mantendo-o visível durante a rolagem.

O Panel permite exibir conteúdo personalizado na barra lateral direita em vez do Table of Contents padrão. O conteúdo permanece visível enquanto os leitores percorrem a página. Use-o para informações que devem estar sempre à vista: referências rápidas, avisos importantes ou links de suporte.

Use o Panel quando:

  • Informações críticas não devem sair da área visível
  • O material de referência rápida complementa o conteúdo principal
  • Chamadas para ação persistentes precisam permanecer visíveis (links de suporte, chaves de API)

This note is displayed in the sidebar panel!

Scroll down to see the panel stays visible.

Uso básico

Envolva qualquer conteúdo em um Panel para exibi-lo na barra lateral direita:

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

Casos de uso comuns

Os Panels são úteis para avisos fixados, cartões de referência rápida e links de suporte:

<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>

Quando NÃO usar o Panel

  • Páginas curtas — o Table of Contents ajuda os usuários a navegar; substitua-o apenas quando você tiver conteúdo mais valioso
  • Documentação padrão — a maioria das páginas funciona melhor com o ToC padrão
  • Usuários em dispositivos móveis — o conteúdo do Panel fica oculto em telas menores; portanto, certifique-se de que as informações críticas também estejam no conteúdo principal

Comportamento

  • Aparece na barra lateral direita em computadores (1280px+), oculto em telas menores
  • Um Panel por página; substitui completamente o Table of Contents
  • É compatível com qualquer componente: Callouts, Cards, CodeGroup, Accordions etc.

O que vem a seguir?

Visão geral dos componentes

Browse all available components

Noções básicas de MDX

Learn how to use components in MDX