Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/form-js/forms.js
Browse files Browse the repository at this point in the history
  • Loading branch information
Trilmatic committed Aug 10, 2024
2 parents 7945a60 + bf09296 commit 6e21593
Show file tree
Hide file tree
Showing 46 changed files with 1,242 additions and 1,049 deletions.
17 changes: 11 additions & 6 deletions docs/v1/checkbox-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

The options object can include the following properties (you can find full list below):

- `id: string` - <span class="badge warning">required</span> Unique identifier for the group.
- `toggle: boolean` - Defines if the checkox is toggle/switch style.
- `id: string` - <span class="badge warning">required</span> Unique identifier for the group.
- `toggle: boolean` - Defines if the checkox is toggle/switch style.

<iframe height="300" style="width: 100%;" scrolling="no" title="forms.js - checkbox example" src="https://codepen.io/trilmatic/embed/wvNZqXy?default-tab=js%2Cresult" frameborder="no" loading="lazy" allowtransparency="true" allowfullscreen="true">
See the Pen <a href="https://codepen.io/trilmatic/pen/wvNZqXy">
Expand All @@ -23,10 +23,11 @@ conditions: (value: FieldValue, data: FormData) => boolean;

### Validation and validation message

Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function.
Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function. You can also create a custom validation errors render function and pass it to option `renderValidationError`. You can also create a custom validation errors render function and pass it to option `renderValidationError`.

```js
validation: (value: FieldValue, data: FormData, required: boolean) => true | string;
validation: (value: FieldValue, data: FormData, required: boolean) =>
true | string;
```

**Default value**
Expand Down Expand Up @@ -62,7 +63,6 @@ In most fields you can retrive fields value with `getValue()` function called on

If you need to set the fields value programically you can eather use `default` option in field options or `setValue(value: FieldValue, save: boolean = true)` function called on the field instance.


## Change event

You can define the field change event by the `change` option inside the field options. It accepts function and field `value` is passed into this function.
Expand Down Expand Up @@ -129,6 +129,11 @@ change: (value: FieldValue) => void;
<td><code>(value: FieldValue, data: FormData, required: boolean) => true | string;</code></td>
<td>Defines the validation method of the field. By default validates empty required field as not valid.</td>
</tr>
<tr>
<td>renderValidationError</td>
<td><code>(validationMessage: string, data: FormData) => HTMLElement;</code></td>
<td>Defines custom render function for validation errors.</td>
</tr>
<tr>
<td>disabled</td>
<td><code>boolean | (value: FieldValue, data: FormData) => boolean</code></td>
Expand Down Expand Up @@ -215,4 +220,4 @@ change: (value: FieldValue) => void;
<td>Resets the field to its initial state.</td>
</tr>
</tbody>
</table>
</table>
7 changes: 6 additions & 1 deletion docs/v1/color-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ conditions: (value: FieldValue, data: FormData) => boolean;

### Validation and validation message

Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function.
Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function. You can also create a custom validation errors render function and pass it to option `renderValidationError`. You can also create a custom validation errors render function and pass it to option `renderValidationError`.

```js
validation: (value: FieldValue, data: FormData, required: boolean) =>
Expand Down Expand Up @@ -124,6 +124,11 @@ change: (value: FieldValue) => void;
<td>validation</td>
<td><code>(value: FieldValue, data: FormData, required: boolean) => true | string;</code></td>
<td>Defines the validation method of the field. By default validates empty required field as not valid.</td>
</tr>
<tr>
<td>renderValidationError</td>
<td><code>(validationMessage: string, data: FormData) => HTMLElement;</code></td>
<td>Defines custom render function for validation errors.</td>
</tr>
<tr>
<td>disabled</td>
Expand Down
7 changes: 6 additions & 1 deletion docs/v1/date-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ conditions: (value: FieldValue, data: FormData) => boolean;

### Validation and validation message

Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function.
Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function. You can also create a custom validation errors render function and pass it to option `renderValidationError`. You can also create a custom validation errors render function and pass it to option `renderValidationError`.

```js
validation: (value: FieldValue, data: FormData, required: boolean) =>
Expand Down Expand Up @@ -148,6 +148,11 @@ change: (value: FieldValue) => void;
<td>validation</td>
<td><code>(value: FieldValue, data: FormData, required: boolean) => true | string;</code></td>
<td>Defines the validation method of the field. By default validates empty required field as not valid.</td>
</tr>
<tr>
<td>renderValidationError</td>
<td><code>(validationMessage: string, data: FormData) => HTMLElement;</code></td>
<td>Defines custom render function for validation errors.</td>
</tr>
<tr>
<td>disabled</td>
Expand Down
16 changes: 11 additions & 5 deletions docs/v1/daterange-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Daterange field is an separate premium plugin that can be used in forms.js packa
You you can easily use this plugin with forms.js by provided `usePlugin` function.

