Slate

Docs

Slate

API reference for @udecode/slate.

@udecode/slate extends Slate API with generic types.

Editor

Find the corresponding documentation in the Slate docs.

`addMark`

`createPathRef`

`createPointRef`

`createRangeRef`

`deleteBackward`

`deleteForward`

`deleteFragment`

`deleteMerge`

`getAboveNode`

`getEdgePoints`

`getEditorString`

`getEndPoint`

`getFirstNode`

`getFragment`

`getLastNode`

`getLeafNode`

`getLevels`

`getMarks`

`getNextNode`

`getNodeEntries`

`getNodeEntry`

`getParentNode`

`getPath`

`getPathRefs`

`getPoint`

`getPointAfter`

`getPointBefore`

`getPointRefs`

`getPositions`

`getPreviousNode`

`getRange`

`getRangeRefs`

`getStartPoint`

`getVoidNode`

`hasBlocks`

`hasInlines`

`hasTexts`

`index`

`insertBreak`

`insertNode`

`isBlock`

`isEdgePoint`

`isEditor`

`isEditorNormalizing`

`isElementEmpty`

`isEndPoint`

`isInline`

`isStartPoint`

`isVoid`

`normalizeEditor`

`removeEditorMark`

`TEditor`

`unhangRange`

`withoutNormalizing`

Element

Find the corresponding documentation in the Slate docs.

`elementMatches`

`index`

`isElement`

`isElementList`

`TElement`

History

Find the corresponding documentation in the Slate docs.

`isHistoryEditor`

`isHistoryMerging`

`isHistorySaving`

`THistoryEditor`

`withoutMergingHistory`

`withoutSavingHistory`

Node

Find the corresponding documentation in the Slate docs.

`TDescendant`

`getNodeDescendants`

`getNodeLastNode`

`getNodeString`

`getNodeFirstNode`

`hasNode`

`isNode`

`getNodeFragment`

`getNodeLeaf`

`getNodeLevels`

`isNodeList`

`getNodeProps`

`TAncestor`

`getNode`

`getNodeTexts`

`getNodes`

`getNodeChildren`

`getNodeAncestor`

`TNodeEntry`

`TNode`

`nodeMatches`

`getNodeChild`

`getNodeElements`

`getNodeAncestors`

`getNodeDescendant`

`getCommonNode`

`isAncestor`

`hasSingleChild`

`getNodeParent`

Range

Find the corresponding documentation in the Slate docs.

`isCollapsed`

`isExpanded`

Text

Find the corresponding documentation in the Slate docs.

`isText`

`isTextList`

`textEquals`

`textMatches`

`TText`

Transforms

Find the corresponding documentation in the Slate docs.

`moveNodes`

`moveSelection`

`removeNodes`

`select`

`insertText`

`insertNodes`

`deleteText`

`setPoint`

`setNodes`

`unwrapNodes`

`deselect`

`mergeNodes`

`collapseSelection`

`unsetNodes`

`setSelection`

`splitNodes`

`insertFragment`

`wrapNodes`

`liftNodes`

Types

QueryNodeOptions

An interface used to query node entries.

Attributes

Collapse all

A function to filter node entries.

The function should take a node entry as a parameter and return a boolean.

List of types that are valid.

If empty or undefined, all types are allowed.

List of types that are invalid.

Valid path levels.

Paths above this level are invalid.

Plate Utils Slate React