ayo/astro-reactive-form
ayo/astro-reactive-form
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update astro-reactive-form readme (#72)

Browse source 
* docs: update astro-reactive-form readme

* docs: formatting
This commit is contained in:
Ayo Ayco 2022-10-08 22:46:21 +02:00 committed by GitHub
parent 0acc1968c1
commit 06f53bc78f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
packages/astro-reactive-form/README.md
View file

@ -62,16 +62,24 @@ userNameControl?.setValue("RAMOOOON");
form.get('is-awesome')?.setValue("checked");
---
<!-- the formGroups attribute takes an array of FormGroup-->
<Form formGroups={[form]} />
<!--
the `formGroups` attribute can take a single FormGroup
or an array of FormGroup for multiple fieldsets;
we do a single for now in this example
-->
<Form
formGroups={form}
submitControl={{
type: "submit",
name: "submit",
}}
/>
```
# Screenshots
Result of example above:
<img width="535" alt="Screen Shot 2022-10-01 at 7 29 00 PM" src="https://user-images.githubusercontent.com/4262489/193421174-5c604aca-7d16-4cd6-a7b1-f5b8752c838e.png">
![Screen Shot 2022-10-08 at 10 38 04 PM](https://user-images.githubusercontent.com/4262489/194726969-bdddefdf-d582-4201-a40e-3798383f03a0.png)
Example of multiple form groups:
@ -92,7 +100,6 @@ Currently this only supports very basic form creation, but the goal of the proje
1. FormControl class
1. `statusChanges` - observable that emits the control status when it changes
1. `valueChanges` - observable that emits the control value when it changes
1. `value` - property that reflects the control value
1. Documentation website
... and so much more