跳转到内容

截图

Screenshot 组件可渲染主题感知图片,当用户切换网站主题时,该组件会自动在亮色和暗色变体之间切换。每当您需要展示与读者当前配色方案相匹配的 UI 截图时,请使用此组件。

属性类型是否必填描述
lightstring亮色模式图片的路径
darkstring暗色模式图片的路径
altstring用于无障碍访问的替代文本
widthnumber图片宽度(像素)
heightnumber图片高度(像素)

同时提供 lightdark 属性,以便为每种主题显示正确的变体。 切换右上角的主题选择器,即可看到图片发生切换。

Docs theme homepageDocs theme homepage
import Screenshot from '@f5-sales-demo/docs-theme/components/Screenshot.astro';
<Screenshot
light="/images/screenshot-example-light.png"
dark="/images/screenshot-example-dark.png"
alt="Docs theme homepage"
/>

当只有一种变体可用时,仅传入 lightdark 即可。 图片将在两种主题下均以该变体渲染,不会发生切换。

Docs theme homepage (dark only)
<Screenshot
dark="/images/screenshot-example-dark.png"
alt="Docs theme homepage (dark only)"
/>

使用 widthheight 控制渲染尺寸,以防止布局偏移。

Docs theme homepage at fixed widthDocs theme homepage at fixed width
<Screenshot
light="/images/screenshot-example-light.png"
dark="/images/screenshot-example-dark.png"
alt="Docs theme homepage at fixed width"
width={600}
height={338}
/>

该组件在 .screenshot-pair 容器内渲染一个或两个 <img> 元素。CSS 规则根据当前激活的主题切换图片的可见性:

  • 暗色模式(默认)——.screenshot-light 图片通过 :root:not([data-theme="light"]) .screenshot-light \{ display: none \} 隐藏
  • 亮色模式——.screenshot-dark 图片通过 :root[data-theme="light"] .screenshot-dark \{ display: none \} 隐藏

额外的选择器通过 :has() 处理 starlight-image-zoom 容器,以确保缩放功能在两种变体下均能正常工作。

所有截图图片均采用统一样式:细微的边框、圆角,以及悬停时加深的投影效果。

功能Screenshot 组件Markdown ![](url)
主题感知切换支持不支持
样式边框与阴影自动应用不支持
悬停阴影效果支持不支持
缩放支持与图片缩放插件兼容与图片缩放插件兼容
替代文本alt 属性![alt text]()

当您拥有特定主题的图片变体,或希望呈现样式化的截图外观时,请使用 Screenshot 组件。对于内联图形、示意图,或在两种主题下显示效果相同的图片,请使用标准 Markdown 图片语法。