Jamdesk Documentation logo

Frame

Frame racchiude immagini e demo in un contenitore con bordo e didascalie opzionali, per dare ai tuoi contenuti visivi un aspetto coerente e curato.

Frame racchiude immagini e demo in un contenitore con bordo e didascalie opzionali.

Usa Frame quando vuoi:

  • Dare un aspetto finito a screenshot e immagini dell'interfaccia
  • Aggiungere didascalie per spiegare cosa stanno vedendo i lettori
  • Distinguere l'output delle demo dal contenuto normale
  • Mantenere coerenti gli elementi visivi in tutta la documentazione

Gli screenshot mostrano l'interfaccia in inglese.

Utilizzo

<Frame caption="Architecture diagram">

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

</Frame>

Frame di base

City skyline

<Frame>

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

</Frame>

Con didascalia

Aggiungi una didascalia sotto il frame:

City skyline

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

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

</Frame>

Riquadrare altri contenuti

Frame accetta qualsiasi contenuto, non solo immagini:

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

Quando NON usare Frame

  • Immagini decorative inline: le normali immagini Markdown vanno bene per le illustrazioni
  • Icone o grafiche piccole: Frame aggiunge peso visivo non necessario
  • Immagini che scorrono insieme al testo: Frame crea una pausa visiva. Usalo per elementi visivi autonomi

Buone pratiche

  • Mantieni le didascalie concise: una frase che spiega cosa sta vedendo il lettore
  • Usalo in modo coerente: se incornici uno screenshot, incornicia tutti gli screenshot
  • Non abusarne: riserva i frame alle immagini importanti, non a ogni immagine della pagina

Proprietà

string

Testo opzionale sotto il frame.

Passaggi successivi

Panoramica dei componenti

Sfoglia tutti i componenti disponibili

Nozioni base MDX

Scopri come usare i componenti in MDX