@react-types/form 3.5.5-nightly.4256 → 3.5.5-nightly.4266

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-types/form",
-  "version": "3.5.5-nightly.4256+4dede01e2",
+  "version": "3.5.5-nightly.4266+0b541f488",
   "description": "Spectrum UI components in React",
   "license": "Apache-2.0",
   "types": "src/index.d.ts",
@@ -9,7 +9,7 @@
     "url": "https://github.com/adobe/react-spectrum"
   },
   "dependencies": {
-    "@react-types/shared": "3.0.0-nightly.2545+4dede01e2"
+    "@react-types/shared": "3.0.0-nightly.2555+0b541f488"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0"
@@ -17,5 +17,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "4dede01e242937311970bd495319a89bb48e33a5"
+  "gitHead": "0b541f48848eb43f74ae57e8b21dc4455d95040b"
 }

package/src/index.d.ts

@@ -11,9 +11,63 @@
  */
 
 import {AriaLabelingProps, DOMProps, SpectrumLabelableProps, StyleProps, ValidationErrors, ValidationState} from '@react-types/shared';
-import {FormEventHandler, ReactElement} from 'react';
+import {FormEvent, FormHTMLAttributes, ReactElement} from 'react';
 
-export interface SpectrumFormProps extends DOMProps, AriaLabelingProps, StyleProps, Omit<SpectrumLabelableProps, 'contextualHelp' | 'label'> {
+export interface FormProps extends AriaLabelingProps {
+  /**
+   * Validation errors for the form, typically returned by a server.
+   * This should be set to an object mapping from input names to errors.
+   */
+  validationErrors?: ValidationErrors,
+  /**
+   * Where to send the form-data when the form is submitted.
+   * See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#action).
+   */
+  action?: string | FormHTMLAttributes<HTMLFormElement>['action'],
+  /**
+   * The enctype attribute specifies how the form-data should be encoded when submitting it to the server.
+   * See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#enctype).
+   */
+  encType?: 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain',
+  /**
+   * The HTTP method to submit the form with.
+   * See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#method).
+   */
+  method?: 'get' | 'post' | 'dialog',
+  /**
+   * The target attribute specifies a name or a keyword that indicates where to display the response that is received after submitting the form.
+   * See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#target).
+   */
+  target?: '_blank' | '_self' | '_parent' | '_top',
+  /**
+   * Triggered when a user submits the form.
+   */
+  onSubmit?: (event: FormEvent<HTMLFormElement>) => void,
+  /**
+   * Triggered when a user resets the form.
+   */
+  onReset?:  (event: FormEvent<HTMLFormElement>) => void,
+  /**
+   * Triggered for each invalid field when a user submits the form.
+   */
+  onInvalid?:  (event: FormEvent<HTMLFormElement>) => void,
+  /**
+   * Indicates whether input elements can by default have their values automatically completed by the browser.
+   * See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#autocomplete).
+   */
+  autoComplete?: 'off' | 'on',
+  /**
+   * A nonstandard attribute used by iOS Safari that controls how textual form elements should be automatically capitalized.
+   * See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#autocapitalize).
+   */
+  autoCapitalize?: 'off' | 'on',
+  /**
+   * An ARIA role override to apply to the form element.
+   */
+  role?: 'search' | 'presentation'
+}
+
+export interface SpectrumFormProps extends FormProps, DOMProps, StyleProps, Omit<SpectrumLabelableProps, 'contextualHelp' | 'label'> {
   /** The contents of the Form. */
   children: ReactElement<SpectrumLabelableProps> | ReactElement<SpectrumLabelableProps>[],
   /** Whether the Form elements are displayed with their quiet style. */
@@ -33,34 +87,9 @@ export interface SpectrumFormProps extends DOMProps, AriaLabelingProps, StylePro
   validationState?: ValidationState,
   /**
    * Whether to use native HTML form validation to prevent form submission
-   * when a field value is missing or invalid, or mark the field as required
+   * when a field value is missing or invalid, or mark fields as required
    * or invalid via ARIA.
    * @default 'aria'
    */
-  validationBehavior?: 'aria' | 'native',
-  /**
-   * Validation errors for the form, typically returned by a server.
-   * This should be set to an object mapping from input names to errors.
-   */
-  validationErrors?: ValidationErrors,
-  /**
-   * Where to send the form-data when the form is submitted.
-   */
-  action?: string,
-  /**
-   * The enctype attribute specifies how the form-data should be encoded when submitting it to the server.
-   */
-  encType?: 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain',
-  /**
-   * The form-data can be sent as URL variables (with method="get") or as HTTP post transaction (with method="post").
-   */
-  method?: 'get' | 'post',
-  /**
-   * The target attribute specifies a name or a keyword that indicates where to display the response that is received after submitting the form.
-   */
-  target?: '_blank' | '_self' | '_parent' | '_top',
-  /**
-   * Fired on form submission.
-   */
-  onSubmit?: FormEventHandler
+  validationBehavior?: 'aria' | 'native'
 }