astro-reactive-form/packages/astro-reactive-form/README.md

Astro Reactive Form 🔥

The Reactive Form component for Astro 🔥

All contributions are welcome.

Installation

npm i astro-reactive-form

Usage

---
import { FormControl, FormGroup } from "astro-reactive-form/core";
import Form from "astro-reactive-form";

// create a form group (rendered as <fieldset>)
const form = new FormGroup([
  {
    name: "username",
    label: "Username",
  },
  {
    name: "password",
    label: "Password",
    type: "password",
  },
]);

// set the name (rendered as <legend>)
form.name = "Simple Form";

// insert a control
form.controls.push(
  new FormControl({
    type: "checkbox",
    name: "is-awesome",
    label: "is Awesome?",
    labelPosition: "right",
  })
);

// get a FormControl object
const userNameControl = form.get("username");

// set values dynamically
userNameControl?.setValue("RAMOOOON");
form.get('is-awesome')?.setValue("checked");
---

<!-- the formGroups attribute takes an array of FormGroup-->
<Form formGroups={[form]} />

Screenshots

Result of example above:

Example of multiple form groups:

Future Plans

Currently this only supports very basic form creation, but the goal of the project is ambitious:

1. Validator library for common validation scenarios
   1. Client-side validation
   2. Server-side validation
   3. validation hooks - onFocus, onBlur, onSubmit
2. Themes - unstyled, light mode, dark mode, compact, large
3. FormGroup class
   1. statusChanges - observable that emits the form status when it changes
   2. valueChanges - observable that emits the values of all controls when they change
4. FormControl class
   1. statusChanges - observable that emits the control status when it changes
   2. valueChanges - observable that emits the control value when it changes
   3. value - property that reflects the control value
5. Documentation website

... and so much more

All contributions are welcome. Let's make the fastest web form component powered by Astro