---
title: Frame
description: >-
  O Frame envolve imagens e demonstrações em um contêiner com borda e legendas opcionais, mantendo a consistência visual da documentação.
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

O 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 o Frame quando quiser:
- Dar às capturas de tela e imagens da interface um acabamento profissional
- Adicionar legendas para explicar o que os leitores estão vendo
- Diferenciar a saída de demonstrações do conteúdo regular
- Criar consistência visual em toda a documentação

## Uso

```mdx
<Frame caption="Architecture diagram">
  ![Diagram](/images/city-skyline.jpg)
</Frame>
```

## Frame básico

<Frame>
  ![Panorama urbano](/images/city-skyline.webp)
</Frame>

```mdx
<Frame>
  ![City skyline](/images/city-skyline.webp)
</Frame>
```

## Com legenda

Adicione uma legenda abaixo do frame:

<Frame caption="Nova York ao anoitecer">
  ![Panorama urbano](/images/city-skyline.webp)
</Frame>

```mdx
<Frame caption="New York City at dusk">
  ![City skyline](/images/city-skyline.webp)
</Frame>
```

## Enquadrar outro conteúdo

O Frame funciona com qualquer conteúdo, não apenas imagens:

<Frame caption="Saída de código de exemplo">
```
✓ Build completed successfully
✓ 42 pages generated
✓ Deployed to production
```
</Frame>

## Quando NÃO usar o Frame

- **Imagens decorativas inline** — imagens Markdown comuns são suficientes para ilustrações
- **Ícones ou gráficos pequenos** — o Frame adiciona um peso visual desnecessário
- **Imagens que acompanham o texto** — o Frame cria uma separação visual; use-o para elementos 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ê enquadrar uma captura de tela, enquadre todas para manter a consistência visual
- **Não use frames em excesso** — reserve-os para elementos visuais importantes, não para todas as imagens da página

## Props

<ParamField name="caption" type="string">
  Texto opcional abaixo do frame.
</ParamField>

## Próximos passos?

<Columns cols={2}>
  <Card title="Visão geral dos componentes" icon="puzzle-piece" href="/pt/components/overview">
    Veja todos os componentes disponíveis
  </Card>
  <Card title="Noções básicas de MDX" icon="file-code" href="/pt/content/mdx-basics">
    Saiba como usar componentes em MDX
  </Card>
</Columns>