@portabletext/editor 1.12.3 → 1.13.0

package/lib/index.d.mts

@@ -149,6 +149,11 @@ export declare type BehaviorActionIntend =
         children?: PortableTextTextBlock['children']
       }
     }
+  | {
+      type: 'move block'
+      blockPath: [KeyedSegment]
+      to: [KeyedSegment]
+    }
   | {
       type: 'set block'
       paths: Array<[KeyedSegment]>
@@ -178,6 +183,12 @@ export declare type BehaviorActionIntend =
       type: 'select'
       selection: EditorSelection
     }
+  | {
+      type: 'select previous block'
+    }
+  | {
+      type: 'select next block'
+    }
   | {
       type: 'reselect'
     }
@@ -197,7 +208,13 @@ export declare type BehaviorActionIntendSet<
     event: PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>
   },
   guardResponse: TGuardResponse,
-) => Array<BehaviorActionIntend>
+) => Array<
+  OmitFromUnion<
+    BehaviorActionIntend,
+    'type',
+    'copy' | 'key.down' | 'key.up' | 'paste'
+  >
+>
 
 /**
  * @alpha
@@ -236,6 +253,10 @@ export declare type BehaviorEvent =
         }
       }
     }
+  | {
+      type: 'copy'
+      data: DataTransfer
+    }
   | {
       type: 'decorator.add'
       decorator: string
@@ -272,7 +293,21 @@ export declare type BehaviorEvent =
     }
   | {
       type: 'paste'
-      clipboardData: NonNullable<ClipboardEvent['clipboardData']>
+      data: DataTransfer
+    }
+  | {
+      type: 'key.down'
+      keyboardEvent: Pick<
+        KeyboardEvent,
+        'key' | 'code' | 'altKey' | 'ctrlKey' | 'metaKey' | 'shiftKey'
+      >
+    }
+  | {
+      type: 'key.up'
+      keyboardEvent: Pick<
+        KeyboardEvent,
+        'key' | 'code' | 'altKey' | 'ctrlKey' | 'metaKey' | 'shiftKey'
+      >
     }
 
 /**
@@ -387,6 +422,14 @@ export declare type BlurChange = {
   event: FocusEvent_2<HTMLDivElement, Element>
 }
 
+/**
+ * @alpha
+ */
+export declare type CodeEditorBehaviorsConfig = {
+  moveBlockUpShortcut: string
+  moveBlockDownShortcut: string
+}
+
 /**
  * The editor was either connected or disconnected to the network
  * To show out of sync warnings etc when in collaborative mode.
@@ -405,6 +448,7 @@ export declare const coreBehavior: {
     | 'annotation.add'
     | 'annotation.remove'
     | 'annotation.toggle'
+    | 'copy'
     | 'decorator.add'
     | 'decorator.remove'
     | 'decorator.toggle'
@@ -413,7 +457,9 @@ export declare const coreBehavior: {
     | 'insert soft break'
     | 'insert break'
     | 'insert text'
-    | 'paste',
+    | 'paste'
+    | 'key.down'
+    | 'key.up',
     true
   >
   decorators: {
@@ -422,6 +468,7 @@ export declare const coreBehavior: {
       | 'annotation.add'
       | 'annotation.remove'
       | 'annotation.toggle'
+      | 'copy'
       | 'decorator.add'
       | 'decorator.remove'
       | 'decorator.toggle'
@@ -430,7 +477,9 @@ export declare const coreBehavior: {
       | 'insert soft break'
       | 'insert break'
       | 'insert text'
-      | 'paste',
+      | 'paste'
+      | 'key.down'
+      | 'key.up',
       true
     >
     decoratorRemove: Behavior<
@@ -438,6 +487,7 @@ export declare const coreBehavior: {
       | 'annotation.add'
       | 'annotation.remove'
       | 'annotation.toggle'
+      | 'copy'
       | 'decorator.add'
       | 'decorator.remove'
       | 'decorator.toggle'
@@ -446,7 +496,9 @@ export declare const coreBehavior: {
       | 'insert soft break'
       | 'insert break'
       | 'insert text'
-      | 'paste',
+      | 'paste'
+      | 'key.down'
+      | 'key.up',
       true
     >
     decoratorToggle: Behavior<
@@ -454,6 +506,7 @@ export declare const coreBehavior: {
       | 'annotation.add'
       | 'annotation.remove'
       | 'annotation.toggle'
+      | 'copy'
       | 'decorator.add'
       | 'decorator.remove'
       | 'decorator.toggle'
@@ -462,16 +515,57 @@ export declare const coreBehavior: {
       | 'insert soft break'
       | 'insert break'
       | 'insert text'
-      | 'paste',
+      | 'paste'
+      | 'key.down'
+      | 'key.up',
       true
     >
   }
   blockObjects: {
+    arrowDownOnLonelyBlockObject: Behavior<
+      | 'focus'
+      | 'annotation.add'
+      | 'annotation.remove'
+      | 'annotation.toggle'
+      | 'copy'
+      | 'decorator.add'
+      | 'decorator.remove'
+      | 'decorator.toggle'
+      | 'delete backward'
+      | 'delete forward'
+      | 'insert soft break'
+      | 'insert break'
+      | 'insert text'
+      | 'paste'
+      | 'key.down'
+      | 'key.up',
+      true
+    >
+    arrowUpOnLonelyBlockObject: Behavior<
+      | 'focus'
+      | 'annotation.add'
+      | 'annotation.remove'
+      | 'annotation.toggle'
+      | 'copy'
+      | 'decorator.add'
+      | 'decorator.remove'
+      | 'decorator.toggle'
+      | 'delete backward'
+      | 'delete forward'
+      | 'insert soft break'
+      | 'insert break'
+      | 'insert text'
+      | 'paste'
+      | 'key.down'
+      | 'key.up',
+      true
+    >
     breakingBlockObject: Behavior<
       | 'focus'
       | 'annotation.add'
       | 'annotation.remove'
       | 'annotation.toggle'
+      | 'copy'
       | 'decorator.add'
       | 'decorator.remove'
       | 'decorator.toggle'
@@ -480,7 +574,9 @@ export declare const coreBehavior: {
       | 'insert soft break'
       | 'insert break'
       | 'insert text'
-      | 'paste',
+      | 'paste'
+      | 'key.down'
+      | 'key.up',
       true
     >
     deletingEmptyTextBlockAfterBlockObject: Behavior<
@@ -488,6 +584,7 @@ export declare const coreBehavior: {
       | 'annotation.add'
       | 'annotation.remove'
       | 'annotation.toggle'
+      | 'copy'
       | 'decorator.add'
       | 'decorator.remove'
       | 'decorator.toggle'
@@ -496,7 +593,9 @@ export declare const coreBehavior: {
       | 'insert soft break'
       | 'insert break'
       | 'insert text'
-      | 'paste',
+      | 'paste'
+      | 'key.down'
+      | 'key.up',
       true
     >
     deletingEmptyTextBlockBeforeBlockObject: Behavior<
@@ -504,6 +603,7 @@ export declare const coreBehavior: {
       | 'annotation.add'
       | 'annotation.remove'
       | 'annotation.toggle'
+      | 'copy'
       | 'decorator.add'
       | 'decorator.remove'
       | 'decorator.toggle'
@@ -512,7 +612,9 @@ export declare const coreBehavior: {
       | 'insert soft break'
       | 'insert break'
       | 'insert text'
-      | 'paste',
+      | 'paste'
+      | 'key.down'
+      | 'key.up',
       true
     >
   }
@@ -522,6 +624,7 @@ export declare const coreBehavior: {
       | 'annotation.add'
       | 'annotation.remove'
       | 'annotation.toggle'
+      | 'copy'
       | 'decorator.add'
       | 'decorator.remove'
       | 'decorator.toggle'
@@ -530,7 +633,9 @@ export declare const coreBehavior: {
       | 'insert soft break'
       | 'insert break'
       | 'insert text'
-      | 'paste',
+      | 'paste'
+      | 'key.down'
+      | 'key.up',
       true
     >
     unindentListOnBackspace: Behavior<
@@ -538,6 +643,7 @@ export declare const coreBehavior: {
       | 'annotation.add'
       | 'annotation.remove'
       | 'annotation.toggle'
+      | 'copy'
       | 'decorator.add'
       | 'decorator.remove'
       | 'decorator.toggle'
@@ -546,7 +652,9 @@ export declare const coreBehavior: {
       | 'insert soft break'
       | 'insert break'
       | 'insert text'
-      | 'paste',
+      | 'paste'
+      | 'key.down'
+      | 'key.up',
       true
     >
   }
@@ -560,6 +668,32 @@ export declare const coreBehaviors: Behavior<
   | 'annotation.add'
   | 'annotation.remove'
   | 'annotation.toggle'
+  | 'copy'
+  | 'decorator.add'
+  | 'decorator.remove'
+  | 'decorator.toggle'
+  | 'delete backward'
+  | 'delete forward'
+  | 'insert soft break'
+  | 'insert break'
+  | 'insert text'
+  | 'paste'
+  | 'key.down'
+  | 'key.up',
+  true
+>[]
+
+/**
+ * @alpha
+ */
+export declare function createCodeEditorBehaviors(
+  config: CodeEditorBehaviorsConfig,
+): Behavior<
+  | 'focus'
+  | 'annotation.add'
+  | 'annotation.remove'
+  | 'annotation.toggle'
+  | 'copy'
   | 'decorator.add'
   | 'decorator.remove'
   | 'decorator.toggle'
