From 38fe18368fa4d72f2c3ccf4a2f243f2c384e2780 Mon Sep 17 00:00:00 2001
From: Tom Begley <tomcbegley@gmail.com>
Date: Tue, 14 May 2024 21:42:56 +0100
Subject: [PATCH] Add submit_on_enter prop to Textarea (#1036)

* Add submit_on_enter prop to allow user to control submit behaviour

* Add Textarea test
---
 src/components/input/Textarea.js                | 17 +++++++++++++----
 src/components/input/__tests__/Textarea.test.js |  9 +++++++++
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/src/components/input/Textarea.js b/src/components/input/Textarea.js
index c454c19a..6989248a 100644
--- a/src/components/input/Textarea.js
+++ b/src/components/input/Textarea.js
@@ -39,6 +39,7 @@ const Textarea = props => {
     spellcheck,
     tabIndex,
     tabindex,
+    submit_on_enter,
     ...otherProps
   } = props;
   const [valueState, setValueState] = useState(value || '');
@@ -71,7 +72,7 @@ const Textarea = props => {
   };
 
   const onKeyPress = e => {
-    if (setProps && e.key === 'Enter' && !e.shiftKey) {
+    if (submit_on_enter && setProps && e.key === 'Enter' && !e.shiftKey) {
       e.preventDefault(); // don't create newline if submitting
       const payload = {
         n_submit: n_submit + 1,
@@ -404,15 +405,22 @@ Textarea.propTypes = {
   n_blur_timestamp: PropTypes.number,
 
   /**
-   * Number of times the `Enter` key was pressed while the textarea had focus.
+   * Number of times the `Enter` key was pressed while the textarea had focus. Only
+   * updates if submit_on_enter is True.
    */
   n_submit: PropTypes.number,
 
   /**
-   * Last time that `Enter` was pressed.
+   * Last time that `Enter` was pressed. Only updates if submit_on_enter is True.
    */
   n_submit_timestamp: PropTypes.number,
 
+  /**
+   * Whether or not the form should increment the n_submit and n_submit_timestamp props
+   * when enter key is pressed. If True, use shift + enter to create a newline. Default: True
+   */
+  submit_on_enter: PropTypes.bool,
+
   /**
    * An integer that represents the number of times
    * that this element has been clicked on.
@@ -490,7 +498,8 @@ Textarea.defaultProps = {
   debounce: false,
   persisted_props: ['value'],
   persistence_type: 'local',
-  value: ''
+  value: '',
+  submit_on_enter: true
 };
 
 export default Textarea;
diff --git a/src/components/input/__tests__/Textarea.test.js b/src/components/input/__tests__/Textarea.test.js
index ae2fe208..2e6b7030 100644
--- a/src/components/input/__tests__/Textarea.test.js
+++ b/src/components/input/__tests__/Textarea.test.js
@@ -152,6 +152,15 @@ describe('Textarea', () => {
       expect(mockSetProps.mock.calls).toHaveLength(0);
     });
 
+    test("don't increment n_submit if submit_on_enter is false", () => {
+      mockSetProps = jest.fn();
+      const {
+        container: {firstChild: ta}
+      } = render(<Textarea submit_on_enter={false} setProps={mockSetProps} />);
+      fireEvent.keyPress(ta, {key: 'Enter', code: 13, charCode: 13});
+      expect(mockSetProps.mock.calls).toHaveLength(0);
+    });
+
     describe('debounce', () => {
       let textarea, mockSetProps;
       beforeEach(() => {