Add deprecated notice

primer · Jul 29, 2024 · 36b8074 · 36b8074
1 parent 3544fe5
commit 36b8074
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/packages/react/src/Autocomplete/Autocomplete.docs.json b/packages/react/src/Autocomplete/Autocomplete.docs.json
@@ -24,7 +24,8 @@
           "name": "openOnFocus",
           "type": "boolean",
           "defaultValue": "false",
-          "description": "Whether the associated autocomplete menu should open on an input focus event"
+          "description": "Whether the associated autocomplete menu should open on an input focus event",
+          "deprecated": true
         }
       ],
       "passthrough": {

diff --git a/packages/react/src/Autocomplete/AutocompleteInput.tsx b/packages/react/src/Autocomplete/AutocompleteInput.tsx
@@ -10,8 +10,11 @@ import useSafeTimeout from '../hooks/useSafeTimeout'
 type InternalAutocompleteInputProps = {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   as?: React.ComponentType<React.PropsWithChildren<any>>
-  // When false, the autocomplete menu will not render either on mouse click or
-  // keyboard focus.
+
+  /**
+   * @deprecated `openOnFocus` is deprecated and will be removed in v38.
+   * When `true`, autocomplete menu will show on focus or click.
+   */
   openOnFocus?: boolean
 }