ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

add missing comman descriptions

Browse Source
This commit is contained in:
Hans Pagel
2020-11-05 21:25:03 +01:00
parent 5a9894aa5c
commit a74453f96c
1 changed files with 23 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/src/docPages/api/commands.md
View File

@@ -70,31 +70,27 @@ Have a look at all of the core commands listed below. They should give you a goo
### Content ### Content
| Command | Description | | Command | Description |
| ---------------- | ----------------------------------------------------------- | | --------------- | ------------------------------------------------ |
| .clearContent() | Clear the whole document. | | .clearContent() | Clear the whole document. |
| .insertgetHTML() | Insert a string of HTML at the currently selected position. | | .insertHTML() | Insert a string of HTML at the current position. |
| .insertText() | Insert a string of text at the currently selected position. | | .insertText() | Insert a string of text at the current position. |
| .insertHTML() | |
| .setContent() | Replace the whole document with new content. | | .setContent() | Replace the whole document with new content. |
### Nodes & Marks ### Nodes & Marks
| Command | Description | | Command | Description |
| ---------------------- | ------------------------------------------ | | ---------------------- | --------------------------------------------------------- |
| .clearNodes() | | | .clearNodes() | Normalize nodes to a simple paragraph. |
| .removeMark() | |
| .removeMark() | Remove a mark in the current selection. | | .removeMark() | Remove a mark in the current selection. |
| .removeMarks() | |
| .removeMarks() | Remove all marks in the current selection. | | .removeMarks() | Remove all marks in the current selection. |
| .resetNodeAttributes() | | | .removeMarks() | Remove all marks in the current selection. |
| .resetNodeAttributes() | Resets all node attributes to the default value. |
| .selectParentNode() | Select the parent node. | | .selectParentNode() | Select the parent node. |
| .setBlockType() | Replace a given range with a node. | | .setBlockType() | Replace a given range with a node. |
| .setNodeAttributes() | | | .setNodeAttributes() | Update attributes of a node. |
| .splitBlock() | Forks a new node from an existing node. | | .splitBlock() | Forks a new node from an existing node. |
| .toggleBlockType() | Toggle a node with another node. | | .toggleBlockType() | Toggle a node with another node. |
| .toggleMark() | |
| .toggleMark() | Toggle a mark on and off. | | .toggleMark() | Toggle a mark on and off. |
| .toggleWrap() | | | .toggleWrap() | Wraps nodes in another node, or removes an existing wrap. |
| .updateMark() | |
| .updateMark() | Update a mark with new attributes. | | .updateMark() | Update a mark with new attributes. |
### Lists ### Lists
@@ -103,8 +99,8 @@ Have a look at all of the core commands listed below. They should give you a goo
| .liftListItem() | Lift the list item into a wrapping list. | | .liftListItem() | Lift the list item into a wrapping list. |
| .sinkListItem() | Sink the list item down into an inner list. | | .sinkListItem() | Sink the list item down into an inner list. |
| .splitListItem() | Splits a textblock of a list item into two list items. | | .splitListItem() | Splits a textblock of a list item into two list items. |
| .toggleList() | Toggle between different list styles. | | .toggleList() | Toggle between different list types. |
| .wrapInList() | | | .wrapInList() | Wrap a node in a list. |
### Selection ### Selection
| Command | Description | | Command | Description |