From 570e67b085e5c1c97a6febc1305b7d886003f982 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20Ku=CC=88hn?= Date: Thu, 24 Sep 2020 22:27:17 +0200 Subject: [PATCH] rename toggleNode to toggleBlockType --- docs/src/docPages/api/commands.md | 2 +- .../src/docPages/guide/custom-extensions/change-defaults.md | 2 +- packages/core/src/commands/index.ts | 2 +- .../core/src/commands/{toggleNode.ts => toggleBlockType.ts} | 6 +++--- packages/extension-blockquote/index.ts | 2 +- packages/extension-code-block/index.ts | 2 +- packages/extension-heading/index.ts | 2 +- packages/extension-paragraph/index.ts | 2 +- 8 files changed, 10 insertions(+), 10 deletions(-) rename packages/core/src/commands/{toggleNode.ts => toggleBlockType.ts} (76%) diff --git a/docs/src/docPages/api/commands.md b/docs/src/docPages/api/commands.md index 0fd3564e..09b51714 100644 --- a/docs/src/docPages/api/commands.md +++ b/docs/src/docPages/api/commands.md @@ -24,7 +24,7 @@ editor.chain().focus().bold().run() | .replaceWithNode() | Replace a given range with a node. | | .selectParentNode() | Select the parent node. | | .toggleMark() | Toggle a mark on and off. | -| .toggleNode() | Toggle a node with another node. | +| .toggleBlockType() | Toggle a node with another node. | | .updateMark() | Update a mark with new attributes. | ### Selection diff --git a/docs/src/docPages/guide/custom-extensions/change-defaults.md b/docs/src/docPages/guide/custom-extensions/change-defaults.md index 03073cda..79c1271b 100644 --- a/docs/src/docPages/guide/custom-extensions/change-defaults.md +++ b/docs/src/docPages/guide/custom-extensions/change-defaults.md @@ -47,7 +47,7 @@ import Paragraph from '@tiptap/extension-paragraph' const CustomParagraph = Paragraph() .commands(() => ({ paragraph: () => ({ commands }) => { - return commands.toggleNode(name, 'paragraph') + return commands.toggleBlockType(name, 'paragraph') }, })) .create() diff --git a/packages/core/src/commands/index.ts b/packages/core/src/commands/index.ts index 90def10d..19a6bd1c 100644 --- a/packages/core/src/commands/index.ts +++ b/packages/core/src/commands/index.ts @@ -14,7 +14,7 @@ export { selectParentNode } from './selectParentNode' export { setContent } from './setContent' export { sinkListItem } from './sinkListItem' export { splitListItem } from './splitListItem' +export { toggleBlockType } from './toggleBlockType' export { toggleList } from './toggleList' export { toggleMark } from './toggleMark' -export { toggleNode } from './toggleNode' export { updateMark } from './updateMark' diff --git a/packages/core/src/commands/toggleNode.ts b/packages/core/src/commands/toggleBlockType.ts similarity index 76% rename from packages/core/src/commands/toggleNode.ts rename to packages/core/src/commands/toggleBlockType.ts index 17c36faf..e6da0b06 100644 --- a/packages/core/src/commands/toggleNode.ts +++ b/packages/core/src/commands/toggleBlockType.ts @@ -4,7 +4,7 @@ import { Command } from '../Editor' import nodeIsActive from '../utils/nodeIsActive' import getNodeType from '../utils/getNodeType' -type ToggleNodeCommand = ( +type ToggleBlockTypeCommand = ( typeOrName: string | NodeType, toggleType: string | NodeType, attrs?: {} @@ -12,11 +12,11 @@ type ToggleNodeCommand = ( declare module '../Editor' { interface Commands { - toggleNode: ToggleNodeCommand, + toggleBlockType: ToggleBlockTypeCommand, } } -export const toggleNode: ToggleNodeCommand = (typeOrName, toggleTypeOrName, attrs = {}) => ({ state, dispatch }) => { +export const toggleBlockType: ToggleBlockTypeCommand = (typeOrName, toggleTypeOrName, attrs = {}) => ({ state, dispatch }) => { const type = getNodeType(typeOrName, state.schema) const toggleType = getNodeType(toggleTypeOrName, state.schema) const isActive = nodeIsActive(state, type, attrs) diff --git a/packages/extension-blockquote/index.ts b/packages/extension-blockquote/index.ts index d5d09f77..851317a5 100644 --- a/packages/extension-blockquote/index.ts +++ b/packages/extension-blockquote/index.ts @@ -25,7 +25,7 @@ export default new Node() })) .commands(({ name }) => ({ [name]: attrs => ({ commands }) => { - return commands.toggleNode(name, 'paragraph', attrs) + return commands.toggleBlockType(name, 'paragraph', attrs) }, })) .keys(({ editor }) => ({ diff --git a/packages/extension-code-block/index.ts b/packages/extension-code-block/index.ts index 87e388ab..c91740e1 100644 --- a/packages/extension-code-block/index.ts +++ b/packages/extension-code-block/index.ts @@ -25,7 +25,7 @@ export default new Node() })) .commands(({ name }) => ({ codeBlock: attrs => ({ commands }) => { - return commands.toggleNode(name, 'paragraph', attrs) + return commands.toggleBlockType(name, 'paragraph', attrs) }, })) .keys(({ editor }) => ({ diff --git a/packages/extension-heading/index.ts b/packages/extension-heading/index.ts index 82749be9..39de576a 100644 --- a/packages/extension-heading/index.ts +++ b/packages/extension-heading/index.ts @@ -39,7 +39,7 @@ export default new Node() })) .commands(({ name }) => ({ [name]: attrs => ({ commands }) => { - return commands.toggleNode(name, 'paragraph', attrs) + return commands.toggleBlockType(name, 'paragraph', attrs) }, })) // TODO: Keyboard Shortcuts diff --git a/packages/extension-paragraph/index.ts b/packages/extension-paragraph/index.ts index b32f1386..b71a8133 100644 --- a/packages/extension-paragraph/index.ts +++ b/packages/extension-paragraph/index.ts @@ -20,7 +20,7 @@ export default new Node() })) .commands(({ name }) => ({ [name]: () => ({ commands }) => { - return commands.toggleNode(name, 'paragraph') + return commands.toggleBlockType(name, 'paragraph') }, })) .keys(({ editor }) => ({