astro-reactive-form/packages/validator
2023-01-04 14:11:49 +01:00
..
core feat: Types and Intellisense Improvements (#231) 2022-12-07 20:56:27 +01:00
test fix: extends timeout for timed out test (#208) 2022-11-25 14:37:23 +01:00
.editorconfig feat: create astro reactive validator (#90) 2022-10-15 16:32:02 +02:00
.eslintignore feat: create astro reactive validator (#90) 2022-10-15 16:32:02 +02:00
.eslintrc.cjs core: common directory for packages (#114) 2022-10-21 14:05:23 +02:00
.gitignore feat: create astro reactive validator (#90) 2022-10-15 16:32:02 +02:00
.prettierrc.cjs feat: create astro reactive validator (#90) 2022-10-15 16:32:02 +02:00
index.ts feat(validator): server-side rendered validation errors (#123) 2022-10-22 04:35:16 +02:00
package.json chore: release form@0.6.7, validator@0.2.7, common@0.1.5 2023-01-04 13:52:57 +01:00
README.md docs: update readme example code 2023-01-04 14:11:49 +01:00
RELEASE.md chore: release form@0.6.7, validator@0.2.7, common@0.1.5 2023-01-04 13:52:57 +01:00
tsconfig.json chore: update check and build scripts 2022-11-10 19:03:45 +01:00
Validator.astro feat(form): implement FormControl and ControlConfig prop triggerValidationOn (#224) 2022-12-06 18:44:52 +07:00
vitest.config.ts fix: extends timeout for timed out test (#208) 2022-11-25 14:37:23 +01:00

Astro Reactive Library Logo
Astro Reactive Validator
Set up validators for your forms easily.

Package information: NPM version Package information: NPM license Package information: NPM downloads Package information: NPM dependencies status

Installation

In your Astro project:

npm i @astro-reactive/validator @astro-reactive/form

Usage

Use in an Astro page:

---
import Form, { FormControl, FormGroup } from "@astro-reactive/form";
import { Validators } from "@astro-reactive/validator";

const form = new FormGroup([
  {
    name: "username",
    label: "Username",
    validators: [Validators.required],
  },
  {
    name: "email",
    label: "Email",
    validators: [Validators.email, Validators.required],
  },
  {
    name: "password",
    label: "Password",
    type: "password",
    validators: [Validators.required, Validators.minLength(8)],
  },
]);

// you can insert a control at any point
form.controls.push(
  new FormControl({
    type: "checkbox",
    name: "is-awesome",
    label: "is Awesome?",
  })
);

---

<Form showValidationHints formGroups={form} />
<!-- 
  The `showValidationHints` attribute tells the Form component
  that you want to render validation hints. So far, these are:
    1. asterisks on required controls' labels
    2. controls with errors will become color red

  This property is optional and set to false by default,
  which keeps the Form component unstyled,
  and gives you have the freedom to style it yourself.
-->

Screenshots

Screen Shot 2022-10-15 at 1 31 11 PM

Validators available

  1. Validators.min(limit) - checks if number value is greater than or equal to limit
  2. Validators.max(limit) - checks if number value is less than or equal to limit
  3. Validators.required - checks if value is empty
  4. Validators.requiredChecked - checks if value is "checked"
  5. Validators.email - checks if value is a valid email
  6. Validators.minLength(limit) - checks if value length is greater than or equal to limit
  7. Validators.maxLength(limit) - checks if value length is less than or equal to limit

Form component

This validation library is designed to work with Astro Reactive Form, our package for generating dynamic forms.

We are opensource!

👉 All contributions are welcome. Let's make the validation library for Astro.

👉 This package is under rigorous development. See the change log.