mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
b9363c3d04
* Update components/columns.mdx * Update components/frames.mdx * Update components/mermaid-diagrams.mdx * Update components/tooltips.mdx * copy edit columns * Replace lorem ipsum with example text * update frames page * Update mermaid-diagrams.mdx * copy edit tooltips * update tooltips --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
41 lines
1.1 KiB
Plaintext
41 lines
1.1 KiB
Plaintext
---
|
|
title: "Frames"
|
|
description: "Wrap images or other components in a container"
|
|
icon: "frame"
|
|
---
|
|
|
|
Use frames to display images, diagrams, or other visual content with consistent styling and optional captions. Frames center content and provide visual separation from surrounding text.
|
|
|
|
<Frame>
|
|
<img src="https://mintlify-assets.b-cdn.net/yellowstone.jpeg" alt="Photograph of a lake surrounded by trees with mountains in the distance in Yellowstone National Park." />
|
|
</Frame>
|
|
|
|
## Captions
|
|
|
|
You can add additional context to an image using the optional `caption` prop.
|
|
|
|
<Frame caption="Yosemite National Park is visited by over 3.5 million people every year">
|
|
<img src="https://mintlify-assets.b-cdn.net/yosemite.jpg" alt="Photograph of Yosemite Valley." />
|
|
</Frame>
|
|
|
|
## Properties
|
|
|
|
<ResponseField name="caption" type="string">
|
|
Optional caption text to show centered under your component.
|
|
</ResponseField>
|
|
|
|
<CodeGroup>
|
|
|
|
```mdx Frame
|
|
<Frame>
|
|
<img src="/path/image.jpg" alt="Descriptive alt text" />
|
|
</Frame>
|
|
```
|
|
|
|
```mdx Frame with a caption
|
|
<Frame caption="Caption text">
|
|
<img src="/path/image.jpg" alt="Descriptive alt text" />
|
|
</Frame>
|
|
```
|
|
</CodeGroup>
|