<commit_before># API Documentation
Welcome to the `@cat-react/form` API documentation.

## Table of Contents
- [Form](#form) (Main Component)
    - [onSubmit](#onsubmit)
    - [onValidSubmit](#onvalidsubmit)
    - [onInvalidSubmit](#oninvalidsubmit)
    - [onValidChanged](#onvalidchanged)
    - [onValid](#onvalid)
    - [onInvalid](#oninvalid)
- [Input](#input) (HOC for building input fields)
    - Retrieves
        - [value](#value)
        - [name](#name)
        - [validations](#validations)
        - [warnings](#warnings)
        - [messages](#messages)
        - [dependencies](#dependencies)
    - Passes Down
        - [isRequired](#isrequired)
        - [isPristine](#ispristine)
        - [isValid](#isvalid)
        - [getValue](#getvalue)
        - [setValue](#setvalue)
        - [getMessages](#getmessages)
        - [touch](#touch)
- [Validation Rules](#validation-rules) (StandardSet shipping with `@cat-react/form`)
    - [matchRegexp](#matchregexp)
    - [isRequired](#isrequired)
    - [isEmail](#isemail)
    - [minLength](#minlength)
    - [maxLength](#maxlength)
    - [equals](#equals)
    - [equalsField](#equalsfield)
    - [equalsFields](#equalsfields)
    - [isNumber](#isnumber)

---

## Form
Main Component for building a form.

### onSubmit(values, valid)
Method which is being called when a submit event is fired on the form, regardless of whether the form is valid or invalid.

Params:
<table class="table table-bordered table-striped">
    <thead>
    <tr>
        <th>name</th>
        <th>description</th>
    </tr>
    </thead>
    <tbody>
        <tr>
          <td>**values**</td>
          <td>All form values in form of a Map<fieldName, value>.</td>
        </tr>
        <tr>
          <td>**valid**</td><commit_msg>adjusted doc for params<commit_after># API Documentation
Welcome to the `@cat-react/form` API documentation.

## Table of Contents
- [Form](#form) (Main Component)
    - [onSubmit](#onsubmit)
    - [onValidSubmit](#onvalidsubmit)
    - [onInvalidSubmit](#oninvalidsubmit)
    - [onValidChanged](#onvalidchanged)
    - [onValid](#onvalid)
    - [onInvalid](#oninvalid)
- [Input](#input) (HOC for building input fields)
    - Retrieves
        - [value](#value)
        - [name](#name)
        - [validations](#validations)
        - [warnings](#warnings)
        - [messages](#messages)
        - [dependencies](#dependencies)
    - Passes Down
        - [isRequired](#isrequired)
        - [isPristine](#ispristine)
        - [isValid](#isvalid)
        - [getValue](#getvalue)
        - [setValue](#setvalue)
        - [getMessages](#getmessages)
        - [touch](#touch)
- [Validation Rules](#validation-rules) (StandardSet shipping with `@cat-react/form`)
    - [matchRegexp](#matchregexp)
    - [isRequired](#isrequired)
    - [isEmail](#isemail)
    - [minLength](#minlength)
    - [maxLength](#maxlength)
    - [equals](#equals)
    - [equalsField](#equalsfield)
    - [equalsFields](#equalsfields)
    - [isNumber](#isnumber)

---

## Form
Main Component for building a form.

### onSubmit(values, valid)
Method which is being called when a submit event is fired on the form, regardless of whether the form is valid or invalid.

Params:
<table class="table table-bordered table-striped">
    <tbody>
        <tr>
          <td><b>values</b></td>
          <td>All form values in form of a Map<fieldName, value>.</td>
        </tr>
        <tr>
          <td><b>valid</b></td>
{'fraction_non_alphanumeric': 0.16313497822931786, 'fraction_numerical': 0.0, 'mean_word_length': 2.7785087719298245, 'pattern_counts': {'":': 0, '<': 39, '<?xml version=': 0, '>': 39, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '558305', 'n_tokens_mistral': 1130, 'n_tokens_neox': 1066, 'n_words': 228}