Skip to content

Latest commit

 

History

History

preact

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Felte: A form library for Preact

Tests Bundle size NPM Version codecov

Felte is an extensible form library originally built for Svelte but easily integrated with Preact using this package. Felte, on its most simple form, only requires you to set a ref to your form element to work. No custom Field or Form components are needed, making custom styles really easy to do. If you want to see it in action, you can check this CodeSandbox demo.

Features

  • Single action to make your form reactive.
  • Use HTML5 native elements to create your form. (Only the name attribute is necessary).
  • No re-renders at all unless you need to use a specific field's value within your component.
  • Provides stores and helper functions to handle more complex use cases.
  • No assumptions on your validation strategy. Use any validation library you want or write your own strategy.
  • Handles addition and removal of form controls during runtime.
  • Official solutions for error reporting using reporter packages.
  • Well tested. Currently at 99% code coverage and constantly working on improving test quality.
  • Supports validation with yup, zod and superstruct.
  • Easily extend its functionality.

Simple usage example

import { h } from 'preact';
import { useForm } from '@felte/preact';

function Form() {
  const { form } = useForm({
    onSubmit: (values) => console.log(values),
  });

  return (
    <form ref={form}>
      <input name="email" />
      <input name="password" type="password" />
      <button type="submit">Submit</button>
    </form>
  );
}

Installation

npm install --save @felte/preact

# Or, if you use yarn

yarn add @felte/preact

Usage

To learn more about how to use @felte/preact to handle your forms, check the official documentation. The API is exactly the same as @felte/react except for the import.