rename the code block extension, add content to the code block extension
This commit is contained in:
5
docs/src/demos/Extensions/CodeBlock/index.spec.js
Normal file
5
docs/src/demos/Extensions/CodeBlock/index.spec.js
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
context('/api/extensions/code-block', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
cy.visit('/api/extensions/code-block')
|
||||||
|
})
|
||||||
|
})
|
||||||
51
docs/src/demos/Extensions/CodeBlock/index.vue
Normal file
51
docs/src/demos/Extensions/CodeBlock/index.vue
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
<template>
|
||||||
|
<div v-if="editor">
|
||||||
|
<button @click="editor.focus().codeBlock()" :class="{ 'is-active': editor.isActive('codeBlock') }">
|
||||||
|
code block
|
||||||
|
</button>
|
||||||
|
|
||||||
|
<editor-content :editor="editor" />
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
import { Editor } from '@tiptap/core'
|
||||||
|
import { EditorContent } from '@tiptap/vue'
|
||||||
|
import Document from '@tiptap/extension-document'
|
||||||
|
import Paragraph from '@tiptap/extension-paragraph'
|
||||||
|
import Text from '@tiptap/extension-text'
|
||||||
|
import CodeBlock from '@tiptap/extension-code-block'
|
||||||
|
|
||||||
|
export default {
|
||||||
|
components: {
|
||||||
|
EditorContent,
|
||||||
|
},
|
||||||
|
|
||||||
|
data() {
|
||||||
|
return {
|
||||||
|
editor: null,
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
mounted() {
|
||||||
|
this.editor = new Editor({
|
||||||
|
extensions: [
|
||||||
|
Document(),
|
||||||
|
Paragraph(),
|
||||||
|
Text(),
|
||||||
|
CodeBlock(),
|
||||||
|
],
|
||||||
|
content: `
|
||||||
|
<p>This is a code block:</p>
|
||||||
|
<pre><code>const foo = 'bar'</code></pre>
|
||||||
|
`,
|
||||||
|
})
|
||||||
|
|
||||||
|
window.editor = this.editor
|
||||||
|
},
|
||||||
|
|
||||||
|
beforeDestroy() {
|
||||||
|
this.editor.destroy()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
@@ -37,7 +37,7 @@ import History from '@tiptap/extension-history'
|
|||||||
import Bold from '@tiptap/extension-bold'
|
import Bold from '@tiptap/extension-bold'
|
||||||
import Italic from '@tiptap/extension-italic'
|
import Italic from '@tiptap/extension-italic'
|
||||||
import Code from '@tiptap/extension-code'
|
import Code from '@tiptap/extension-code'
|
||||||
import CodeBlock from '@tiptap/extension-codeblock'
|
import CodeBlock from '@tiptap/extension-code-block'
|
||||||
import Heading from '@tiptap/extension-heading'
|
import Heading from '@tiptap/extension-heading'
|
||||||
|
|
||||||
export default {
|
export default {
|
||||||
|
|||||||
@@ -2,10 +2,20 @@
|
|||||||
Enables you to use the `<pre>` HTML tag in the editor.
|
Enables you to use the `<pre>` HTML tag in the editor.
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
*None*
|
| Option | Type | Default | Description |
|
||||||
|
| ------ | ------ | ------- | -------------------------------------------- |
|
||||||
|
| class | string | – | Add a custom class to the rendered HTML tag. |
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
*None*
|
| Command | Options | Description |
|
||||||
|
| --------- | ------- | ----------------------------- |
|
||||||
|
| codeBlock | — | Wrap content in a code block. |
|
||||||
|
|
||||||
## Keyboard shortcuts
|
## Keyboard shortcuts
|
||||||
*None*
|
* `Shift` + `Control` + `\`
|
||||||
|
|
||||||
|
## Source Code
|
||||||
|
[packages/extension-code-block/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code-block/)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
<demo name="Extensions/CodeBlock" highlight="3-5,17,36" />
|
||||||
|
|||||||
17
packages/extension-code-block/package.json
Normal file
17
packages/extension-code-block/package.json
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"name": "@tiptap/extension-code-block",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"source": "index.ts",
|
||||||
|
"main": "dist/tiptap-extension-code-block.js",
|
||||||
|
"umd:main": "dist/tiptap-extension-code-block.umd.js",
|
||||||
|
"module": "dist/tiptap-extension-code-block.mjs",
|
||||||
|
"unpkg": "dist/tiptap-extension-code-block.js",
|
||||||
|
"jsdelivr": "dist/tiptap-extension-code-block.js",
|
||||||
|
"files": [
|
||||||
|
"src",
|
||||||
|
"dist"
|
||||||
|
],
|
||||||
|
"peerDependencies": {
|
||||||
|
"@tiptap/core": "2.x"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "@tiptap/extension-codeblock",
|
|
||||||
"version": "1.0.0",
|
|
||||||
"source": "index.ts",
|
|
||||||
"main": "dist/tiptap-extension-codeblock.js",
|
|
||||||
"umd:main": "dist/tiptap-extension-codeblock.umd.js",
|
|
||||||
"module": "dist/tiptap-extension-codeblock.mjs",
|
|
||||||
"unpkg": "dist/tiptap-extension-codeblock.js",
|
|
||||||
"jsdelivr": "dist/tiptap-extension-codeblock.js",
|
|
||||||
"files": [
|
|
||||||
"src",
|
|
||||||
"dist"
|
|
||||||
],
|
|
||||||
"peerDependencies": {
|
|
||||||
"@tiptap/core": "2.x"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -5,7 +5,7 @@ import History from '@tiptap/extension-history'
|
|||||||
import Bold from '@tiptap/extension-bold'
|
import Bold from '@tiptap/extension-bold'
|
||||||
import Italic from '@tiptap/extension-italic'
|
import Italic from '@tiptap/extension-italic'
|
||||||
import Code from '@tiptap/extension-code'
|
import Code from '@tiptap/extension-code'
|
||||||
import CodeBlock from '@tiptap/extension-codeblock'
|
import CodeBlock from '@tiptap/extension-code-block'
|
||||||
import Heading from '@tiptap/extension-heading'
|
import Heading from '@tiptap/extension-heading'
|
||||||
import HardBreak from '@tiptap/extension-hard-break'
|
import HardBreak from '@tiptap/extension-hard-break'
|
||||||
import Strike from '@tiptap/extension-strike'
|
import Strike from '@tiptap/extension-strike'
|
||||||
|
|||||||
@@ -19,7 +19,7 @@
|
|||||||
"@tiptap/extension-bold": "1.x",
|
"@tiptap/extension-bold": "1.x",
|
||||||
"@tiptap/extension-italic": "1.x",
|
"@tiptap/extension-italic": "1.x",
|
||||||
"@tiptap/extension-code": "1.x",
|
"@tiptap/extension-code": "1.x",
|
||||||
"@tiptap/extension-codeblock": "1.x",
|
"@tiptap/extension-code-block": "1.x",
|
||||||
"@tiptap/extension-heading": "1.x"
|
"@tiptap/extension-heading": "1.x"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import History from '@tiptap/extension-history'
|
|||||||
import Bold from '@tiptap/extension-bold'
|
import Bold from '@tiptap/extension-bold'
|
||||||
import Italic from '@tiptap/extension-italic'
|
import Italic from '@tiptap/extension-italic'
|
||||||
import Code from '@tiptap/extension-code'
|
import Code from '@tiptap/extension-code'
|
||||||
import CodeBlock from '@tiptap/extension-codeblock'
|
import CodeBlock from '@tiptap/extension-code-block'
|
||||||
import Heading from '@tiptap/extension-heading'
|
import Heading from '@tiptap/extension-heading'
|
||||||
import HardBreak from '@tiptap/extension-hard-break'
|
import HardBreak from '@tiptap/extension-hard-break'
|
||||||
import Strike from '@tiptap/extension-strike'
|
import Strike from '@tiptap/extension-strike'
|
||||||
|
|||||||
@@ -20,7 +20,7 @@
|
|||||||
"@tiptap/extension-bold": "1.x",
|
"@tiptap/extension-bold": "1.x",
|
||||||
"@tiptap/extension-italic": "1.x",
|
"@tiptap/extension-italic": "1.x",
|
||||||
"@tiptap/extension-code": "1.x",
|
"@tiptap/extension-code": "1.x",
|
||||||
"@tiptap/extension-codeblock": "1.x",
|
"@tiptap/extension-code-block": "1.x",
|
||||||
"@tiptap/extension-heading": "1.x"
|
"@tiptap/extension-heading": "1.x"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user