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:
1668
packages/extension-heading/CHANGELOG.md
Normal file
1668
packages/extension-heading/CHANGELOG.md
Normal file
File diff suppressed because it is too large
Load Diff
18
packages/extension-heading/README.md
Normal file
18
packages/extension-heading/README.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# @tiptap/extension-heading
|
||||
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-heading)
|
||||
[](https://npmcharts.com/compare/tiptap?minimal=true)
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-heading)
|
||||
[](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-heading/package.json
Normal file
50
packages/extension-heading/package.json
Normal file
@@ -0,0 +1,50 @@
|
||||
{
|
||||
"name": "@tiptap/extension-heading",
|
||||
"version": "3.30.3",
|
||||
"description": "heading 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-heading"
|
||||
},
|
||||
"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:*"
|
||||
}
|
||||
}
|
||||
152
packages/extension-heading/src/heading.ts
Normal file
152
packages/extension-heading/src/heading.ts
Normal file
@@ -0,0 +1,152 @@
|
||||
import { mergeAttributes, Node, textblockTypeInputRule } from '@tiptap/core'
|
||||
|
||||
/**
|
||||
* The heading level options.
|
||||
*/
|
||||
export type Level = 1 | 2 | 3 | 4 | 5 | 6
|
||||
|
||||
export interface HeadingOptions {
|
||||
/**
|
||||
* The available heading levels.
|
||||
* @default [1, 2, 3, 4, 5, 6]
|
||||
* @example [1, 2, 3]
|
||||
*/
|
||||
levels: Level[]
|
||||
|
||||
/**
|
||||
* The HTML attributes for a heading node.
|
||||
* @default {}
|
||||
* @example { class: 'foo' }
|
||||
*/
|
||||
HTMLAttributes: Record<string, any>
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands<ReturnType> {
|
||||
heading: {
|
||||
/**
|
||||
* Set a heading node
|
||||
* @param attributes The heading attributes
|
||||
* @example editor.commands.setHeading({ level: 1 })
|
||||
*/
|
||||
setHeading: (attributes: { level: Level }) => ReturnType
|
||||
/**
|
||||
* Toggle a heading node
|
||||
* @param attributes The heading attributes
|
||||
* @example editor.commands.toggleHeading({ level: 1 })
|
||||
*/
|
||||
toggleHeading: (attributes: { level: Level }) => ReturnType
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This extension allows you to create headings.
|
||||
* @see https://www.tiptap.dev/api/nodes/heading
|
||||
*/
|
||||
export const Heading = Node.create<HeadingOptions>({
|
||||
name: 'heading',
|
||||
|
||||
addOptions() {
|
||||
return {
|
||||
levels: [1, 2, 3, 4, 5, 6],
|
||||
HTMLAttributes: {},
|
||||
}
|
||||
},
|
||||
|
||||
content: 'inline*',
|
||||
|
||||
group: 'block',
|
||||
|
||||
defining: true,
|
||||
|
||||
addAttributes() {
|
||||
return {
|
||||
level: {
|
||||
default: 1,
|
||||
rendered: false,
|
||||
},
|
||||
}
|
||||
},
|
||||
|
||||
parseHTML() {
|
||||
return this.options.levels.map((level: Level) => ({
|
||||
tag: `h${level}`,
|
||||
attrs: { level },
|
||||
}))
|
||||
},
|
||||
|
||||
renderHTML({ node, HTMLAttributes }) {
|
||||
const hasLevel = this.options.levels.includes(node.attrs.level)
|
||||
const level = hasLevel ? node.attrs.level : this.options.levels[0]
|
||||
|
||||
return [`h${level}`, mergeAttributes(this.options.HTMLAttributes, HTMLAttributes), 0]
|
||||
},
|
||||
|
||||
parseMarkdown: (token, helpers) => {
|
||||
// Convert 'heading' token to heading node
|
||||
// marked provides 'depth' property (1-6) for heading level
|
||||
return helpers.createNode(
|
||||
'heading',
|
||||
{ level: token.depth || 1 },
|
||||
helpers.parseInline(token.tokens || []),
|
||||
)
|
||||
},
|
||||
|
||||
renderMarkdown: (node, h) => {
|
||||
const level = node.attrs?.level ? parseInt(node.attrs.level as string, 10) : 1
|
||||
const headingChars = '#'.repeat(level)
|
||||
|
||||
if (!node.content) {
|
||||
return ''
|
||||
}
|
||||
|
||||
// Use current context for proper joining/spacing
|
||||
return `${headingChars} ${h.renderChildren(node.content)}`
|
||||
},
|
||||
|
||||
addCommands() {
|
||||
return {
|
||||
setHeading:
|
||||
attributes =>
|
||||
({ commands }) => {
|
||||
if (!this.options.levels.includes(attributes.level)) {
|
||||
return false
|
||||
}
|
||||
|
||||
return commands.setNode(this.name, attributes)
|
||||
},
|
||||
toggleHeading:
|
||||
attributes =>
|
||||
({ commands }) => {
|
||||
if (!this.options.levels.includes(attributes.level)) {
|
||||
return false
|
||||
}
|
||||
|
||||
return commands.toggleNode(this.name, 'paragraph', attributes)
|
||||
},
|
||||
}
|
||||
},
|
||||
|
||||
addKeyboardShortcuts() {
|
||||
return this.options.levels.reduce(
|
||||
(items, level) => ({
|
||||
...items,
|
||||
[`Mod-Alt-${level}`]: () => this.editor.commands.toggleHeading({ level }),
|
||||
}),
|
||||
{},
|
||||
)
|
||||
},
|
||||
|
||||
addInputRules() {
|
||||
return this.options.levels.map(level => {
|
||||
return textblockTypeInputRule({
|
||||
find: new RegExp(`^(#{${Math.min(...this.options.levels)},${level}})\\s$`),
|
||||
type: this.type,
|
||||
getAttributes: {
|
||||
level,
|
||||
},
|
||||
})
|
||||
})
|
||||
},
|
||||
})
|
||||
5
packages/extension-heading/src/index.ts
Normal file
5
packages/extension-heading/src/index.ts
Normal file
@@ -0,0 +1,5 @@
|
||||
import { Heading } from './heading.js'
|
||||
|
||||
export * from './heading.js'
|
||||
|
||||
export default Heading
|
||||
9
packages/extension-heading/vite.config.ts
Normal file
9
packages/extension-heading/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