进阶 sli.dev 2026-11-21 18:58:32 · 1 阅读
第16章 Slidev 内置组件指南
Components
本页列出了 Slidev 提供的所有内置组件。你可以直接在幻灯片中这些组件。注意 📖 主题 & 插件 可以提供额外组件。如需添加自定义组件,请参阅 📖 组件。
Arrow
绘制箭头。
用法
md
或者:
md
Props:
x1 (string | number, required): 起点 x 坐标
y1 (string | number, required): 起点 y 坐标
x2 (string | number, required): 终点 x 坐标
y2 (string | number, required): 终点 y 坐标
width (string | number, default: 2): 线宽
color (string, default: 'currentColor'): 线条颜色
two-way (boolean, default: false): 绘制双向箭头
VDragArrow
可拖拽的 Arrow 组件。
用法
✨ 可拖拽元素
除位置相关的 Prop 外,其余与 Arrow 组件相同。
AutoFitText
容器内部字体大小会根据内容自动适配,由 fitty 驱动。类似 PowerPoint 或 Keynote 中的文本框。
用法
md
Props:
max (number, default 100): 最大字号(像素)
min (number, default 30): 最小字号(像素)
modelValue (string, default ''): 文本内容(也可以使用默认 slot)
multiLine (boolean, default true): 当达到最小字号时允许文本换行
LightOrDark
根据当前激活的亮色或暗色主题显示不同内容。
用法
使用两个具名 Slot #dark 和 #light:
md
Dark mode is on
Light mode is on
传递给 LightOrDark 组件的 Props 可以通过 scoped slot 属性访问:
md
你可以传入 Markdown 内容,但需要用空行包裹内容:
md


Link
插入一个链接,用于导航到指定的幻灯片。
用法
md
Go to slide 42
Props:
to (string | number): 要导航到的幻灯片路径(幻灯片路径从 1 开始)
title (string): 显示的标题
如果存在对应的路由,可以使用字符串作为 to 参数,例如:
md
---
routeAlias: solutions
---
# Now some solutions!
PoweredBySlidev
渲染带有链接到 Slidev 网站的 "Powered by Slidev" 文本。
RenderWhen
根据上下文匹配情况渲染 slot(例如是否在演示者视图中)。
用法
md
This will only be rendered in presenter view.
Context 类型: 'main' | 'visible' | 'print' | 'slide' | 'overview' | 'presenter' | 'previewNext'
Props:
context (Context | Context[]): 要检查的上下文或上下文数组
'main': 在幻灯片和演示者视图中渲染(等效于 ['slide', 'presenter'])
'visible': 如果内容可见则渲染
'print': 在打印模式下渲染
'slide': 在幻灯片中渲染
'overview': 在概览中渲染
'presenter': 在演示者视图中渲染
'previewNext': 在演示者的下一张幻灯片视图中渲染
Slots:
#default: 当上下文匹配时渲染
#fallback: 当上下文不匹配时渲染
SlideCurrentNo
当前幻灯片编号。
用法
md
SlidesTotal
幻灯片总数。
用法
md
TitleRenderer
插入从解析为 HTML 的幻灯片中获取的主标题。标题和标题级别会自动从每张幻灯片的第一个标题元素中获取。
你可以通过使用 front matter 语法来覆盖某个幻灯片的这种行为:
yml
---
title: Amazing slide title
level: 2
---
用法
组件是一个虚拟组件,可以这样导入:
js
import TitleRenderer from '#slidev/title-renderer'
然后可以使用:
md
Props:
no (string | number): 要显示标题的幻灯片编号(幻灯片编号从 1 开始)
Toc
插入目录。
如果不想让某张幻灯片出现在 组件中,可以在幻灯片的 frontmatter 中使用 hideInToc 选项:
yml
---
hideInToc: true
---
标题使用 组件显示。
用法
md
Props:
columns (string | number, default: 1): 显示的列数
listClass (string | string[], default: ''): 应用于目录列表的类名
maxDepth (string | number, default: Infinity): 显示的最大标题深度级别
minDepth (string | number, default: 1): 显示的最小标题深度级别
mode ('all' | 'onlyCurrentTree'| 'onlySiblings', default: 'all'):
'all': 显示所有项目
'onlyCurrentTree': 仅显示当前树中的项目(活动项、活动项的父级和子级)
'onlySiblings': 仅显示当前树中的项目及其直接同级
Transform
对元素应用缩放或变换。
用法
md
Props:
scale (number | string, default 1): 变换缩放值
origin (string, default 'top left'): 变换原点值
Tweet
嵌入推文。
用法
md
Props:
id (number | string): 推文 ID
url (string): x.com 或 twitter.com 帖子的完整 URL
scale (number | string, default 1): 变换缩放值
conversation (string, default 'none'): 推文嵌入参数
cards ('hidden' | 'visible', default 'visible'): 推文嵌入参数
提供 id 或 url。如果两者都存在,id 优先。
BlueSky
嵌入 Bluesky 帖子。
用法
md
Props:
uri (string, required): Bluesky 帖子的 AT-URI,或 https://bsky.app/profile/.../post/... URL
scale (number | string, default 1): 变换缩放值
VAfter, VClick and VClicks
📖 动画
VSwitch
根据点击切换多个 slot。
📖 动画
如果 unmount prop 设置为 true,切换到下一个 slot 时,前一个 slot 将被卸载。默认为 false。
使用 tag 和 childTag props 更改组件及其子元素的默认标签。默认为 div。
使用 transition prop 更改过渡效果。默认为 false(禁用)。
VDrag
✨ 可拖拽元素
SlidevVideo
嵌入视频。
用法
md
关于此组件插槽中可以包含的内容,请查看 HTML video 元素的文档。
Props:
controls (boolean, 默认: false): 显示视频控制条
autoplay (boolean | 'once', 默认: false):
true 或 'once': 视频只自动播放一次,结束后或暂停后不再重新播放
false: 从不自动播放视频(改用 controls)
autoreset ('slide' | 'click', 默认: undefined):
'slide': 回退到上一张幻灯片时,视频回到开头
'click': 回退到该组件的上一次点击时,视频回到开头
poster (string | undefined, 默认: undefined): 视频未播放时显示的图片地址
printPoster (string | undefined, 默认: undefined): 打印时替代 poster 的图片地址
timestamp (string | number, 默认: 0): 视频起始时间(秒)
printTimestamp (string | number | 'last' | undefined, 默认: undefined): 打印时替代 timestamp 的值
WARNING
导出时视频可能加载失败,因为 Chromium 不支持某些视频格式。这种情况下,你可以指定浏览器的可执行文件路径,详情参见 Chromium executable path。
Youtube
嵌入 YouTube 视频。
Usage
md
Props:
id (string, 必填): YouTube 视频 id
width (number): 视频宽度
height (number): 视频高度
在 id 值后加上 ?start=1234(1234 为秒数),即可让视频从指定时间开始播放。
Your browser does not support videos. You may download it here.