コンテンツへスキップ

スラッシュコマンド ​

スラッシュコマンドは、行頭で / を入力すると表示されるクイック挿入メニューです。

スラッシュコマンドを有効にする ​

スラッシュコマンドはデフォルトで有効です。明示的に制御するには次のようにします。

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 ダイアログが開きます)
/videoYouTube 動画を埋め込み
/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 - h6見出しレベル 1〜6
bulletList箇条書きリスト
numberedList番号付きリスト
taskListタスクリスト
codeインラインコード
codeBlockコードブロック
quote引用ブロック
image画像
videoYouTube 動画
table表
linkリンク
divider水平線
emoji絵文字
specialChars特殊文字

MIT ライセンスのもとで公開されています。