snapshot of https://github.com/ueberdosis/tiptap.git (main, 2026-09-15; blobs > 131072B omitted)

packages/extension-hard-break/README.md

@@ -0,0 +1,18 @@
+# @tiptap/extension-hard-break
+
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-hard-break.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-hard-break)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-hard-break.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
+[![License](https://img.shields.io/npm/l/@tiptap/extension-hard-break.svg)](https://www.npmjs.com/package/@tiptap/extension-hard-break)
+[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
+
+## Introduction
+
+Tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a toolkit for building rich text WYSIWYG editors, which is already in use at many well-known companies such as _New York Times_, _The Guardian_ or _Atlassian_.
+
+## Official Documentation
+
+Documentation can be found on the [Tiptap website](https://tiptap.dev).
+
+## License
+
+Tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap/blob/main/LICENSE.md).

packages/extension-hard-break/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@tiptap/extension-hard-break",
+  "version": "3.30.3",
+  "description": "hard break extension for tiptap",
+  "keywords": [
+    "tiptap",
+    "tiptap extension"
+  ],
+  "homepage": "https://tiptap.dev",
+  "bugs": {
+    "url": "https://github.com/ueberdosis/tiptap/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ueberdosis/tiptap",
+    "directory": "packages/extension-hard-break"
+  },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/ueberdosis"
+  },
+  "files": [
+    "src",
+    "dist"
+  ],
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/index.d.ts",
+        "require": "./dist/index.d.cts"
+      },
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "scripts": {
+    "build": "vp pack"
+  },
+  "devDependencies": {
+    "@tiptap/core": "workspace:^"
+  },
+  "peerDependencies": {
+    "@tiptap/core": "workspace:*"
+  }
+}

packages/extension-hard-break/src/hard-break.test.ts

@@ -0,0 +1,78 @@
+import { Editor } from '@tiptap/core'
+import { Document } from '@tiptap/extension-document'
+import { Paragraph } from '@tiptap/extension-paragraph'
+import { Text } from '@tiptap/extension-text'
+import { afterEach, describe, expect, it } from 'vite-plus/test'
+import type { Transaction } from '@tiptap/pm/state'
+
+import { HardBreak } from './hard-break.js'
+
+describe('HardBreak', () => {
+  let editor: Editor
+
+  afterEach(() => {
+    editor?.destroy()
+  })
+
+  it('scrolls the selection into view when adding a hard break', () => {
+    editor = new Editor({
+      extensions: [Document, Paragraph, Text, HardBreak],
+      content: '<p>hello</p>',
+    })
+
+    editor.commands.setTextSelection(6)
+
+    let lastTr: Transaction
+    const origDispatch = editor.view.dispatch.bind(editor.view)
+
+    editor.view.dispatch = (tr: Transaction) => {
+      lastTr = tr
+      return origDispatch(tr)
+    }
+
+    editor.commands.setHardBreak()
+
+    expect(lastTr!).toBeDefined()
+    expect(lastTr!.scrolledIntoView).toBe(true)
+  })
+
+  it('scrolls the selection into view when pressing Shift+Enter', () => {
+    editor = new Editor({
+      extensions: [Document, Paragraph, Text, HardBreak],
+      content: '<p>hello</p>',
+    })
+
+    editor.commands.setTextSelection(6)
+
+    let lastTr: Transaction
+    const origDispatch = editor.view.dispatch.bind(editor.view)
+
+    editor.view.dispatch = (tr: Transaction) => {
+      lastTr = tr
+      return origDispatch(tr)
+    }
+
+    const event = new KeyboardEvent('keydown', {
+      key: 'Enter',
+      code: 'Enter',
+      shiftKey: true,
+    })
+    editor.view.dispatchEvent(event)
+
+    expect(lastTr!).toBeDefined()
+    expect(lastTr!.scrolledIntoView).toBe(true)
+    expect(editor.getHTML()).toBe('<p>hello<br></p>')
+  })
+
+  it('inserts a hardbreak into a document', () => {
+    editor = new Editor({
+      extensions: [Document, Paragraph, Text, HardBreak],
+      content: '<p>hello</p>',
+    })
+
+    editor.commands.setTextSelection(6)
+    editor.commands.setHardBreak()
+
+    expect(editor.getHTML()).toBe('<p>hello<br></p>')
+  })
+})