@@ -568,7 +702,9 @@ export declare const coreBehaviors: Behavior<
   | 'insert soft break'
   | 'insert break'
   | 'insert text'
-  | 'paste',
+  | 'paste'
+  | 'key.down'
+  | 'key.up',
   true
 >[]
 
@@ -582,6 +718,7 @@ export declare function createLinkBehaviors(
   | 'annotation.add'
   | 'annotation.remove'
   | 'annotation.toggle'
+  | 'copy'
   | 'decorator.add'
   | 'decorator.remove'
   | 'decorator.toggle'
@@ -590,7 +727,9 @@ export declare function createLinkBehaviors(
   | 'insert soft break'
   | 'insert break'
   | 'insert text'
-  | 'paste',
+  | 'paste'
+  | 'key.down'
+  | 'key.up',
   true
 >[]
 
@@ -604,6 +743,7 @@ export declare function createMarkdownBehaviors(
   | 'annotation.add'
   | 'annotation.remove'
   | 'annotation.toggle'
+  | 'copy'
   | 'decorator.add'
   | 'decorator.remove'
   | 'decorator.toggle'
@@ -612,7 +752,9 @@ export declare function createMarkdownBehaviors(
   | 'insert soft break'
   | 'insert break'
   | 'insert text'
-  | 'paste',
+  | 'paste'
+  | 'key.down'
+  | 'key.up',
   true
 >[]
 
@@ -875,6 +1017,9 @@ export declare const editorMachine: StateMachine<
       type: 'behavior event'
       behaviorEvent: BehaviorEvent
       editor: PortableTextSlateEditor
+      nativeEvent?: {
+        preventDefault: () => void
+      }
     }
   | {
       type: 'behavior action intends'
@@ -1148,6 +1293,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -1260,6 +1408,9 @@ export declare const editorMachine: StateMachine<
             type: 'behavior event'
             behaviorEvent: BehaviorEvent
             editor: PortableTextSlateEditor
+            nativeEvent?: {
+              preventDefault: () => void
+            }
           }
         | {
             type: 'behavior action intends'
@@ -1397,6 +1548,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -1622,6 +1776,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -1847,6 +2004,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -2069,6 +2229,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -2285,6 +2448,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -2486,6 +2652,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -2687,6 +2856,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -2889,6 +3061,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -3092,6 +3267,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -3293,6 +3471,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -3494,6 +3675,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -3695,6 +3879,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -3895,6 +4082,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -4093,6 +4283,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -4293,6 +4486,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -4500,6 +4696,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -4628,6 +4827,9 @@ export declare const editorMachine: StateMachine<
                 type: 'behavior event'
                 behaviorEvent: BehaviorEvent
                 editor: PortableTextSlateEditor
+                nativeEvent?: {
+                  preventDefault: () => void
+                }
               }
             | {
                 type: 'behavior action intends'
@@ -4753,6 +4955,9 @@ export declare const editorMachine: StateMachine<
                 type: 'behavior event'
                 behaviorEvent: BehaviorEvent
                 editor: PortableTextSlateEditor
+                nativeEvent?: {
+                  preventDefault: () => void
+                }
               }
             | {
                 type: 'behavior action intends'
@@ -4955,6 +5160,9 @@ export declare const editorMachine: StateMachine<
               type: 'behavior event'
               behaviorEvent: BehaviorEvent
               editor: PortableTextSlateEditor
+              nativeEvent?: {
+                preventDefault: () => void
+              }
             }
           | {
               type: 'behavior action intends'
@@ -5047,6 +5255,9 @@ export declare const editorMachine: StateMachine<
             type: 'behavior event'
             behaviorEvent: BehaviorEvent
             editor: PortableTextSlateEditor
+            nativeEvent?: {
+              preventDefault: () => void
+            }
           }
         >) => boolean
       }
@@ -5109,6 +5320,9 @@ export declare const editorMachine: StateMachine<
                 type: 'behavior event'
                 behaviorEvent: BehaviorEvent
                 editor: PortableTextSlateEditor
+                nativeEvent?: {
+                  preventDefault: () => void
+                }
               }
             | {
                 type: 'behavior action intends'
@@ -5230,6 +5444,9 @@ export declare const editorMachine: StateMachine<
                 type: 'behavior event'
                 behaviorEvent: BehaviorEvent
                 editor: PortableTextSlateEditor
+                nativeEvent?: {
+                  preventDefault: () => void
+                }
               }
             | {
                 type: 'behavior action intends'
@@ -5610,6 +5827,9 @@ export declare type InternalEditorEvent =
       type: 'behavior event'
       behaviorEvent: BehaviorEvent
       editor: PortableTextSlateEditor
+      nativeEvent?: {
+        preventDefault: () => void
+      }
     }
   | {
       type: 'behavior action intends'