tiptap HardBreak 换行节点

HardBreak 节点功能相当于 html 里面的 br 标签。

Install 安装

npm install @tiptap/extension-hard-break

Settings 配置

keepMarks 换行后是否保持标记Marks。

HardBreak.configure({
 keepMarks: false,
})

HTMLAttributes 自定义标签对应的HTML属性。

HardBreak.configure({
  HTMLAttributes: {
    class: 'my-custom-class',
  },
})

Commands 命令

setHardBreak 将选中内容换行。

editor.commands.setHardBreak()

Shortcuts 快捷键

Windows/Linux Shift Enter Control Enter
macOS Shift Enter Cmd Enter

源代码

hard-break/ 源代码

在线例子

vue 在线例子

HardBreak 例子

Vue 例子
React 例子

<template>
  <div v-if="editor">
    <button @click="editor.chain().focus().setHardBreak().run()">
      setHardBreak
    </button>
    <editor-content :editor="editor" />
  </div>
</template>
<script>
import Document from '@tiptap/extension-document'
import HardBreak from '@tiptap/extension-hard-break'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'
import { Editor, EditorContent } from '@tiptap/vue-3'

export default {
  components: {
    EditorContent,
  },
  data() {
    return {
      editor: null,
    }
  },
  mounted() {
    this.editor = new Editor({
      extensions: [
        Document,
        Paragraph,
        Text,
        HardBreak,
      ],
      content: `
        <p>
          This<br>
          is<br>
          a<br>
          single<br>
          paragraph<br>
          with<br>
          line<br>
          breaks.
        </p>
      `,
    })
  },
  beforeUnmount() {
    this.editor.destroy()
  },
}
</script>

import Document from '@tiptap/extension-document'
import HardBreak from '@tiptap/extension-hard-break'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'
import { EditorContent, useEditor } from '@tiptap/react'
import React from 'react'

export default () => {
  const editor = useEditor({
    extensions: [Document, Paragraph, Text, HardBreak],
    content: `
        <p>
          This<br>
          is<br>
          a<br>
          single<br>
          paragraph<br>
          with<br>
          line<br>
          breaks.
        </p>
      `,
  })

  if (!editor) {
    return null
  }

  return (
    <>
      <button onClick={() => editor.chain().focus().setHardBreak().run()}>setHardBreak</button>
      <EditorContent editor={editor} />
    </>
  )
}

下载教程 Demo

本教程Demo的源码点击这里下载，Tiptap Demo，下载完成后运行npm i初始化依赖包。