跳到正文

斜杠命令 ​

斜杠命令提供一个快速插入菜单,在行首输入 / 时出现。

启用斜杠命令 ​

斜杠命令默认启用。如需显式控制:

vue
<template>
  <Tiptapify
    :slash-commands="true"
    placeholder="Type / to see available commands..."
  />
</template>

可用命令 ​

在编辑器中输入 / 即可查看命令面板。可用命令包括:

命令说明
/h1 - /h6插入标题(1-6 级)
/bulletList插入无序列表
/numberedList插入有序列表
/taskList插入任务列表
/code插入行内代码
/codeBlock插入代码块
/quote插入引用块
/image插入图片(打开 URL 对话框)
/video嵌入 YouTube 视频
/table插入表格
/link插入超链接
/divider插入水平分隔线
/emoji打开表情选择器
/specialChars打开特殊字符

工作原理 ​

  1. 将光标置于行首或空格之后
  2. 输入 /——命令面板随即出现
  3. 继续输入以筛选命令
  4. 按 Enter 或点击以插入所选命令

禁用斜杠命令 ​

vue
<template>
  <Tiptapify
    :slash-commands="false"
    placeholder="Slash commands disabled..."
  />
</template>

斜杠命令与浮动菜单 ​

将斜杠命令与浮动菜单结合使用,可获得最佳编辑体验:

vue
<template>
  <Tiptapify
    :slash-commands="true"
    :floating-menu="true"
    :bubble-menu="true"
    placeholder="Full command experience..."
  />
</template>
  • 斜杠命令(/)——在行首输入 / 时触发
  • 浮动菜单——光标位于空行时出现(提供块级操作)
  • 气泡菜单——选中文本时出现(提供行内格式化)

筛选可用命令 ​

可以通过传入命令 ID 数组来指定要包含的命令:

vue
<template>
  <Tiptapify
    :slash-commands="['h1', 'h2', 'h3', 'bulletList', 'numberedList', 'quote']"
    placeholder="Filtered commands..."
  />
</template>

可用命令 ID ​

ID说明
h1 - h61-6 级标题
bulletList无序列表
numberedList有序列表
taskList任务列表
code行内代码
codeBlock代码块
quote引用块
image图片
videoYouTube 视频
table表格
link链接
divider水平分隔线
emoji表情
specialChars特殊字符

基于 MIT 许可证发布。