BookStack Code Mirror - bookstack/blob - resources/js/wysiwyg/lexical/core/LexicalCommands.ts

   1 /**
   2  * Copyright (c) Meta Platforms, Inc. and affiliates.
   3  *
   4  * This source code is licensed under the MIT license found in the
   5  * LICENSE file in the root directory of this source tree.
   6  *
   7  */
   8
   9 import type {
  10   BaseSelection,
  11   LexicalCommand,
  12   LexicalNode,
  13   TextFormatType,
  14 } from 'lexical';
  15
  16 export type PasteCommandType = ClipboardEvent | InputEvent | KeyboardEvent;
  17
  18 export function createCommand<T>(type?: string): LexicalCommand<T> {
  19   return __DEV__ ? {type} : {};
  20 }
  21
  22 export const SELECTION_CHANGE_COMMAND: LexicalCommand<void> = createCommand(
  23   'SELECTION_CHANGE_COMMAND',
  24 );
  25 export const SELECTION_INSERT_CLIPBOARD_NODES_COMMAND: LexicalCommand<{
  26   nodes: Array<LexicalNode>;
  27   selection: BaseSelection;
  28 }> = createCommand('SELECTION_INSERT_CLIPBOARD_NODES_COMMAND');
  29 export const CLICK_COMMAND: LexicalCommand<MouseEvent> =
  30   createCommand('CLICK_COMMAND');
  31 export const DELETE_CHARACTER_COMMAND: LexicalCommand<boolean> = createCommand(
  32   'DELETE_CHARACTER_COMMAND',
  33 );
  34 export const INSERT_LINE_BREAK_COMMAND: LexicalCommand<boolean> = createCommand(
  35   'INSERT_LINE_BREAK_COMMAND',
  36 );
  37 export const INSERT_PARAGRAPH_COMMAND: LexicalCommand<void> = createCommand(
  38   'INSERT_PARAGRAPH_COMMAND',
  39 );
  40 export const CONTROLLED_TEXT_INSERTION_COMMAND: LexicalCommand<
  41   InputEvent | string
  42 > = createCommand('CONTROLLED_TEXT_INSERTION_COMMAND');
  43 export const PASTE_COMMAND: LexicalCommand<PasteCommandType> =
  44   createCommand('PASTE_COMMAND');
  45 export const REMOVE_TEXT_COMMAND: LexicalCommand<InputEvent | null> =
  46   createCommand('REMOVE_TEXT_COMMAND');
  47 export const DELETE_WORD_COMMAND: LexicalCommand<boolean> = createCommand(
  48   'DELETE_WORD_COMMAND',
  49 );
  50 export const DELETE_LINE_COMMAND: LexicalCommand<boolean> = createCommand(
  51   'DELETE_LINE_COMMAND',
  52 );
  53 export const FORMAT_TEXT_COMMAND: LexicalCommand<TextFormatType> =
  54   createCommand('FORMAT_TEXT_COMMAND');
  55 export const UNDO_COMMAND: LexicalCommand<void> = createCommand('UNDO_COMMAND');
  56 export const REDO_COMMAND: LexicalCommand<void> = createCommand('REDO_COMMAND');
  57 export const KEY_DOWN_COMMAND: LexicalCommand<KeyboardEvent> =
  58   createCommand('KEYDOWN_COMMAND');
  59 export const KEY_ARROW_RIGHT_COMMAND: LexicalCommand<KeyboardEvent> =
  60   createCommand('KEY_ARROW_RIGHT_COMMAND');
  61 export const MOVE_TO_END: LexicalCommand<KeyboardEvent> =
  62   createCommand('MOVE_TO_END');
  63 export const KEY_ARROW_LEFT_COMMAND: LexicalCommand<KeyboardEvent> =
  64   createCommand('KEY_ARROW_LEFT_COMMAND');
  65 export const MOVE_TO_START: LexicalCommand<KeyboardEvent> =
  66   createCommand('MOVE_TO_START');
  67 export const KEY_ARROW_UP_COMMAND: LexicalCommand<KeyboardEvent> =
  68   createCommand('KEY_ARROW_UP_COMMAND');
  69 export const KEY_ARROW_DOWN_COMMAND: LexicalCommand<KeyboardEvent> =
  70   createCommand('KEY_ARROW_DOWN_COMMAND');
  71 export const KEY_ENTER_COMMAND: LexicalCommand<KeyboardEvent | null> =
  72   createCommand('KEY_ENTER_COMMAND');
  73 export const KEY_SPACE_COMMAND: LexicalCommand<KeyboardEvent> =
  74   createCommand('KEY_SPACE_COMMAND');
  75 export const KEY_BACKSPACE_COMMAND: LexicalCommand<KeyboardEvent> =
  76   createCommand('KEY_BACKSPACE_COMMAND');
  77 export const KEY_ESCAPE_COMMAND: LexicalCommand<KeyboardEvent> =
  78   createCommand('KEY_ESCAPE_COMMAND');
  79 export const KEY_DELETE_COMMAND: LexicalCommand<KeyboardEvent> =
  80   createCommand('KEY_DELETE_COMMAND');
  81 export const KEY_TAB_COMMAND: LexicalCommand<KeyboardEvent> =
  82   createCommand('KEY_TAB_COMMAND');
  83 export const INSERT_TAB_COMMAND: LexicalCommand<void> =
  84   createCommand('INSERT_TAB_COMMAND');
  85 export const INDENT_CONTENT_COMMAND: LexicalCommand<void> = createCommand(
  86   'INDENT_CONTENT_COMMAND',
  87 );
  88 export const OUTDENT_CONTENT_COMMAND: LexicalCommand<void> = createCommand(
  89   'OUTDENT_CONTENT_COMMAND',
  90 );
  91 export const DROP_COMMAND: LexicalCommand<DragEvent> =
  92   createCommand('DROP_COMMAND');
  93 export const DRAGSTART_COMMAND: LexicalCommand<DragEvent> =
  94   createCommand('DRAGSTART_COMMAND');
  95 export const DRAGOVER_COMMAND: LexicalCommand<DragEvent> =
  96   createCommand('DRAGOVER_COMMAND');
  97 export const DRAGEND_COMMAND: LexicalCommand<DragEvent> =
  98   createCommand('DRAGEND_COMMAND');
  99 export const COPY_COMMAND: LexicalCommand<
 100   ClipboardEvent | KeyboardEvent | null
 101 > = createCommand('COPY_COMMAND');
 102 export const CUT_COMMAND: LexicalCommand<
 103   ClipboardEvent | KeyboardEvent | null
 104 > = createCommand('CUT_COMMAND');
 105 export const SELECT_ALL_COMMAND: LexicalCommand<KeyboardEvent> =
 106   createCommand('SELECT_ALL_COMMAND');
 107 export const CLEAR_EDITOR_COMMAND: LexicalCommand<void> = createCommand(
 108   'CLEAR_EDITOR_COMMAND',
 109 );
 110 export const CLEAR_HISTORY_COMMAND: LexicalCommand<void> = createCommand(
 111   'CLEAR_HISTORY_COMMAND',
 112 );
 113 export const CAN_REDO_COMMAND: LexicalCommand<boolean> =
 114   createCommand('CAN_REDO_COMMAND');
 115 export const CAN_UNDO_COMMAND: LexicalCommand<boolean> =
 116   createCommand('CAN_UNDO_COMMAND');
 117 export const FOCUS_COMMAND: LexicalCommand<FocusEvent> =
 118   createCommand('FOCUS_COMMAND');
 119 export const BLUR_COMMAND: LexicalCommand<FocusEvent> =
 120   createCommand('BLUR_COMMAND');
 121 export const KEY_MODIFIER_COMMAND: LexicalCommand<KeyboardEvent> =
 122   createCommand('KEY_MODIFIER_COMMAND');