snapshot of https://github.com/ueberdosis/tiptap.git (main, 2026-09-15; blobs > 131072B omitted)
Some checks failed
Verify / Install node dependencies (push) Failing after 2s
Verify / Build packages (push) Has been skipped
Verify / Check linting & formatting (push) Has been skipped
Verify / Run unit tests (push) Has been skipped
Verify / Run e2e tests (shard 1/4) (push) Has been skipped
Verify / Run e2e tests (shard 2/4) (push) Has been skipped
Verify / Run e2e tests (shard 3/4) (push) Has been skipped
Verify / Run e2e tests (shard 4/4) (push) Has been skipped
Publish / Resolve publish config (push) Failing after 2s
Publish / Send notification to Slack (push) Has been skipped
Publish / Send failure notification to Slack (push) Failing after 8s
Verify / Merge e2e reports (push) Has been skipped
Publish / Build (push) Has been skipped
Publish / Bump Versions OR Release to Registry (push) Has been skipped
Some checks failed
Verify / Install node dependencies (push) Failing after 2s
Verify / Build packages (push) Has been skipped
Verify / Check linting & formatting (push) Has been skipped
Verify / Run unit tests (push) Has been skipped
Verify / Run e2e tests (shard 1/4) (push) Has been skipped
Verify / Run e2e tests (shard 2/4) (push) Has been skipped
Verify / Run e2e tests (shard 3/4) (push) Has been skipped
Verify / Run e2e tests (shard 4/4) (push) Has been skipped
Publish / Resolve publish config (push) Failing after 2s
Publish / Send notification to Slack (push) Has been skipped
Publish / Send failure notification to Slack (push) Failing after 8s
Verify / Merge e2e reports (push) Has been skipped
Publish / Build (push) Has been skipped
Publish / Bump Versions OR Release to Registry (push) Has been skipped
This commit is contained in:
1654
packages/extension-paragraph/CHANGELOG.md
Normal file
1654
packages/extension-paragraph/CHANGELOG.md
Normal file
File diff suppressed because it is too large
Load Diff
18
packages/extension-paragraph/README.md
Normal file
18
packages/extension-paragraph/README.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# @tiptap/extension-paragraph
|
||||
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-paragraph)
|
||||
[](https://npmcharts.com/compare/tiptap?minimal=true)
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-paragraph)
|
||||
[](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).
|
||||
50
packages/extension-paragraph/package.json
Normal file
50
packages/extension-paragraph/package.json
Normal file
@@ -0,0 +1,50 @@
|
||||
{
|
||||
"name": "@tiptap/extension-paragraph",
|
||||
"version": "3.30.3",
|
||||
"description": "paragraph 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-paragraph"
|
||||
},
|
||||
"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:*"
|
||||
}
|
||||
}
|
||||
5
packages/extension-paragraph/src/index.ts
Normal file
5
packages/extension-paragraph/src/index.ts
Normal file
@@ -0,0 +1,5 @@
|
||||
import { Paragraph } from './paragraph.js'
|
||||
|
||||
export * from './paragraph.js'
|
||||
|
||||
export default Paragraph
|
||||
139
packages/extension-paragraph/src/paragraph.ts
Normal file
139
packages/extension-paragraph/src/paragraph.ts
Normal file
@@ -0,0 +1,139 @@
|
||||
import { mergeAttributes, Node } from '@tiptap/core'
|
||||
|
||||
export interface ParagraphOptions {
|
||||
/**
|
||||
* The HTML attributes for a paragraph node.
|
||||
* @default {}
|
||||
* @example { class: 'foo' }
|
||||
*/
|
||||
HTMLAttributes: Record<string, any>
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands<ReturnType> {
|
||||
paragraph: {
|
||||
/**
|
||||
* Toggle a paragraph
|
||||
* @example editor.commands.toggleParagraph()
|
||||
*/
|
||||
setParagraph: () => ReturnType
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Markdown marker for empty paragraphs to preserve blank lines.
|
||||
* Using (non-breaking space HTML entity) ensures the paragraph
|
||||
* is not collapsed by markdown parsers while remaining human-readable.
|
||||
*/
|
||||
const EMPTY_PARAGRAPH_MARKDOWN = ' '
|
||||
|
||||
/**
|
||||
* Unicode character for non-breaking space (U+00A0).
|
||||
* Some markdown parsers may convert entities to this literal character.
|
||||
*/
|
||||
const NBSP_CHAR = '\u00A0'
|
||||
|
||||
/**
|
||||
* This extension allows you to create paragraphs.
|
||||
* @see https://www.tiptap.dev/api/nodes/paragraph
|
||||
*/
|
||||
export const Paragraph = Node.create<ParagraphOptions>({
|
||||
name: 'paragraph',
|
||||
|
||||
priority: 1000,
|
||||
|
||||
addOptions() {
|
||||
return {
|
||||
HTMLAttributes: {},
|
||||
}
|
||||
},
|
||||
|
||||
group: 'block',
|
||||
|
||||
content: 'inline*',
|
||||
|
||||
parseHTML() {
|
||||
return [{ tag: 'p' }]
|
||||
},
|
||||
|
||||
renderHTML({ HTMLAttributes }) {
|
||||
return ['p', mergeAttributes(this.options.HTMLAttributes, HTMLAttributes), 0]
|
||||
},
|
||||
|
||||
parseMarkdown: (token, helpers) => {
|
||||
const tokens = token.tokens || []
|
||||
|
||||
// Special case: if paragraph contains only a single image token,
|
||||
// unwrap it to avoid nesting block elements incorrectly
|
||||
if (tokens.length === 1 && tokens[0].type === 'image') {
|
||||
// Parse the image token directly as a block element
|
||||
return helpers.parseChildren([tokens[0]])
|
||||
}
|
||||
|
||||
// Parse the inline tokens
|
||||
const content = helpers.parseInline(tokens)
|
||||
|
||||
// Special case: if paragraph contains only (non-breaking space),
|
||||
// treat it as an empty paragraph to preserve blank lines
|
||||
const hasExplicitEmptyParagraphMarker =
|
||||
tokens.length === 1 &&
|
||||
tokens[0].type === 'text' &&
|
||||
(tokens[0].raw === EMPTY_PARAGRAPH_MARKDOWN ||
|
||||
tokens[0].text === EMPTY_PARAGRAPH_MARKDOWN ||
|
||||
tokens[0].raw === NBSP_CHAR ||
|
||||
tokens[0].text === NBSP_CHAR)
|
||||
|
||||
if (
|
||||
hasExplicitEmptyParagraphMarker &&
|
||||
content.length === 1 &&
|
||||
content[0].type === 'text' &&
|
||||
(content[0].text === EMPTY_PARAGRAPH_MARKDOWN || content[0].text === NBSP_CHAR)
|
||||
) {
|
||||
return helpers.createNode('paragraph', undefined, [])
|
||||
}
|
||||
|
||||
// Convert 'paragraph' token to paragraph node
|
||||
return helpers.createNode('paragraph', undefined, content)
|
||||
},
|
||||
|
||||
renderMarkdown: (node, h, ctx) => {
|
||||
if (!node) {
|
||||
return ''
|
||||
}
|
||||
|
||||
// Normalize content: treat undefined/null as empty array
|
||||
const content = Array.isArray(node.content) ? node.content : []
|
||||
|
||||
if (content.length === 0) {
|
||||
// Emit for the second and later empty paragraphs in a consecutive
|
||||
// run at the current nesting level. The first empty paragraph stays empty
|
||||
// so markdown spacing is preserved naturally.
|
||||
const previousContent = Array.isArray(ctx?.previousNode?.content)
|
||||
? ctx.previousNode.content
|
||||
: []
|
||||
const previousNodeIsEmptyParagraph =
|
||||
ctx?.previousNode?.type === 'paragraph' && previousContent.length === 0
|
||||
|
||||
return previousNodeIsEmptyParagraph ? EMPTY_PARAGRAPH_MARKDOWN : ''
|
||||
}
|
||||
|
||||
return h.renderChildren(content)
|
||||
},
|
||||
|
||||
addCommands() {
|
||||
return {
|
||||
setParagraph:
|
||||
() =>
|
||||
({ commands }) => {
|
||||
return commands.setNode(this.name)
|
||||
},
|
||||
}
|
||||
},
|
||||
|
||||
addKeyboardShortcuts() {
|
||||
return {
|
||||
'Mod-Alt-0': () => this.editor.commands.setParagraph(),
|
||||
}
|
||||
},
|
||||
})
|
||||
9
packages/extension-paragraph/vite.config.ts
Normal file
9
packages/extension-paragraph/vite.config.ts
Normal file
@@ -0,0 +1,9 @@
|
||||
import { defineConfig } from 'vite-plus'
|
||||
import { basePackConfig } from '../../pack.config.mjs'
|
||||
|
||||
export default defineConfig({
|
||||
pack: {
|
||||
entry: ['src/index.ts'],
|
||||
...basePackConfig(),
|
||||
},
|
||||
})
|
||||
Reference in New Issue
Block a user