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:
1644
packages/extension-underline/CHANGELOG.md
Normal file
1644
packages/extension-underline/CHANGELOG.md
Normal file
File diff suppressed because it is too large
Load Diff
18
packages/extension-underline/README.md
Normal file
18
packages/extension-underline/README.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# @tiptap/extension-underline
|
||||
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-underline)
|
||||
[](https://npmcharts.com/compare/tiptap?minimal=true)
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-underline)
|
||||
[](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-underline/package.json
Normal file
50
packages/extension-underline/package.json
Normal file
@@ -0,0 +1,50 @@
|
||||
{
|
||||
"name": "@tiptap/extension-underline",
|
||||
"version": "3.30.3",
|
||||
"description": "underline 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-underline"
|
||||
},
|
||||
"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-underline/src/index.ts
Normal file
5
packages/extension-underline/src/index.ts
Normal file
@@ -0,0 +1,5 @@
|
||||
import { Underline } from './underline.js'
|
||||
|
||||
export * from './underline.js'
|
||||
|
||||
export default Underline
|
||||
123
packages/extension-underline/src/underline.ts
Normal file
123
packages/extension-underline/src/underline.ts
Normal file
@@ -0,0 +1,123 @@
|
||||
import { Mark, mergeAttributes } from '@tiptap/core'
|
||||
|
||||
export interface UnderlineOptions {
|
||||
/**
|
||||
* HTML attributes to add to the underline element.
|
||||
* @default {}
|
||||
* @example { class: 'foo' }
|
||||
*/
|
||||
HTMLAttributes: Record<string, any>
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands<ReturnType> {
|
||||
underline: {
|
||||
/**
|
||||
* Set an underline mark
|
||||
* @example editor.commands.setUnderline()
|
||||
*/
|
||||
setUnderline: () => ReturnType
|
||||
/**
|
||||
* Toggle an underline mark
|
||||
* @example editor.commands.toggleUnderline()
|
||||
*/
|
||||
toggleUnderline: () => ReturnType
|
||||
/**
|
||||
* Unset an underline mark
|
||||
* @example editor.commands.unsetUnderline()
|
||||
*/
|
||||
unsetUnderline: () => ReturnType
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This extension allows you to create underline text.
|
||||
* @see https://www.tiptap.dev/api/marks/underline
|
||||
*/
|
||||
export const Underline = Mark.create<UnderlineOptions>({
|
||||
name: 'underline',
|
||||
|
||||
addOptions() {
|
||||
return {
|
||||
HTMLAttributes: {},
|
||||
}
|
||||
},
|
||||
|
||||
parseHTML() {
|
||||
return [
|
||||
{
|
||||
tag: 'u',
|
||||
},
|
||||
{
|
||||
style: 'text-decoration',
|
||||
consuming: false,
|
||||
getAttrs: style => ((style as string).includes('underline') ? {} : false),
|
||||
},
|
||||
]
|
||||
},
|
||||
|
||||
renderHTML({ HTMLAttributes }) {
|
||||
return ['u', mergeAttributes(this.options.HTMLAttributes, HTMLAttributes), 0]
|
||||
},
|
||||
|
||||
parseMarkdown(token, helpers) {
|
||||
return helpers.applyMark(this.name || 'underline', helpers.parseInline(token.tokens || []))
|
||||
},
|
||||
|
||||
renderMarkdown(node, helpers) {
|
||||
return `++${helpers.renderChildren(node)}++`
|
||||
},
|
||||
|
||||
markdownTokenizer: {
|
||||
name: 'underline',
|
||||
level: 'inline',
|
||||
start(src) {
|
||||
return src.indexOf('++')
|
||||
},
|
||||
tokenize(src, _tokens, lexer) {
|
||||
const rule = /^(\+\+)([\s\S]+?)(\+\+)/
|
||||
const match = rule.exec(src)
|
||||
|
||||
if (!match) {
|
||||
return undefined
|
||||
}
|
||||
|
||||
const innerContent = match[2].trim()
|
||||
|
||||
return {
|
||||
type: 'underline',
|
||||
raw: match[0],
|
||||
text: innerContent,
|
||||
tokens: lexer.inlineTokens(innerContent),
|
||||
}
|
||||
},
|
||||
},
|
||||
|
||||
addCommands() {
|
||||
return {
|
||||
setUnderline:
|
||||
() =>
|
||||
({ commands }) => {
|
||||
return commands.setMark(this.name)
|
||||
},
|
||||
toggleUnderline:
|
||||
() =>
|
||||
({ commands }) => {
|
||||
return commands.toggleMark(this.name)
|
||||
},
|
||||
unsetUnderline:
|
||||
() =>
|
||||
({ commands }) => {
|
||||
return commands.unsetMark(this.name)
|
||||
},
|
||||
}
|
||||
},
|
||||
|
||||
addKeyboardShortcuts() {
|
||||
return {
|
||||
'Mod-u': () => this.editor.commands.toggleUnderline(),
|
||||
'Mod-U': () => this.editor.commands.toggleUnderline(),
|
||||
}
|
||||
},
|
||||
})
|
||||
9
packages/extension-underline/vite.config.ts
Normal file
9
packages/extension-underline/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