docs(inputsearch): add comments for context

chanzuckerberg · Sep 21, 2023 · cbfab43 · cbfab43
1 parent d1dcf20
commit cbfab43
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/packages/components/src/core/Autocomplete/index.tsx b/packages/components/src/core/Autocomplete/index.tsx
@@ -148,6 +148,10 @@ const Autocomplete = <
               ...params.InputProps.ref,
               endAdornment: (
                 <StyledInputAdornment position="end">
+                  {/**
+                   * (masoudmansdon): Because the Autocomplete component overrides the
+                   * InputSearch's endAdornment, we must also include the clear IconButton here.
+                   */}
                   {inputValue && (
                     <ButtonIcon
                       aria-label="clear-button"
@@ -209,6 +213,10 @@ const Autocomplete = <
 
   function clearInput() {
     setInputValue("");
+    /**
+     * (masoudmanson): Because we are manually firing this event,
+     * we must build a onChange event to transmit the updated value to onChange listeners.
+     */
     if (onInputChange)
       onInputChange(
         { target: { value: "" } } as React.ChangeEvent<HTMLInputElement>,

diff --git a/packages/components/src/core/InputSearch/index.tsx b/packages/components/src/core/InputSearch/index.tsx
@@ -58,6 +58,10 @@ const InputSearch = forwardRef<HTMLDivElement, InputSearchProps>(
 
       if (handleSubmit) handleSubmit("");
 
+      /**
+       * (masoudmanson): Because we are manually firing this event,
+       * we must build a onChange event to transmit the updated value to onChange listeners.
+       */
       if (onChange) {
         onChange({
           target: { value: "" },
@@ -130,6 +134,10 @@ const InputSearch = forwardRef<HTMLDivElement, InputSearchProps>(
           onChange={handleChange}
           onKeyDown={handleKeyPress}
           intent={intent}
+          /**
+           * (masoudmanson): This prevents the browser's default auto completion
+           * menu from being displayed for the InputSearch.
+           */
           autoComplete="off"
           {...rest}
         />