From 0e18e67c93e23d7e421e0142781a49260e9180c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20Ku=CC=88hn?= Date: Wed, 22 Apr 2020 09:23:53 +0200 Subject: [PATCH] add list of current commands --- docs/src/data/posts/commands.md | 34 ++++++++++++++++++- packages/core/src/Editor.ts | 2 +- .../{toggleBlockType.ts => toggleNode.ts} | 6 ++-- packages/extension-heading/index.ts | 2 +- 4 files changed, 38 insertions(+), 6 deletions(-) rename packages/core/src/commands/{toggleBlockType.ts => toggleNode.ts} (80%) diff --git a/docs/src/data/posts/commands.md b/docs/src/data/posts/commands.md index e6827429..7f8f6531 100644 --- a/docs/src/data/posts/commands.md +++ b/docs/src/data/posts/commands.md @@ -1 +1,33 @@ -# Commands \ No newline at end of file +# Commands + +## .clearContent() + +Clear the whole document. + +## .focus() + +Focus the editor at the given position. + +## .insertHTML() + +Insert a string of HTML at the currently selected position. + +## .insertText() + +Insert a string of text at the currently selected position. + +## .removeMarks() + +Remove all marks in the current selection. + +## .selectAll() + +Select the whole document. + +## .setContent() + +Replace the whole document with new content. + +## .toggleNode() + +Toggle a node with another node. \ No newline at end of file diff --git a/packages/core/src/Editor.ts b/packages/core/src/Editor.ts index 584ea9b5..8b2a3005 100644 --- a/packages/core/src/Editor.ts +++ b/packages/core/src/Editor.ts @@ -71,7 +71,7 @@ export class Editor extends EventEmitter { this.registerCommand('setContent', require('./commands/setContent').default) this.registerCommand('clearContent', require('./commands/clearContent').default) this.registerCommand('removeMarks', require('./commands/removeMarks').default) - this.registerCommand('toggleBlockType', require('./commands/toggleBlockType').default) + this.registerCommand('toggleNode', require('./commands/toggleNode').default) this.registerCommand('selectAll', require('./commands/selectAll').default) if (this.options.injectCSS) { diff --git a/packages/core/src/commands/toggleBlockType.ts b/packages/core/src/commands/toggleNode.ts similarity index 80% rename from packages/core/src/commands/toggleBlockType.ts rename to packages/core/src/commands/toggleNode.ts index fdbc2015..32ab13d0 100644 --- a/packages/core/src/commands/toggleBlockType.ts +++ b/packages/core/src/commands/toggleNode.ts @@ -4,7 +4,7 @@ import { Editor } from '../Editor' import nodeIsActive from '../utils/nodeIsActive' import getNodeType from '../utils/getNodeType' -type ToggleBlockType = ( +type ToggleNode = ( type: string | NodeType, toggleType: string | NodeType, attrs?: {} @@ -12,11 +12,11 @@ type ToggleBlockType = ( declare module '../Editor' { interface Editor { - toggleBlockType: ToggleBlockType, + toggleNode: ToggleNode, } } -export default (next: Function, editor: Editor): ToggleBlockType => (typeOrName, toggleTypeOrName, attrs) => { +export default (next: Function, editor: Editor): ToggleNode => (typeOrName, toggleTypeOrName, attrs) => { const { view, state, schema } = editor const type = getNodeType(typeOrName, schema) const toggleType = getNodeType(toggleTypeOrName, schema) diff --git a/packages/extension-heading/index.ts b/packages/extension-heading/index.ts index 8471a7b6..c8d72ea1 100644 --- a/packages/extension-heading/index.ts +++ b/packages/extension-heading/index.ts @@ -48,7 +48,7 @@ export default class Heading extends Node { commands(): CommandSpec { return { heading: next => attrs => { - this.editor.toggleBlockType(this.name, 'paragraph', attrs) + this.editor.toggleNode(this.name, 'paragraph', attrs) next() }, }