https://github.com/lpil/formal
https://github.com/lpil/formal
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/lpil/formal
- Owner: lpil
- Created: 2024-02-27T22:13:27.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-29T10:46:36.000Z (about 2 years ago)
- Last Synced: 2024-05-01T23:04:56.702Z (almost 2 years ago)
- Language: Gleam
- Size: 9.77 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-gleam - formal - [📚](https://hexdocs.pm/formal/) - Type safe HTML form decoding and validation! (Packages / HTML)
README
# formal
Type safe HTML form decoding and validation!
[](https://hex.pm/packages/formal)
[](https://hexdocs.pm/formal/)
```sh
gleam add formal@3
```
```gleam
import formal/form
// Define a type that is to be decoded from the form data
pub type SignUp {
SignUp(email: String, password: String)
}
/// A form that decodes the `Signup` value.
fn signup_form() -> Form(Signup) {
form.new({
use email <- form.field("email", {
form.parse_email
})
use password <- form.field("password", {
form.parse_string
|> form.check_string_length_more_than(7)
})
use _ <- form.field("confirm", {
form.parse_string
|> form.check_confirms(password)
})
form.success(SignUp(email: email, password: password))
})
}
// This function takes the list of key-value string pairs that a HTML form
// produces. It then decodes the form data into a SignUp value, ensuring that
// all the fields are present and valid.
//
pub fn handle_form_submission(values: List(#(String, String))) {
let result =
signup_form()
|> form.add_values(values)
|> form.run
case result {
Ok(data) -> {
// Do something with the SignUp value here
}
Error(form) -> {
// Re-render the form with the error messages
}
}
}
```
## Examples
- [Backend example with Wisp](https://github.com/lpil/formal/tree/main/examples/backend-with-wisp)
- [Frontend example with Lustre](https://github.com/lpil/formal/tree/main/examples/frontend-with-lustre)
Further documentation can be found at .