Custom and Extended Types

packages/slate/src/create-editor.ts

@@ -27,7 +27,7 @@ export const createEditor = (): Editor => {
     marks: null,
     isInline: () => false,
     isVoid: () => false,
-    onChange: () => { },
+    onChange: () => {},
 
     apply: (op: Operation) => {
       for (const ref of Editor.pathRefs(editor)) {
@@ -214,10 +214,10 @@ export const createEditor = (): Editor => {
       const shouldHaveInlines = Editor.isEditor(node)
         ? false
         : Element.isElement(node) &&
-        (editor.isInline(node) ||
-          node.children.length === 0 ||
-          Text.isText(node.children[0]) ||
-          editor.isInline(node.children[0] as Element))
+          (editor.isInline(node) ||
+            node.children.length === 0 ||
+            Text.isText(node.children[0]) ||
+            editor.isInline(node.children[0] as Element))
 
       // Since we'll be applying operations while iterating, keep track of an
       // index that accounts for any added/removed nodes.

packages/slate/src/interfaces/custom-extensions.ts

@@ -5,28 +5,23 @@ import { Descendant } from 'slate';
 import { Descendant } from 'slate';
  * The `CustomExtensions` interface extends types
  */
-import { Descendant } from './node';
+import { Descendant } from './node'
 
 export interface BaseElement {
   children: Descendant[]
 }
 
 // This would be Text as per Slate's definition
-export type BaseText = {
+export interface BaseText {
   text: string
 }
 
 export interface CustomExtensions {
   [key: string]: unknown
 }
 
-
 // prettier-ignore
 export type ExtendedType<K extends string, B> =
   unknown extends CustomExtensions[K]
   ? B
   : B | CustomExtensions[K]
-
-
-
-

packages/slate/src/interfaces/element.ts

@@ -34,8 +34,8 @@ export const Element = {
   },
 
   /**
-  * Check if some props are a partial of element.
-  */
+   * Check if a value is an array of `Element` objects.
+   */
 
   isElementProps(props: any): props is Partial<Element> {
     return !!props.children

packages/slate/src/interfaces/node.ts

@@ -222,7 +222,7 @@ export const Node = {
         }
       }
 
-      delete r.selection
+      if (Editor.isEditor(r)) delete r.selection
     })
 
     return newRoot.children
@@ -354,8 +354,12 @@ export const Node = {
 
   matches(node: Node, props: Partial<Node>): boolean {
     return (
-      (Element.isElement(node) && Element.isElementProps(props) && Element.matches(node, props)) ||
-      (Text.isText(node) && Text.isTextProps(props) && Text.matches(node, props))
+      (Element.isElement(node) &&
+        Element.isElementProps(props) &&
+        Element.matches(node, props)) ||
+      (Text.isText(node) &&
+        Text.isTextProps(props) &&
+        Text.matches(node, props))
     )
   },
 
@@ -468,7 +472,7 @@ export const Node = {
     if (Text.isText(node)) {
       return node.text
     } else {
-      let children = node.children as Array<Descendant>
+      const children = node.children as Array<Descendant>
       return children.map(Node.string).join('')
     }
   },
@@ -477,7 +481,7 @@ export const Node = {
    * Return an iterable of all leaf text nodes in a root node.
    */
 
-  * texts(
+  *texts(
     root: Node,
     options: {
       from?: Path

packages/slate/src/interfaces/text.ts

@@ -1,7 +1,6 @@
 import isPlainObject from 'is-plain-object'
 import { Range } from '..'
-import { BaseText, ExtendedType } from "./custom-extensions"
-
+import { BaseText, ExtendedType } from './custom-extensions'
 
 /**
  * `Text` objects represent the nodes that contain the actual text content of a
@@ -66,8 +65,8 @@ export const Text = {
   },
 
   /**
-  * Check if some props are a partial of element.
-  */
+   * Check if some props are a partial of element.
+   */
 
   isTextProps(props: any): props is Partial<Text> {
     return !!props.children

packages/slate/test/interfaces/CustomExtensions/isElement-true.tsx

@@ -3,18 +3,18 @@ import {
   Element,
   Node,
   CustomExtensions,
-  ExtendedType, Descendant
+  ExtendedType,
+  Descendant,
 } from 'slate'
 
 declare module 'slate' {
   interface CustomExtensions {
     Element:
-    | { type: 'heading'; level: number; children: Descendant[] }
-    | { type: 'list-item'; depth: number; children: Descendant[] }
+      | { type: 'heading'; level: number; children: Descendant[] }
+      | { type: 'list-item'; depth: number; children: Descendant[] }
   }
 }
 
-
 const extension: CustomExtensions = {
   Element: { type: 'heading', level: 5, children: [] },
 }

packages/slate/test/interfaces/CustomExtensions/wrong-type.tsx

@@ -1,20 +1,15 @@
 // show that regular methods that are imported work as expected
-import {
-  CustomExtensions,
-  Element as BaseElement,
-  Node,
-} from 'slate'
+import { CustomExtensions, Element as BaseElement, Node } from 'slate'
 
 declare module 'slate' {
   interface CustomExtensions {
     5: string
   }
 }
 
-
 // if Element does not have a 'children' property, it is not an element
 const extension: CustomExtensions = {
-  5: "I'm a number"
+  5: "I'm a number",
 }
 
 export const input = extension