JSDoc for elements

Author: CodeStix

src/elements/FormError.tsx

@@ -7,6 +7,13 @@ export type FormErrorProps<T, Error, Key extends keyof T> = Omit<HTMLAttributes<
     name: Key;
 };
 
+/**
+ * The builtin form error. You must always specify **form** and **name**.
+ *
+ * **FormInput**, **FormTextArea** and **FormSelect** are also available.
+ *
+ * When this error component is too basic for your needs, you can always [create your own](https://github.com/CodeStix/typed-react-form/wiki/FormError#custom-error-component).
+ */
 export function FormError<T, Error, Key extends keyof T>({ form, name, ...rest }: FormErrorProps<T, Error, Key>) {
     const { error } = useListener(form, name);
     if (!error || typeof error === "object") return null;

src/elements/FormInput.tsx

@@ -51,6 +51,8 @@ export type FormInputProps<T, State, Error, Key extends keyof T, Value extends T
 /**
  * The builtin form input. You must always specify **form** and **name**. Use the **type** prop to specify what type of field it represents.
  *
+ * **FormSelect**, **FormTextArea** and **FormError** are also available.
+ *
  * When this component does not satisfy your needs, you can always [create your own](https://github.com/CodeStix/typed-react-form/wiki/Custom-inputs#example-custom-input).
  */
 export function FormInput<T, State extends DefaultState, Error, Key extends keyof T, Value extends T[Key] | T[Key][keyof T[Key]]>({

src/elements/FormSelect.tsx

@@ -14,6 +14,13 @@ export type FormSelectProps<T, State, Error> = Omit<SelectHTMLAttributes<HTMLSel
     hideWhenNull?: boolean;
 };
 
+/**
+ * The builtin form select. You must always specify **form** and **name**. Use the normal `<option>` element to specify its possible values.
+ *
+ * **FormInput**, **FormTextArea** and **FormError** are also available.
+ *
+ * When this component does not satisfy your needs, you can always [create your own](https://github.com/CodeStix/typed-react-form/wiki/Custom-inputs#example-custom-input).
+ */
 export function FormSelect<T, State extends DefaultState, Error>({
     form,
     name,

src/elements/FormTextArea.tsx

@@ -14,6 +14,13 @@ export type FormTextAreaProps<T, State, Error> = Omit<TextareaHTMLAttributes<HTM
     hideWhenNull?: boolean;
 };
 
+/**
+ * The builtin form textarea. You must always specify **form** and **name**.
+ *
+ * **FormSelect**, **FormInput** and **FormError** are also available.
+ *
+ * When this component does not satisfy your needs, you can always [create your own](https://github.com/CodeStix/typed-react-form/wiki/Custom-inputs#example-custom-input).
+ */
 export function FormTextArea<T, State extends DefaultState, Error>({
     form,
     name,