You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: components/frames.mdx
+27-3Lines changed: 27 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,16 +12,28 @@ Use frames to display images, diagrams, or other visual content with consistent
12
12
13
13
## Captions
14
14
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.
16
16
17
-
<Framecaption="Yosemite National Park is visited by over 3.5 million people every year">
17
+
<Framecaption="Yosemite National Park is visited by over 3.5 million people every year.">
18
18
<imgsrc="https://mintlify-assets.b-cdn.net/yosemite.jpg"alt="Photograph of Yosemite Valley." />
19
19
</Frame>
20
20
21
+
## Hints
22
+
23
+
Add text that precedes the frame using the optional `hint` prop. Hints appear above the frame.
24
+
25
+
<Framehint="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
+
<imgsrc="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
+
21
29
## Properties
22
30
23
31
<ResponseFieldname="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
+
<ResponseFieldname="hint"type="string">
36
+
Text that precedes the frame.
25
37
</ResponseField>
26
38
27
39
<CodeGroup>
@@ -37,4 +49,16 @@ You can add additional context to an image using the optional `caption` prop.
37
49
<imgsrc="/path/image.jpg"alt="Descriptive alt text" />
38
50
</Frame>
39
51
```
52
+
53
+
```mdx Frame with a hint
54
+
<Framehint="Hint text">
55
+
<imgsrc="/path/image.jpg"alt="Descriptive alt text" />
56
+
</Frame>
57
+
```
58
+
59
+
```mdx Frame with both hint and caption
60
+
<Framehint="Hint text"caption="Caption text">
61
+
<imgsrc="/path/image.jpg"alt="Descriptive alt text" />
0 commit comments