app.js

```js
import { Form, usePlugin } from "@forms.js/core";
import { pluginSettings as DateRangePlugin } from "@forms.js/daterange-field";
Expand All @@ -23,8 +24,8 @@ To get valid license please look at <a class="link" href="https://formsjs.io/doc

The options object can include the following properties (you can find full list below):

- `id: string` - <span class="badge warning">required</span> Unique identifier for the group.
- `options: FlatpickrOptions` - Defines enhanced fields options for flatpickr.
- `id: string` - <span class="badge warning">required</span> Unique identifier for the group.
- `options: FlatpickrOptions` - Defines enhanced fields options for flatpickr.

<iframe height="300" style="width: 100%;" scrolling="no" title="forms.js - date range example" src="https://codepen.io/trilmatic/embed/qBGbjyo?default-tab=js%2Cresult" frameborder="no" loading="lazy" allowtransparency="true" allowfullscreen="true">
See the Pen <a href="https://codepen.io/trilmatic/pen/qBGbjyo">
Expand All @@ -34,7 +35,7 @@ The options object can include the following properties (you can find full list

### Date formatting

The field accepts RFC 3339 format string date formatting `YYYY-MM-DD`. The range is defined by ` to ` separator, so example of daterange value is `YYYY-MM-DD to `YYYY-MM-DD``. You can change formatting through flatpickr options.
The field accepts RFC 3339 format string date formatting `YYYY-MM-DD`. The range is defined by `to` separator, so example of daterange value is `YYYY-MM-DD to `YYYY-MM-DD``. You can change formatting through flatpickr options.

### Conditional logic

Expand All @@ -46,11 +47,11 @@ conditions: (value: FieldValue, data: FormData) => boolean;

### Validation and validation message

Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function.
Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function. You can also create a custom validation errors render function and pass it to option `renderValidationError`.

```js
validation: (value: FieldValue, data: FormData, required: boolean) =>
true | string;
true | string;
```

**Default value**
Expand Down Expand Up @@ -152,6 +153,11 @@ change: (value: FieldValue) => void;
<td><code>(value: FieldValue, data: FormData, required: boolean) => true | string;</code></td>
<td>Defines the validation method of the field. By default validates empty required field as not valid.</td>
</tr>
<tr>
<td>renderValidationError</td>
<td><code>(validationMessage: string, data: FormData) => HTMLElement;</code></td>
<td>Defines custom render function for validation errors.</td>
</tr>
<tr>
<td>disabled</td>
<td><code>boolean | (value: FieldValue, data: FormData) => boolean</code></td>
Expand Down
7 changes: 6 additions & 1 deletion docs/v1/datetime-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ conditions: (value: FieldValue, data: FormData) => boolean;

### Validation and validation message

Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function.
Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function. You can also create a custom validation errors render function and pass it to option `renderValidationError`.

```js
validation: (value: FieldValue, data: FormData, required: boolean) => true | string;
Expand Down Expand Up @@ -149,6 +149,11 @@ change: (value: FieldValue) => void;
<td><code>(value: FieldValue, data: FormData, required: boolean) => true | string;</code></td>
<td>Defines the validation method of the field. By default validates empty required field as not valid.</td>
</tr>
<tr>
<td>renderValidationError</td>
<td><code>(validationMessage: string, data: FormData) => HTMLElement;</code></td>
<td>Defines custom render function for validation errors.</td>
</tr>
<tr>
<td>disabled</td>
<td><code>boolean | (value: FieldValue, data: FormData) => boolean</code></td>
Expand Down
7 changes: 6 additions & 1 deletion docs/v1/email-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ conditions: (value: FieldValue, data: FormData) => boolean;

### Validation and validation message

Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function.
Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function. You can also create a custom validation errors render function and pass it to option `renderValidationError`.

