Skip to content

Commit 7dc9976

Browse files
Add documentation for Frame component hint prop (#1842)
* Update components/frames.mdx * Update components/frames.mdx * Update components/frames.mdx * Update components/frames.mdx * Update components/frames.mdx * Update components/frames.mdx * copyedit --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <[email protected]>
1 parent 6779b51 commit 7dc9976

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

components/frames.mdx

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,28 @@ Use frames to display images, diagrams, or other visual content with consistent
1212

1313
## Captions
1414

15-
You can add additional context to an image using the optional `caption` prop.
15+
Add additional context to an image using the optional `caption` prop. Captions appear in the frame below the image.
1616

17-
<Frame caption="Yosemite National Park is visited by over 3.5 million people every year">
17+
<Frame caption="Yosemite National Park is visited by over 3.5 million people every year.">
1818
<img src="https://mintlify-assets.b-cdn.net/yosemite.jpg" alt="Photograph of Yosemite Valley." />
1919
</Frame>
2020

21+
## Hints
22+
23+
Add text that precedes the frame using the optional `hint` prop. Hints appear above the frame.
24+
25+
<Frame hint="If you plan to visit Yosemite National Park, secure your permits before you go." caption="Yosemite National Park is visited by over 3.5 million people every year.">
26+
<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." />
27+
</Frame>
28+
2129
## Properties
2230

2331
<ResponseField name="caption" type="string">
24-
Optional caption text to show centered under your component.
32+
Text that appears as part of the frame, centered below the content.
33+
</ResponseField>
34+
35+
<ResponseField name="hint" type="string">
36+
Text that precedes the frame.
2537
</ResponseField>
2638

2739
<CodeGroup>
@@ -37,4 +49,16 @@ You can add additional context to an image using the optional `caption` prop.
3749
<img src="/path/image.jpg" alt="Descriptive alt text" />
3850
</Frame>
3951
```
52+
53+
```mdx Frame with a hint
54+
<Frame hint="Hint text">
55+
<img src="/path/image.jpg" alt="Descriptive alt text" />
56+
</Frame>
57+
```
58+
59+
```mdx Frame with both hint and caption
60+
<Frame hint="Hint text" caption="Caption text">
61+
<img src="/path/image.jpg" alt="Descriptive alt text" />
62+
</Frame>
63+
```
4064
</CodeGroup>

0 commit comments

Comments
 (0)