hono-forms

A form builder and validator library for Hono applications

Description

hono-forms is a powerful and flexible library designed to simplify form creation and validation in Hono applications. It provides an intuitive API for building forms, generating HTML, and handling form submissions with built-in validation using Zod.

Features

• Easy-to-use form builder API
• Automatic HTML generation for forms
• Built-in validation using Zod
• TypeScript support
• Seamless integration with Hono applications

Installation

1npm install hono-forms

Usage

Here's a basic example of how to use hono-forms:

1import { Hono } from "hono"
2import { FormBuilder } from "hono-forms"
3
4const app = new Hono()
5
6const loginForm = new FormBuilder("/login", "POST")
7	.addText("username", "Username", { minLength: 3, maxLength: 20 })
8	.addPassword("password", "Password", { minLength: 8 })
9	.setSuccessHandler(async (c) => {
10		// Handle successful form submission
11		return c.text("Login successful")
12	})
13	.setErrorHandler(async (c, error) => {
14		// Handle validation errors
15		return c.text(`Login failed: ${error.message}`)
16	})
17	.build()
18
19app.get("/login", (c) => c.html(loginForm.render()))
20loginForm.decorateRoute(app)
21
22export default app

API Reference

FormBuilder

The main class for building forms.

Methods

• addText(name: string, label: string, options?: TextFieldOptions): FormBuilder
• addPassword(name: string, label: string, options?: PasswordFieldOptions): FormBuilder
• addEmail(name: string, label: string, options?: EmailFieldOptions): FormBuilder
• addNumber(name: string, label: string, options?: NumberFieldOptions): FormBuilder
• addCheckbox(name: string, label: string, options?: CheckboxFieldOptions): FormBuilder
• addSelect(name: string, label: string, options: SelectFieldOptions): FormBuilder
• setSuccessHandler(fn: SuccessHandler): FormBuilder
• setErrorHandler(fn: ErrorHandler): FormBuilder
• build(): Form

Form

The result of building a form with FormBuilder.

Methods

• render(options?: RenderOptions): string
• decorateRoute(app: Hono): void

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the 0BSD License - see the LICENSE file for details.

Author

Bjorn Pagen 11238136+bjornpagen@users.noreply.github.com

Links

• GitHub Repository
• npm Package
• Hono Framework
• Zod Validation Library