From d7db24a1992b6a3fc0c610850fcf72c80aa8b487 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Thu, 24 Sep 2020 15:27:29 +0200 Subject: [PATCH 1/3] add paragraph command and keyboard shortcut --- docs/src/demos/Examples/Basic/index.vue | 3 +++ packages/extension-paragraph/index.ts | 10 ++++++++++ 2 files changed, 13 insertions(+) diff --git a/docs/src/demos/Examples/Basic/index.vue b/docs/src/demos/Examples/Basic/index.vue index ac98419d..e4c7e0d5 100644 --- a/docs/src/demos/Examples/Basic/index.vue +++ b/docs/src/demos/Examples/Basic/index.vue @@ -28,6 +28,9 @@ + diff --git a/packages/extension-paragraph/index.ts b/packages/extension-paragraph/index.ts index a0a721d1..aaf61f25 100644 --- a/packages/extension-paragraph/index.ts +++ b/packages/extension-paragraph/index.ts @@ -10,4 +10,14 @@ export default new Node() toDOM: () => ['p', 0], // toVue: ParagraphComponent, })) + .commands(({ name }) => ({ + [name]: () => ({ commands }) => { + return commands.toggleNode(name, 'paragraph') + }, + })) + .keys(({ editor, name }) => ({ + // Exception: TS2339: Property 'paragraph' does not exist on type 'Editor'. + // 'Mod-Alt-0': () => editor.paragraph(), + 'Mod-Alt-0': () => editor.toggleNode(name, 'paragraph'), + })) .create() From 188824c0bb85840e6c089269f0a6bd64f60e8d01 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Thu, 24 Sep 2020 19:07:47 +0200 Subject: [PATCH 2/3] register ParagraphCommand --- packages/extension-paragraph/index.ts | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/packages/extension-paragraph/index.ts b/packages/extension-paragraph/index.ts index aaf61f25..b32f1386 100644 --- a/packages/extension-paragraph/index.ts +++ b/packages/extension-paragraph/index.ts @@ -1,6 +1,14 @@ -import { Node } from '@tiptap/core' +import { Command, Node } from '@tiptap/core' // import ParagraphComponent from './paragraph.vue' +export type ParagraphCommand = () => Command + +declare module '@tiptap/core/src/Editor' { + interface Commands { + paragraph: ParagraphCommand, + } +} + export default new Node() .name('paragraph') .schema(() => ({ @@ -15,9 +23,7 @@ export default new Node() return commands.toggleNode(name, 'paragraph') }, })) - .keys(({ editor, name }) => ({ - // Exception: TS2339: Property 'paragraph' does not exist on type 'Editor'. - // 'Mod-Alt-0': () => editor.paragraph(), - 'Mod-Alt-0': () => editor.toggleNode(name, 'paragraph'), + .keys(({ editor }) => ({ + 'Mod-Alt-0': () => editor.paragraph(), })) .create() From f031eb1d576a10f0b2de2328b2464e5793343be4 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Thu, 24 Sep 2020 19:10:22 +0200 Subject: [PATCH 3/3] add new features to the paragraph documentation --- docs/src/docPages/api/extensions/ordered-list.md | 4 ++-- docs/src/docPages/api/extensions/paragraph.md | 7 +++++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/src/docPages/api/extensions/ordered-list.md b/docs/src/docPages/api/extensions/ordered-list.md index e7bf787f..77412f69 100644 --- a/docs/src/docPages/api/extensions/ordered-list.md +++ b/docs/src/docPages/api/extensions/ordered-list.md @@ -22,8 +22,8 @@ yarn add @tiptap/extension-ordered-list @tiptap/extension-list-item | class | string | – | Add a custom class to the rendered HTML tag. | ## Commands -| Command | Options | Description | -| ----------- | ------- | --------------------- | +| Command | Options | Description | +| ------------ | ------- | ---------------------- | | ordered_list | — | Toggle a ordered list. | ## Keyboard shortcuts diff --git a/docs/src/docPages/api/extensions/paragraph.md b/docs/src/docPages/api/extensions/paragraph.md index e57d8e54..c47a55af 100644 --- a/docs/src/docPages/api/extensions/paragraph.md +++ b/docs/src/docPages/api/extensions/paragraph.md @@ -20,10 +20,13 @@ yarn add @tiptap/extension-paragraph | class | string | – | Add a custom class to the rendered HTML tag. | ## Commands -*None* +| Command | Options | Description | +| --------- | ------- | -------------------------------------------- | +| paragraph | — | Transforms all selected nodes to paragraphs. | ## Keyboard shortcuts -*None* +* Windows & Linux: `Control` `Alt` `0` +* macOS: `Cmd` `Alt` `0` ## Source code [packages/extension-paragraph/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-paragraph/)