packages/extension-hard-break/src/hard-break.ts

@@ -0,0 +1,121 @@
+import { mergeAttributes, Node } from '@tiptap/core'
+
+export interface HardBreakOptions {
+  /**
+   * Controls if marks should be kept after being split by a hard break.
+   * @default true
+   * @example false
+   */
+  keepMarks: boolean
+
+  /**
+   * HTML attributes to add to the hard break element.
+   * @default {}
+   * @example { class: 'foo' }
+   */
+  HTMLAttributes: Record<string, any>
+}
+
+declare module '@tiptap/core' {
+  interface Commands<ReturnType> {
+    hardBreak: {
+      /**
+       * Add a hard break
+       * @example editor.commands.setHardBreak()
+       */
+      setHardBreak: () => ReturnType
+    }
+  }
+}
+
+/**
+ * This extension allows you to insert hard breaks.
+ * @see https://www.tiptap.dev/api/nodes/hard-break
+ */
+export const HardBreak = Node.create<HardBreakOptions>({
+  name: 'hardBreak',
+
+  markdownTokenName: 'br',
+
+  addOptions() {
+    return {
+      keepMarks: true,
+      HTMLAttributes: {},
+    }
+  },
+
+  inline: true,
+
+  group: 'inline',
+
+  selectable: false,
+
+  linebreakReplacement: true,
+
+  parseHTML() {
+    return [{ tag: 'br' }]
+  },
+
+  renderHTML({ HTMLAttributes }) {
+    return ['br', mergeAttributes(this.options.HTMLAttributes, HTMLAttributes)]
+  },
+
+  renderText() {
+    return '\n'
+  },
+
+  renderMarkdown: () => `  \n`,
+
+  parseMarkdown: () => {
+    return {
+      type: 'hardBreak',
+    }
+  },
+
+  addCommands() {
+    return {
+      setHardBreak:
+        () =>
+        ({ commands, chain, state, editor }) => {
+          return commands.first([
+            () => commands.exitCode(),
+            () =>
+              commands.command(() => {
+                const { selection, storedMarks } = state
+
+                if (selection.$from.parent.type.spec.isolating) {
+                  return false
+                }
+
+                const { keepMarks } = this.options
+                const { splittableMarks } = editor.extensionManager
+                const marks = storedMarks || (selection.$to.parentOffset && selection.$from.marks())
+
+                return chain()
+                  .insertContent({ type: this.name })
+                  .command(({ tr, dispatch }) => {
+                    if (dispatch && marks && keepMarks) {
+                      const filteredMarks = marks.filter(mark =>
+                        splittableMarks.includes(mark.type.name),
+                      )
+
+                      tr.ensureMarks(filteredMarks)
+                    }
+
+                    return true
+                  })
+                  .scrollIntoView()
+                  .run()
+              }),
+          ])
+        },
+    }
+  },
+
+  addKeyboardShortcuts() {
+    return {
+      'Mod-Enter': () => this.editor.commands.setHardBreak(),
+      'Shift-Enter': () => this.editor.commands.setHardBreak(),
+    }
+  },
+})

packages/extension-hard-break/src/index.ts

@@ -0,0 +1,5 @@
+import { HardBreak } from './hard-break.js'
+
+export * from './hard-break.js'
+
+export default HardBreak

packages/extension-hard-break/vite.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'vite-plus'
+import { basePackConfig } from '../../pack.config.mjs'
+
+export default defineConfig({
+  pack: {
+    entry: ['src/index.ts'],
+    ...basePackConfig(),
+  },
+})