astro-reactive-form/packages/form
2023-01-11 19:09:35 +01:00
..
components docs(form): update Form properties and respective documentation (#248) 2023-01-04 13:43:50 +01:00
core feat: Types and Intellisense Improvements (#231) 2022-12-07 20:56:27 +01:00
test feat(form): add form action for submit (#237) 2022-12-27 20:42:34 +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 feat: sharing config files (#253) 2023-01-11 19:09:35 +01:00
.prettierrc.cjs feat: create astro reactive validator (#90) 2022-10-15 16:32:02 +02:00
index.ts refactor: form package cleanup (#135) 2022-10-23 23:04:40 +02:00
package.json feat: sharing config files (#253) 2023-01-11 19:09:35 +01:00
README.md docs(form): update Form properties and respective documentation (#248) 2023-01-04 13:43:50 +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 feat: sharing config files (#253) 2023-01-11 19:09:35 +01: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 Form
Generate a dynamic form based on your data, and modify programmatically.

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/form

Usage

Use in an Astro page:

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

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

// set the name optionally
form.name = "Simple Form";

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

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

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

<Form
  formGroups={form}
  submitControl={{
    type: "submit",
    name: "submit",
  }}
/>
<!-- 
  The `formGroups` attribute can take a single FormGroup
  or an array of FormGroup for multiple fieldset blocks;
  we are using a single FormGroup for now in this example.
-->

Screenshots

Result of example above:

Screen Shot 2022-10-08 at 10 38 04 PM

Example of multiple form groups:

Screen Shot 2022-09-27 at 10 44 03 PM

Validation

This Form component is designed to work with Astro Reactive Validator, our package for setting up validators easily.

We are opensource!

👉 All contributions are welcome. Let's make the fastest web forms powered by Astro.

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