```js
validation: (value: FieldValue, data: FormData, required: boolean) =>
Expand Down Expand Up @@ -130,6 +130,11 @@ change: (value: FieldValue) => void;
<td><code>(value: FieldValue, data: FormData, required: boolean) => true | string;</code></td>
<td>Defines the validation method of the field. By default validates empty required field as not valid.</td>
</tr>
<tr>
<td>renderValidationError</td>
<td><code>(validationMessage: string, data: FormData) => HTMLElement;</code></td>
<td>Defines custom render function for validation errors.</td>
</tr>
<tr>
<td>disabled</td>
<td><code>boolean | (value: FieldValue, data: FormData) => boolean</code></td>
Expand Down
7 changes: 6 additions & 1 deletion docs/v1/field-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ conditions: (value: FieldValue, data: FormData) => boolean;

### Validation and validation message

Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function.
Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function. You can also create a custom validation errors render function and pass it to option `renderValidationError`.

```js
validation: (value: FieldValue, data: FormData, required: boolean) => true | string;
Expand Down Expand Up @@ -114,6 +114,11 @@ change: (value: FieldValue) => void;
<td><code>(value: FieldValue, data: FormData, required: boolean) => true | string;</code></td>
<td>Defines the validation method of the field. By default validates empty required field as not valid.</td>
</tr>
<tr>
<td>renderValidationError</td>
<td><code>(validationMessage: string, data: FormData) => HTMLElement;</code></td>
<td>Defines custom render function for validation errors.</td>
</tr>
<tr>
<td>disabled</td>
<td><code>boolean | (value: FieldValue, data: FormData) => boolean</code></td>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ conditions: (value: FieldValue, data: FormData) => boolean;

### Validation and validation message

Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function.
Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function. You can also create a custom validation errors render function and pass it to option `renderValidationError`. You can also create a custom validation errors render function and pass it to option `renderValidationError`.

```js
validation: (value: FieldValue, data: FormData, required: boolean) =>
Expand Down
7 changes: 6 additions & 1 deletion docs/v1/file-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ conditions: (value: FieldValue, data: FormData) => boolean;

### Validation and validation message

Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function.
Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function. You can also create a custom validation errors render function and pass it to option `renderValidationError`.

```js
validation: (value: FieldValue, data: FormData, required: boolean) => true | string;
Expand Down Expand Up @@ -145,6 +145,11 @@ change: (value: FieldValue) => void;
<td><code>(value: FieldValue, data: FormData, required: boolean) => true | string;</code></td>
<td>Defines the validation method of the field. By default validates empty required field as not valid.</td>
</tr>
<tr>
<td>renderValidationError</td>
<td><code>(validationMessage: string, data: FormData) => HTMLElement;</code></td>
<td>Defines custom render function for validation errors.</td>
</tr>
<tr>
<td>disabled</td>
<td><code>boolean | (value: FieldValue, data: FormData) => boolean</code></td>
Expand Down
7 changes: 6 additions & 1 deletion docs/v1/number-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ conditions: (value: FieldValue, data: FormData) => boolean;

### Validation and validation message

Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function.
Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function. You can also create a custom validation errors render function and pass it to option `renderValidationError`.

```js
validation: (value: FieldValue, data: FormData, required: boolean) => true | string;
Expand Down Expand Up @@ -130,6 +130,11 @@ change: (value: FieldValue) => void;
<td><code>(value: FieldValue, data: FormData, required: boolean) => true | string;</code></td>
<td>Defines the validation method of the field. By default validates empty required field as not valid.</td>
</tr>
<tr>
<td>renderValidationError</td>
<td><code>(validationMessage: string, data: FormData) => HTMLElement;</code></td>
<td>Defines custom render function for validation errors.</td>
</tr>
<tr>
<td>disabled</td>
<td><code>boolean | (value: FieldValue, data: FormData) => boolean</code></td>
Expand Down
7 changes: 6 additions & 1 deletion docs/v1/pasword-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ conditions: (value: FieldValue, data: FormData) => boolean;

### Validation and validation message

Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function.
Validation can be defined by the `validation` option inside the field options. It accepts function that returns `true` if the field is validated correctly or validation message `string` if there is an validation error. Field `value` and `required` attribute and form `data` are passed into the function. You can also create a custom validation errors render function and pass it to option `renderValidationError`.

```js
validation: (value: FieldValue, data: FormData, required: boolean) => true | string;
Expand Down Expand Up @@ -126,6 +126,11 @@ change: (value: FieldValue) => void;
<td><code>(value: FieldValue, data: FormData, required: boolean) => true | string;</code></td>
<td>Defines the validation method of the field. By default validates empty required field as not valid.</td>
</tr>
<tr>
<td>renderValidationError</td>
<td><code>(validationMessage: string, data: FormData) => HTMLElement;</code></td>
<td>Defines custom render function for validation errors.</td>
</tr>
<tr>
<td>disabled</td>
<td><code>boolean | (value: FieldValue, data: FormData) => boolean</code></td>
Expand Down
Loading

0 comments on commit 6e21593

Please sign in to comment.