FieldError documentation

Author: CodeStix

src/Field.tsx

@@ -18,7 +18,7 @@ export type FieldProps<T extends object, K extends keyof T, C> = {
      */
     name: K;
     /**
-     * The element to create, this can be a string specifying "input", "select", "textarea" or a custom component. Is "input" by default. The props of the passed component are available on this field.
+     * The element to create, this can be a string specifying "input", "select", "textarea" or a custom component. Is "input" by default. The props of the passed custom component are available on this field.
      *
      * **Examples**
      *

src/FieldError.tsx

@@ -11,8 +11,23 @@ export function FieldError<
     State = DefaultState
 >(
     props: {
+        /**
+         * The form to make a field for
+         */
         form: FormState<T, State, Error>;
+        /**
+         * The name of the field
+         */
         name: K;
+        /**
+         * The element to create, this can be a string specifying a tag "p", "span", "div" ... or a custom component. Is React.Fragment (`<></>`) by default. The props of the passed custom component are available on this field.
+         *
+         * **Examples**
+         *
+         * `<FieldError as="textarea" rows={10} />`
+         *
+         * `<FieldError as={CustomInput} {...} />`
+         */
         as?: C;
         transformer?: (error: Error) => React.ReactNode;
     } & Omit<ElementProps<C>, "transformer" | "as" | "name" | "form" | "children">