Example#
Usage#
Use a figure for an image or a diagram with a caption. aspectRatio reserves its space before the image loads, so nothing shifts.
treatmentsays what the image is:prooffor a screenshot or a photo that must stay untouched (D-I1),printfor an image already treated by the photo pipeline or the print kit. A figure never filters a proof.- Caption and credit. The caption says what the image shows;
creditnames who made it. - Client sites go in a
ScreenshotFrame, which links out to the live site.
Anatomy#
- Media
data-mk-part="media" - Caption
data-mk-part="caption"
Volume#
Reading layer: identical at every volume. Proof images never change with the volume.
Quiet
Pebblepath's hero on a phoneMei Tanaka Studio
Pebblepath's hero on a phoneMei Tanaka Press
Pebblepath's hero on a phoneMei Tanaka Rave
Pebblepath's hero on a phoneMei Tanaka
Content#
- The caption adds what the image cannot say: where, when, what changed.
- Alt text on the image describes it for people who cannot see it; the caption is for everyone.
Do and don't#
Do
Don't
A client's screenshot run through the halftone filter to match the page.
Accessibility#
- Give the image its own alt text; the caption adds context, it does not replace it.
- Proof images are never filtered (D-I1).
Props#
| Prop | Type | Default | Description |
|---|---|---|---|
children required | ReactNode | none | The media. |
caption | ReactNode | none | |
credit | ReactNode | none | |
aspectRatio | string | none | e.g. "16 / 9": reserves the media's space. |
treatment | "print" | "proof" | proof | Default `proof` (untouched). |
Tokens#
System tokens (4)
Changelog#
Arrived in 0.1.0.
Sectionwith its plate andArtslot,Plate,VolumeScope,PageHero,SectionHead,Eyebrow,Card,LineCard,InfoPanel,Stack,Cluster,Grid,Container,Main,Ruleand theFittedLineclient fitter;Navbarwith theNavDisclosuremega panels,Footer,FooterMap,BuildStamp,SkipLink,ActionDockandVisitorControls; theTableparts,ComparisonTablewith the one-tier switcher,SpecStrip,Numeral,Stat,StatGroup,StatusChip,BadgeandScoreDial;ProsewithmdxComponents,Quote,CodeBlockwithCopyButton,Figure,ScreenshotFrameandPhoneFrame; and the brand: the three evolved 2 × 2 options inmarkGeometry(a Overprint by default, b Paper seam, c Key block) with the pixel-snappedpxmode and the one-ink seam variant,logoGeometrywith the 1x clear-space frame,Mark,Wordmark,Logo,MaxosMarkandLineBadge. Read the whole entry