@conform-to/react 0.5.0-pre.0 → 0.5.0

package/helpers.d.ts

@@ -1,10 +1,13 @@
 import type { FieldConfig } from '@conform-to/dom';
 import type { HTMLInputTypeAttribute } from 'react';
 interface FieldProps {
+    id?: string;
     name: string;
     form?: string;
     required?: boolean;
     autoFocus?: boolean;
+    'aria-invalid': boolean;
+    'aria-describedby'?: string;
 }
 interface InputProps<Schema> extends FieldProps {
     type?: HTMLInputTypeAttribute;

package/helpers.js

@@ -3,8 +3,10 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 function input(config) {
+  var _config$initialError;
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   var attributes = {
+    id: config.id,
     type: options.type,
     name: config.name,
     form: config.form,
@@ -15,7 +17,9 @@ function input(config) {
     max: config.max,
     step: config.step,
     pattern: config.pattern,
-    multiple: config.multiple
+    multiple: config.multiple,
+    'aria-invalid': Boolean((_config$initialError = config.initialError) === null || _config$initialError === void 0 ? void 0 : _config$initialError.length),
+    'aria-describedby': config.errorId
   };
   if (config.initialError && config.initialError.length > 0) {
     attributes.autoFocus = true;
@@ -30,13 +34,16 @@ function input(config) {
   return attributes;
 }
 function select(config) {
-  var _config$defaultValue;
+  var _config$defaultValue, _config$initialError2;
   var attributes = {
+    id: config.id,
     name: config.name,
     form: config.form,
     defaultValue: config.multiple ? Array.isArray(config.defaultValue) ? config.defaultValue : [] : "".concat((_config$defaultValue = config.defaultValue) !== null && _config$defaultValue !== void 0 ? _config$defaultValue : ''),
     required: config.required,
-    multiple: config.multiple
+    multiple: config.multiple,
+    'aria-invalid': Boolean((_config$initialError2 = config.initialError) === null || _config$initialError2 === void 0 ? void 0 : _config$initialError2.length),
+    'aria-describedby': config.errorId
   };
   if (config.initialError && config.initialError.length > 0) {
     attributes.autoFocus = true;
@@ -44,15 +51,18 @@ function select(config) {
   return attributes;
 }
 function textarea(config) {
-  var _config$defaultValue2;
+  var _config$defaultValue2, _config$initialError3;
   var attributes = {
+    id: config.id,
     name: config.name,
     form: config.form,
     defaultValue: "".concat((_config$defaultValue2 = config.defaultValue) !== null && _config$defaultValue2 !== void 0 ? _config$defaultValue2 : ''),
     required: config.required,
     minLength: config.minLength,
     maxLength: config.maxLength,
-    autoFocus: Boolean(config.initialError)
+    autoFocus: Boolean(config.initialError),
+    'aria-invalid': Boolean((_config$initialError3 = config.initialError) === null || _config$initialError3 === void 0 ? void 0 : _config$initialError3.length),
+    'aria-describedby': config.errorId
   };
   if (config.initialError && config.initialError.length > 0) {
     attributes.autoFocus = true;

package/hooks.d.ts

@@ -1,6 +1,11 @@
-import { type FieldConfig, type FieldElement, type FieldValue, type FieldsetConstraint, type ListCommand, type Primitive, type Submission } from '@conform-to/dom';
+import { type FieldConfig, type FieldElement, type FieldValue, type FieldsetConstraint, type Primitive, type Submission } from '@conform-to/dom';
 import { type InputHTMLAttributes, type FormEvent, type RefObject } from 'react';
 export interface FormConfig<Schema extends Record<string, any>> {
+    /**
+     * If the form id is provided, Id for label,
+     * input and error elements will be derived.
+     */
+    id?: string;
     /**
      * Validation mode. Default to `client-only`.
      */
@@ -20,6 +25,10 @@ export interface FormConfig<Schema extends Record<string, any>> {
      * An object describing the state from the last submission
      */
     state?: Submission<Schema>;
+    /**
+     * An object describing the constraint of each field
+     */
+    constraint?: FieldsetConstraint<Schema>;
     /**
      * Enable native validation before hydation.
      *
@@ -53,10 +62,12 @@ export interface FormConfig<Schema extends Record<string, any>> {
  */
 interface FormProps {
     ref: RefObject<HTMLFormElement>;
+    id?: string;
     onSubmit: (event: FormEvent<HTMLFormElement>) => void;
     noValidate: boolean;
 }
 interface Form<Schema extends Record<string, any>> {
+    id?: string;
     ref: RefObject<HTMLFormElement>;
     error: string;
     props: FormProps;
@@ -66,9 +77,9 @@ interface Form<Schema extends Record<string, any>> {
  * Returns properties required to hook into form events.
  * Applied custom validation and define when error should be reported.
  *
- * @see https://github.com/edmundhung/conform/tree/v0.4.1/packages/conform-react/README.md#useform
+ * @see https://conform.guide/api/react#useform
  */
-export declare function useForm<Schema extends Record<string, any>>(config?: FormConfig<Schema>): Form<Schema>;
+export declare function useForm<Schema extends Record<string, any>>(config?: FormConfig<Schema>): [Form<Schema>, Fieldset<Schema>];
 /**
  * All the information of the field, including state and config.
  */
@@ -107,39 +118,21 @@ export interface FieldsetConfig<Schema extends Record<string, any>> {
 /**
  * Returns all the information about the fieldset.
  *
- * @see https://github.com/edmundhung/conform/tree/v0.4.1/packages/conform-react/README.md#usefieldset
+ * @see https://conform.guide/api/react#usefieldset
  */
 export declare function useFieldset<Schema extends Record<string, any>>(ref: RefObject<HTMLFormElement | HTMLFieldSetElement>, config: FieldsetConfig<Schema>): Fieldset<Schema>;
 export declare function useFieldset<Schema extends Record<string, any>>(ref: RefObject<HTMLFormElement | HTMLFieldSetElement>, config: FieldConfig<Schema>): Fieldset<Schema>;
-interface CommandButtonProps {
-    name?: string;
-    value?: string;
-    form?: string;
-    formNoValidate: true;
-}
-declare type ListCommandPayload<Schema, Type extends ListCommand<FieldValue<Schema>>['type']> = Extract<ListCommand<FieldValue<Schema>>, {
-    type: Type;
-}>['payload'];
 /**
  * Returns a list of key and config, with a group of helpers
  * configuring buttons for list manipulation
  *
- * @see https://github.com/edmundhung/conform/tree/v0.4.1/packages/conform-react/README.md#usefieldlist
+ * @see https://conform.guide/api/react#usefieldlist
  */
-export declare function useFieldList<Payload = any>(ref: RefObject<HTMLFormElement | HTMLFieldSetElement>, config: FieldConfig<Array<Payload>>): [
-    Array<{
-        key: string;
-        error: string | undefined;
-        config: FieldConfig<Payload>;
-    }>,
-    {
-        prepend(payload?: ListCommandPayload<Payload, 'prepend'>): CommandButtonProps;
-        append(payload?: ListCommandPayload<Payload, 'append'>): CommandButtonProps;
-        replace(payload: ListCommandPayload<Payload, 'replace'>): CommandButtonProps;
-        remove(payload: ListCommandPayload<Payload, 'remove'>): CommandButtonProps;
-        reorder(payload: ListCommandPayload<Payload, 'reorder'>): CommandButtonProps;
-    }
-];
+export declare function useFieldList<Payload = any>(ref: RefObject<HTMLFormElement | HTMLFieldSetElement>, config: FieldConfig<Array<Payload>>): Array<{
+    key: string;
+    error: string | undefined;
+    config: FieldConfig<Payload>;
+}>;
 interface ShadowInputProps extends InputHTMLAttributes<HTMLInputElement> {
     ref: RefObject<HTMLInputElement>;
 }
@@ -161,7 +154,7 @@ interface InputControl<Element extends {
  * This is particular useful when integrating dropdown and datepicker whichs
  * introduces custom input mode.
  *
- * @see https://github.com/edmundhung/conform/tree/v0.4.1/packages/conform-react/README.md#usecontrolledinput
+ * @see https://conform.guide/api/react#usecontrolledinput
  */
 export declare function useControlledInput<Element extends {
     focus: () => void;

package/hooks.js

@@ -11,7 +11,7 @@ var helpers = require('./helpers.js');
  * Returns properties required to hook into form events.
  * Applied custom validation and define when error should be reported.
  *
- * @see https://github.com/edmundhung/conform/tree/v0.4.1/packages/conform-react/README.md#useform
+ * @see https://conform.guide/api/react#useform
  */
 function useForm() {
   var config = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -25,17 +25,26 @@ function useForm() {
     })) !== null && _config$state$error$f !== void 0 ? _config$state$error$f : [];
     return message !== null && message !== void 0 ? message : '';
   });
-  var [fieldsetConfig, setFieldsetConfig] = react.useState(() => {
-    var _config$state$error2, _config$state2, _config$state$value, _config$state3;
-    var error = (_config$state$error2 = (_config$state2 = config.state) === null || _config$state2 === void 0 ? void 0 : _config$state2.error) !== null && _config$state$error2 !== void 0 ? _config$state$error2 : [];
+  var [uncontrolledState, setUncontrolledState] = react.useState(() => {
+    var submission = config.state;
+    if (!submission) {
+      return {
+        defaultValue: config.defaultValue
+      };
+    }
     return {
-      defaultValue: (_config$state$value = (_config$state3 = config.state) === null || _config$state3 === void 0 ? void 0 : _config$state3.value) !== null && _config$state$value !== void 0 ? _config$state$value : config.defaultValue,
-      initialError: error.filter(_ref2 => {
+      defaultValue: submission.value,
+      initialError: submission.error.filter(_ref2 => {
         var [name] = _ref2;
-        return name !== '' && dom.getSubmissionType(name) === null;
+        return name !== '' && dom.shouldValidate(submission, name);
       })
     };
   });
+  var fieldsetConfig = _rollupPluginBabelHelpers.objectSpread2(_rollupPluginBabelHelpers.objectSpread2({}, uncontrolledState), {}, {
+    constraint: config.constraint,
+    form: config.id
+  });
+  var fieldset = useFieldset(ref, fieldsetConfig);
   var [noValidate, setNoValidate] = react.useState(config.noValidate || !config.fallbackNative);
   react.useEffect(() => {
     configRef.current = config;
@@ -59,11 +68,8 @@ function useForm() {
       if (!form || !dom.isFieldElement(field) || field.form !== form) {
         return;
       }
-      if (formConfig.initialReport === 'onChange') {
-        field.dataset.conformTouched = 'true';
-      }
-      if (field.dataset.conformTouched) {
-        dom.requestValidate(form, field.name);
+      if (field.dataset.conformTouched || formConfig.initialReport === 'onChange') {
+        dom.requestCommand(form, dom.validate(field.name));
       }
     };
     var handleBlur = event => {
@@ -74,8 +80,7 @@ function useForm() {
         return;
       }
       if (formConfig.initialReport === 'onBlur' && !field.dataset.conformTouched) {
-        field.dataset.conformTouched = 'true';
-        dom.requestValidate(form, field.name);
+        dom.requestCommand(form, dom.validate(field.name));
       }
     };
     var handleInvalid = event => {
@@ -100,11 +105,12 @@ function useForm() {
       for (var field of form.elements) {
         if (dom.isFieldElement(field)) {
           delete field.dataset.conformTouched;
+          field.setAttribute('aria-invalid', 'false');
           field.setCustomValidity('');
         }
       }
       setError('');
-      setFieldsetConfig({
+      setUncontrolledState({
         defaultValue: formConfig.defaultValue,
         initialError: []
       });
@@ -127,11 +133,13 @@ function useForm() {
       document.removeEventListener('reset', handleReset);
     };
   }, []);
-  return {
+  var form = {
+    id: config.id,
     ref,
     error,
     props: {
       ref,
+      id: config.id,
       noValidate,
       onSubmit(event) {
         var form = event.currentTarget;
@@ -173,16 +181,6 @@ function useForm() {
               }
             }
           }
-
-          // Touch all fields only if the submitter is not a command button
-          if (submission.type === 'submit') {
-            for (var field of form.elements) {
-              if (dom.isFieldElement(field)) {
-                // Mark the field as touched
-                field.dataset.conformTouched = 'true';
-              }
-            }
-          }
           if (!config.noValidate && !(submitter !== null && submitter !== void 0 && submitter.formNoValidate) && dom.hasError(submission.error) || submission.type === 'validate' && config.mode !== 'server-validation') {
             event.preventDefault();
           } else {
@@ -202,6 +200,7 @@ function useForm() {
     },
     config: fieldsetConfig
   };
+  return [form, fieldset];
 }
 
 /**
@@ -262,6 +261,10 @@ function useFieldset(ref, config) {
       // Update the error only if the field belongs to the fieldset
       if (typeof key === 'string' && paths.length === 0) {
         if (field.dataset.conformTouched) {
+          // Update the aria attribute only if it is set
+          if (field.getAttribute('aria-invalid')) {
+            field.setAttribute('aria-invalid', field.validationMessage !== '' ? 'true' : 'false');
+          }
           setError(prev => {
             var _prev$key;
             var prevMessage = (_prev$key = prev === null || prev === void 0 ? void 0 : prev[key]) !== null && _prev$key !== void 0 ? _prev$key : '';
@@ -316,21 +319,26 @@ function useFieldset(ref, config) {
       var field = {
         config: _rollupPluginBabelHelpers.objectSpread2({
           name: fieldsetConfig.name ? "".concat(fieldsetConfig.name, ".").concat(key) : key,
-          form: fieldsetConfig.form,
           defaultValue: uncontrolledState.defaultValue[key],
           initialError: uncontrolledState.initialError[key]
         }, constraint),
         error: (_error$key = error === null || error === void 0 ? void 0 : error[key]) !== null && _error$key !== void 0 ? _error$key : ''
       };
+      if (fieldsetConfig.form) {
+        field.config.form = fieldsetConfig.form;
+        field.config.id = "".concat(fieldsetConfig.form, "-").concat(field.config.name);
+        field.config.errorId = "".concat(field.config.id, "-error");
+      }
       return field;
     }
   });
 }
+
 /**
  * Returns a list of key and config, with a group of helpers
  * configuring buttons for list manipulation
  *
- * @see https://github.com/edmundhung/conform/tree/v0.4.1/packages/conform-react/README.md#usefieldlist
+ * @see https://conform.guide/api/react#usefieldlist
  */
 function useFieldList(ref, config) {
   var configRef = react.useRef(config);
@@ -361,41 +369,6 @@ function useFieldList(ref, config) {
     var _config$defaultValue3;
     return Object.entries((_config$defaultValue3 = config.defaultValue) !== null && _config$defaultValue3 !== void 0 ? _config$defaultValue3 : [undefined]);
   });
-  var list = entries.map((_ref3, index) => {
-    var [key, defaultValue] = _ref3;
-    return {
-      key,
-      error: error[index],
-      config: {
-        name: "".concat(config.name, "[").concat(index, "]"),
-        form: config.form,
-        defaultValue: defaultValue !== null && defaultValue !== void 0 ? defaultValue : uncontrolledState.defaultValue[index],
-        initialError: uncontrolledState.initialError[index]
-      }
-    };
-  });
-
-  /***
-   * This use proxy to capture all information about the command and
-   * have it encoded in the value.
-   */
-  var command = new Proxy({}, {
-    get(_target, type) {
-      return function () {
-        var payload = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-        return {
-          name: 'conform/list',
-          value: JSON.stringify({
-            type,
-            scope: config.name,
-            payload
-          }),
-          form: config.form,
-          formNoValidate: true
-        };
-      };
-    }
-  });
   react.useEffect(() => {
     configRef.current = config;
   });
@@ -492,16 +465,31 @@ function useFieldList(ref, config) {
       document.removeEventListener('reset', resetHandler);
     };
   }, [ref]);
-  return [list,
-  // @ts-expect-error proxy type
-  command];
+  return entries.map((_ref3, index) => {
+    var [key, defaultValue] = _ref3;
+    var fieldConfig = {
+      name: "".concat(config.name, "[").concat(index, "]"),
+      defaultValue: defaultValue !== null && defaultValue !== void 0 ? defaultValue : uncontrolledState.defaultValue[index],
+      initialError: uncontrolledState.initialError[index]
+    };
+    if (config.form) {
+      fieldConfig.form = config.form;
+      fieldConfig.id = "".concat(config.form, "-").concat(config.name);
+      fieldConfig.errorId = "".concat(fieldConfig.id, "-error");
+    }
+    return {
+      key,
+      error: error[index],
+      config: fieldConfig
+    };
+  });
 }
 /**
  * Returns the properties required to configure a shadow input for validation.
  * This is particular useful when integrating dropdown and datepicker whichs
  * introduces custom input mode.
  *
- * @see https://github.com/edmundhung/conform/tree/v0.4.1/packages/conform-react/README.md#usecontrolledinput
+ * @see https://conform.guide/api/react#usecontrolledinput
  */
 function useControlledInput(config) {
   var _config$defaultValue4;

package/index.d.ts

@@ -1,3 +1,3 @@
-export { type FieldConfig, type FieldsetConstraint, type Submission, getFormElements, hasError, parse, shouldValidate, } from '@conform-to/dom';
+export { type FieldConfig, type FieldsetConstraint, type Submission, getFormElements, hasError, list, validate, requestCommand, requestSubmit, parse, shouldValidate, } from '@conform-to/dom';
 export * from './hooks';
 export * as conform from './helpers';

package/index.js

@@ -16,14 +16,30 @@ Object.defineProperty(exports, 'hasError', {
 	enumerable: true,
 	get: function () { return dom.hasError; }
 });
+Object.defineProperty(exports, 'list', {
+	enumerable: true,
+	get: function () { return dom.list; }
+});
 Object.defineProperty(exports, 'parse', {
 	enumerable: true,
 	get: function () { return dom.parse; }
 });
+Object.defineProperty(exports, 'requestCommand', {
+	enumerable: true,
+	get: function () { return dom.requestCommand; }
+});
+Object.defineProperty(exports, 'requestSubmit', {
+	enumerable: true,
+	get: function () { return dom.requestSubmit; }
+});
 Object.defineProperty(exports, 'shouldValidate', {
 	enumerable: true,
 	get: function () { return dom.shouldValidate; }
 });
+Object.defineProperty(exports, 'validate', {
+	enumerable: true,
+	get: function () { return dom.validate; }
+});
 exports.useControlledInput = hooks.useControlledInput;
 exports.useFieldList = hooks.useFieldList;
 exports.useFieldset = hooks.useFieldset;

package/module/helpers.js

@@ -1,6 +1,8 @@
 function input(config) {
+  var _config$initialError;
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   var attributes = {
+    id: config.id,
     type: options.type,
     name: config.name,
     form: config.form,
@@ -11,7 +13,9 @@ function input(config) {
     max: config.max,
     step: config.step,
     pattern: config.pattern,
-    multiple: config.multiple
+    multiple: config.multiple,
+    'aria-invalid': Boolean((_config$initialError = config.initialError) === null || _config$initialError === void 0 ? void 0 : _config$initialError.length),
+    'aria-describedby': config.errorId
   };
   if (config.initialError && config.initialError.length > 0) {
     attributes.autoFocus = true;
@@ -26,13 +30,16 @@ function input(config) {
   return attributes;
 }
 function select(config) {
-  var _config$defaultValue;
+  var _config$defaultValue, _config$initialError2;
   var attributes = {
+    id: config.id,
     name: config.name,
     form: config.form,
     defaultValue: config.multiple ? Array.isArray(config.defaultValue) ? config.defaultValue : [] : "".concat((_config$defaultValue = config.defaultValue) !== null && _config$defaultValue !== void 0 ? _config$defaultValue : ''),
     required: config.required,
-    multiple: config.multiple
+    multiple: config.multiple,
+    'aria-invalid': Boolean((_config$initialError2 = config.initialError) === null || _config$initialError2 === void 0 ? void 0 : _config$initialError2.length),
+    'aria-describedby': config.errorId
   };
   if (config.initialError && config.initialError.length > 0) {
     attributes.autoFocus = true;
@@ -40,15 +47,18 @@ function select(config) {
   return attributes;
 }
 function textarea(config) {
-  var _config$defaultValue2;
+  var _config$defaultValue2, _config$initialError3;
   var attributes = {
+    id: config.id,
     name: config.name,
     form: config.form,
     defaultValue: "".concat((_config$defaultValue2 = config.defaultValue) !== null && _config$defaultValue2 !== void 0 ? _config$defaultValue2 : ''),
     required: config.required,
     minLength: config.minLength,
     maxLength: config.maxLength,
-    autoFocus: Boolean(config.initialError)
+    autoFocus: Boolean(config.initialError),
+    'aria-invalid': Boolean((_config$initialError3 = config.initialError) === null || _config$initialError3 === void 0 ? void 0 : _config$initialError3.length),
+    'aria-describedby': config.errorId
   };
   if (config.initialError && config.initialError.length > 0) {
     attributes.autoFocus = true;