[Part 2] Pass fresh editorState to edit handlers (facebookarchive#1113)

flarnie · web-flow · commit 6f2bf66bacff · 2017-03-31T12:39:34.000-07:00
I had mirrored parts of this change from FB to github but missed some things. This is the second part of the same change - context below. Earlier part merged as facebookarchive#1112 --- There have been bugs reported in cases where the users of Draft are updating 'editorState' in their custom handlers for keyDown, paste, etc. This can be a problem when they are using an 'editorState' that is in the parent's props or state and is not in sync, at that moment, with the editorState in Draft. This allows the parent to use the most updated editorState in custom handlers. This change was already reviewed by @spicyj and credit for this fix goes to @AlaNouri for making this change.
diff --git a/src/component/base/DraftEditorProps.js b/src/component/base/DraftEditorProps.js
@@ -107,7 +107,10 @@ export type DraftEditorProps = {
 
   // Useful for managing special behavior for pressing the `Return` key. E.g.
   // removing the style from an empty list item.
-  handleReturn?: (e: SyntheticKeyboardEvent) => DraftHandleValue,
+  handleReturn?: (
+    e: SyntheticKeyboardEvent,
+    editorState: EditorState,
+  ) => DraftHandleValue,
 
   // Map a key command string provided by your key binding function to a
   // specified behavior.
@@ -121,9 +124,16 @@ export type DraftEditorProps = {
   // to trigger some special behavior. E.g. immediately converting `:)` to an
   // emoji Unicode character, or replacing ASCII quote characters with smart
   // quotes.
-  handleBeforeInput?: (chars: string) => DraftHandleValue,
+  handleBeforeInput?: (
+    chars: string,
+    editorState: EditorState,
+  ) => DraftHandleValue,
 
-  handlePastedText?: (text: string, html?: string) => DraftHandleValue,
+  handlePastedText?: (
+    text: string,
+    html?: string,
+    editorState: EditorState,
+  ) => DraftHandleValue,
 
   handlePastedFiles?: (files: Array<Blob>) => DraftHandleValue,
 
diff --git a/src/component/handlers/edit/editOnBeforeInput.js b/src/component/handlers/edit/editOnBeforeInput.js
@@ -81,7 +81,7 @@ function editOnBeforeInput(editor: DraftEditor, e: SyntheticInputEvent): void {
     editor._pendingStateFromBeforeInput = undefined;
   }
 
-  var editorState = editor._latestEditorState;
+  const editorState = editor._latestEditorState;
 
   var chars = e.data;
 
diff --git a/src/component/handlers/edit/editOnKeyDown.js b/src/component/handlers/edit/editOnKeyDown.js
@@ -94,7 +94,7 @@ function editOnKeyDown(editor: DraftEditor, e: SyntheticKeyboardEvent): void {
       // no special handling is performed, fall through to command handling.
       if (
         editor.props.handleReturn &&
-        isEventHandled(editor.props.handleReturn(e))
+        isEventHandled(editor.props.handleReturn(e, editorState))
       ) {
         return;
       }

Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ function editOnBeforeInput(editor: DraftEditor, e: SyntheticInputEvent): void {`
`81`	`81`	`editor._pendingStateFromBeforeInput = undefined;`
`82`	`82`	`}`
`83`	`83`
`84`		`- var editorState = editor._latestEditorState;`
	`84`	`+ const editorState = editor._latestEditorState;`
`85`	`85`
`86`	`86`	`var chars = e.data;`
`87`	`87`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ function editOnKeyDown(editor: DraftEditor, e: SyntheticKeyboardEvent): void {`
`94`	`94`	`// no special handling is performed, fall through to command handling.`
`95`	`95`	`if (`
`96`	`96`	`editor.props.handleReturn &&`
`97`		`- isEventHandled(editor.props.handleReturn(e))`
	`97`	`+ isEventHandled(editor.props.handleReturn(e, editorState))`
`98`	`98`	`) {`
`99`	`99`	`return;`
`100`	`100`	`}`