Jamdesk Documentation logo

Painel

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

O Painel exibe conteúdo personalizado na barra lateral direita, no lugar do Sumário. O conteúdo permanece visível enquanto o leitor rola a página. Use-o para referências rápidas, avisos importantes ou links de suporte.

Use o Painel quando:

  • Informações críticas não devem sair da tela durante a rolagem
  • 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)

Esta nota é exibida no painel da barra lateral!

Role a página para baixo e veja que o painel permanece visível.

Uso básico

Envolva o conteúdo em um Painel para exibi-lo na barra lateral direita:

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

Casos de uso comuns

Um Painel pode conter 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 Sumário ajuda o leitor a navegar. Substitua-o apenas por algo mais valioso
  • Documentação padrão: a maioria das páginas funciona melhor com o Sumário padrão
  • Dispositivos móveis: o conteúdo do Painel fica oculto em telas menores. Coloque as informações críticas também no conteúdo principal

Comportamento

  • Aparece na barra lateral direita em computadores (1280px ou mais) e fica oculto em telas menores
  • Um Painel por página. Ele substitui o Sumário
  • Aceita qualquer componente: Callouts, Cards, CodeGroup, Accordions, etc.

O que vem a seguir?

Visão geral dos componentes

Conheça todos os componentes disponíveis

Fundamentos de MDX

Aprenda a usar componentes em MDX