Jamdesk Documentation logo

Frame

Frame envolve imagens e demonstrações em um contêiner com borda e legendas opcionais, dando às suas imagens de documentação um visual consistente e refinado.

Frame envolve imagens e demonstrações em um contêiner com borda e legendas opcionais.

As capturas de tela mostram a interface em inglês.

Use Frame quando você quiser:

  • Dar um acabamento profissional a capturas de tela e imagens de interface
  • Adicionar legendas para explicar o que o leitor está vendo
  • Distinguir a saída de demonstrações do conteúdo regular
  • Manter os visuais consistentes em toda a documentação

Uso

<Frame caption="Architecture diagram">

  ![Diagram](/images/city-skyline.jpg)

</Frame>

Frame básico

City skyline

<Frame>

  ![City skyline](/images/city-skyline.webp)

</Frame>

Com legenda

Adicione uma legenda abaixo do frame:

City skyline

New York City at dusk
<Frame caption="New York City at dusk">

  ![City skyline](/images/city-skyline.webp)

</Frame>

Enquadrar outro conteúdo

Frame aceita qualquer conteúdo, não apenas imagens:

✓ Build completed successfully
✓ 42 pages generated
✓ Deployed to production
Example code output

Quando NÃO usar o Frame

  • Imagens decorativas inline: imagens Markdown comuns são adequadas para ilustrações
  • Ícones ou gráficos pequenos: Frame adiciona peso visual desnecessário
  • Imagens que fluem com o texto: Frame cria uma quebra visual. Use-o para visuais independentes

Práticas recomendadas

  • Mantenha as legendas concisas: uma frase que explique o que o leitor está vendo
  • Use de forma consistente: se você enquadra uma captura de tela, enquadre todas
  • Não exagere nos frames: reserve-os para visuais importantes, não para cada imagem da página

Props

string

Texto opcional abaixo do frame.

Próximos passos?

Visão geral de componentes

Explore todos os componentes disponíveis

Fundamentos de MDX

Aprenda a usar componentes em MDX