docs(search): add comments explaining SearchBox.Input.onKeyDown

opengovsg · Sep 2, 2021 · b92f157 · b92f157
1 parent 80e9abf
commit b92f157
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/client/src/components/SearchBox/SearchBox.component.jsx b/client/src/components/SearchBox/SearchBox.component.jsx
@@ -147,10 +147,14 @@ const SearchBox = ({
                         // when selecting option using keyboard
                         // downshift prevents form submission which is used to submit analytics event
                         // detect such event and separately send analytics event
+
                         if (highlightedIndex === null && searchOnEnter) {
+                          // if the user has typed in search and hit enter,
+                          // without selecting any of the SearchItems
                           sendSearchEventToAnalytics(inputValue)
                           handleSubmit(inputValue)
                         } else if (highlightedIndex !== null) {
+                          // otherwise, if the user has selected a specific SearchItem
                           sendSearchEventToAnalytics(inputValue)
                         }
                       }