@react-types/autocomplete 3.0.0-alpha.3 → 3.0.0-alpha.30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-types/autocomplete",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.30",
   "description": "Spectrum UI components in React",
   "license": "Apache-2.0",
   "types": "src/index.d.ts",
@@ -9,15 +9,15 @@
     "url": "https://github.com/adobe/react-spectrum"
   },
   "dependencies": {
-    "@react-types/combobox": "^3.3.0",
-    "@react-types/searchfield": "^3.1.5",
-    "@react-types/shared": "^3.11.2"
+    "@react-types/combobox": "^3.13.4",
+    "@react-types/searchfield": "^3.6.1",
+    "@react-types/shared": "^3.29.0"
   },
   "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0-rc.1"
+    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ed8d8d984c2f7f2c31e8b18795b97858a95e4729"
+  "gitHead": "9b66d270572f482948afee95622a85cdf68ed408"
 }

package/src/index.d.ts

@@ -10,11 +10,12 @@
  * governing permissions and limitations under the License.
  */
 
-import {AsyncLoadable, CollectionBase, LoadingState, SpectrumLabelableProps, StyleProps} from '@react-types/shared';
-import {Key} from 'react';
+import {AriaLabelingProps, AsyncLoadable, CollectionBase, DimensionValue, DOMProps, Key, LoadingState, SpectrumFieldValidation, SpectrumLabelableProps, SpectrumTextInputBase, StyleProps} from '@react-types/shared';
+import {AriaSearchFieldProps, SearchFieldProps} from '@react-types/searchfield';
 import {MenuTriggerAction} from '@react-types/combobox';
-import {SearchFieldProps} from '@react-types/searchfield';
-export interface SearchAutocompleteProps<T> extends CollectionBase<T>, Omit<SearchFieldProps, 'onSubmit'> {
+import {ReactElement} from 'react';
+
+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). */
@@ -32,10 +33,20 @@ export interface SearchAutocompleteProps<T> extends CollectionBase<T>, Omit<Sear
    * @default 'input'
    */
   menuTrigger?: MenuTriggerAction,
-  onSubmit?: (value: string, key: Key | null) => void
+  /** 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 Omit<SearchAutocompleteProps<T>, 'menuTrigger'>, SpectrumLabelableProps, StyleProps, Omit<AsyncLoadable, 'isLoading'> {
+export interface AriaSearchAutocompleteProps<T> extends SearchAutocompleteProps<T>, Omit<AriaSearchFieldProps, 'onSubmit' | 'defaultValue' | 'value'>, DOMProps, AriaLabelingProps {}
+
+export interface SpectrumSearchAutocompleteProps<T> extends SpectrumTextInputBase, Omit<AriaSearchAutocompleteProps<T>, 'menuTrigger' | 'isInvalid' | 'validationState' | 'validate'>, SpectrumFieldValidation<string>, 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'
@@ -43,6 +54,10 @@ export interface SpectrumSearchAutocompleteProps<T> extends Omit<SearchAutocompl
   menuTrigger?: MenuTriggerAction,
   /** Whether the SearchAutocomplete should be displayed with a quiet style. */
   isQuiet?: boolean,
+  /** Alignment of the menu relative to the input target.
+   * @default 'start'
+   */
+  align?: 'start' | 'end',
   /**
    * Direction the menu will render relative to the SearchAutocomplete.
    * @default 'bottom'
@@ -55,5 +70,9 @@ export interface SpectrumSearchAutocompleteProps<T> extends Omit<SearchAutocompl
    * @default true
    */
   shouldFlip?: boolean,
-  onLoadMore?: () => void
+  /** Width of the menu. By default, matches width of the trigger. Note that the minimum width of the dropdown is always equal to the trigger's width. */
+  menuWidth?: DimensionValue,
+  onLoadMore?: () => void,
+  /** An icon to display at the start of the input. */
+  icon?: ReactElement | null
 }