Skip to content

Commit f371301

Browse files
committed
Update jsdoc
1 parent 2c37a6f commit f371301

File tree

6 files changed

+9
-5
lines changed

6 files changed

+9
-5
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"author": "CodeStix",
66
"license": "MIT",
77
"repository": "CodeStix/typed-react-form",
8-
"homepage": "https://github.com/CodeStix/typed-react-form/wiki",
8+
"homepage": "https://typed-react-form.codestix.nl/",
99
"main": "dist/index.js",
1010
"source": "src/index.ts",
1111
"keywords": [

src/elements/FormError.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export type FormErrorProps<T extends object, K extends keyof T, Error extends st
1515
*
1616
* **FormInput**, **FormTextArea** and **FormSelect** are also available.
1717
*
18-
* 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).
18+
* Because this component is very basic, it is recommended to [implement your own error component](https://typed-react-form.codestix.nl/docs/FormError#custom-error-component).
1919
*/
2020
export function FormError<T extends object, K extends keyof T, Error extends string = DefaultError>({
2121
form,

src/elements/FormInput.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export type FormInputProps<
5959
*
6060
* **FormSelect**, **FormTextArea** and **FormError** are also available.
6161
*
62-
* 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).
62+
* When this component does not satisfy your needs, you can always [implement your own](https://typed-react-form.codestix.nl/docs/Custom-inputs#example-custom-input).
6363
*/
6464
export function FormInput<
6565
T extends object,

src/elements/FormSelect.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export type FormSelectProps<T extends object, State, Error extends string> = Omi
1919
*
2020
* **FormInput**, **FormTextArea** and **FormError** are also available.
2121
*
22-
* 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).
22+
* When this component does not satisfy your needs, you can always [implement your own](https://typed-react-form.codestix.nl/docs/Custom-inputs#example-custom-input).
2323
*/
2424
export function FormSelect<T extends object, State extends DefaultState = DefaultState, Error extends string = DefaultError>({
2525
form,

src/elements/FormTextArea.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export type FormTextAreaProps<T extends object, State, Error extends string> = O
1919
*
2020
* **FormSelect**, **FormInput** and **FormError** are also available.
2121
*
22-
* 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).
22+
* When this component does not satisfy your needs, you can always [implement your own](https://typed-react-form.codestix.nl/docs/Custom-inputs#example-custom-input).
2323
*/
2424
export function FormTextArea<T extends object, State extends DefaultState = DefaultState, Error extends string = DefaultError>({
2525
form,

src/form.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ export class FormState<T extends object, State = DefaultState, Error extends str
5555
* Should the form validate on each value change?
5656
*/
5757
public validateOnChange: boolean;
58+
59+
/**
60+
* Should the form validate when it gets mounted?
61+
*/
5862
public validateOnMount: boolean;
5963

6064
/**

0 commit comments

Comments
 (0)