@react-types/autocomplete 3.0.0-alpha.11 → 3.0.0-alpha.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-types/autocomplete",
-  "version": "3.0.0-alpha.11",
+  "version": "3.0.0-alpha.13",
   "description": "Spectrum UI components in React",
   "license": "Apache-2.0",
   "types": "src/index.d.ts",
@@ -9,9 +9,9 @@
     "url": "https://github.com/adobe/react-spectrum"
   },
   "dependencies": {
-    "@react-types/combobox": "^3.5.5",
-    "@react-types/searchfield": "^3.3.6",
-    "@react-types/shared": "^3.16.0"
+    "@react-types/combobox": "^3.6.1",
+    "@react-types/searchfield": "^3.4.1",
+    "@react-types/shared": "^3.18.0"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0"
@@ -19,5 +19,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5480d76bd815e239366f92852c76b6831ad2a4fd"
+  "gitHead": "9d1ba9bd8ebcd63bf3495ade16d349bcb71795ce"
 }

package/src/index.d.ts

@@ -10,12 +10,12 @@
  * governing permissions and limitations under the License.
  */
 
-import {AriaSearchFieldProps} from '@react-types/searchfield';
-import {AsyncLoadable, CollectionBase, LoadingState, SpectrumLabelableProps, SpectrumTextInputBase, StyleProps} from '@react-types/shared';
+import {AriaLabelingProps, AsyncLoadable, CollectionBase, DOMProps, LoadingState, SpectrumLabelableProps, SpectrumTextInputBase, StyleProps} from '@react-types/shared';
 import {Key, ReactElement} from 'react';
 import {MenuTriggerAction} from '@react-types/combobox';
+import {SearchFieldProps} from '@react-types/searchfield';
 
-export interface SearchAutocompleteProps<T> extends CollectionBase<T>, Omit<AriaSearchFieldProps, 'onSubmit'> {
+export interface SearchAutocompleteProps<T> extends CollectionBase<T>, Omit<SearchFieldProps, 'onSubmit' | 'defaultValue' | 'value'> {
   /** The list of SearchAutocomplete items (uncontrolled). */
   defaultItems?: Iterable<T>,
   /** The list of SearchAutocomplete items (controlled). */
@@ -33,12 +33,20 @@ export interface SearchAutocompleteProps<T> extends CollectionBase<T>, Omit<Aria
    * @default 'input'
    */
   menuTrigger?: MenuTriggerAction,
-  onSubmit?: (value: string | null, key: Key | null) => void,
-  /** An icon to display at the start of the input. */
-  icon?: ReactElement | null
+  /** Handler that is called when the SearchAutocomplete is submitted.
+   * 
+   * A `value` will be passed if the submission is a custom value (e.g. a user types then presses enter).
+   * If the input is a selected item, `value` will be null.
+   * 
+   * A `key` will be passed if the submission is a selected item (e.g. a user clicks or presses enter on an option).
+   * If the input is a custom value, `key` will be null.
+   */
+  onSubmit?: (value: string | null, key: Key | null) => void
 }
 
-export interface SpectrumSearchAutocompleteProps<T> extends SpectrumTextInputBase, Omit<SearchAutocompleteProps<T>, 'menuTrigger'>, SpectrumLabelableProps, StyleProps, Omit<AsyncLoadable, 'isLoading'> {
+export interface AriaSearchAutocompleteProps<T> extends SearchAutocompleteProps<T>, DOMProps, AriaLabelingProps {}
+
+export interface SpectrumSearchAutocompleteProps<T> extends SpectrumTextInputBase, Omit<AriaSearchAutocompleteProps<T>, 'menuTrigger'>, SpectrumLabelableProps, StyleProps, Omit<AsyncLoadable, 'isLoading'> {
   /**
    * The interaction required to display the SearchAutocomplete menu. Note that this prop has no effect on the mobile SearchAutocomplete experience.
    * @default 'input'
@@ -58,5 +66,7 @@ export interface SpectrumSearchAutocompleteProps<T> extends SpectrumTextInputBas
    * @default true
    */
   shouldFlip?: boolean,
-  onLoadMore?: () => void
+  onLoadMore?: () => void,
+  /** An icon to display at the start of the input. */
+  icon?: ReactElement | null
 }