type-safe-form v0.5.0

Type Safe Form

Type safe form for React.

:warning: This is alpha version at this moment. For production use library as formik. However, I welcome you to try this library and leave the issues.

Main motivation

• Type safe form.
  • No technical mistakes.
  • Full support of IDE intellisense.
• Less code.

I missed type connection between data and form. This package is inspired by formik.

Features / Roadmap

• Type Safe Form API
• Inputs
• Validation
• Custom inputs
• React native support
• Full documentation
• v1.0.0

Get started

Install

$ npm install --save type-form

Import

import { Form } from "type-safe-form";

Styles

Optional

Include basic styles of type-form inputs. It will not affect your styling.

import "react-type-form/styles.css";

Examples

In folder examples.

$ npm run example -- --entry ./examples/Inputs.tsx
$ npm run example -- --entry ./examples/Validation.tsx

import { Form } from "type-safe-form";

function InputsExample() {
  return (
    <Form
      initialValues={{
        name: "",
        age: 25,
        photo: { url: "" },
        date: new Date(),
        equipment: ["Bread"],
        confirm: false,
      }}
      onSubmit={async (values) => {
        console.log({ values });
        return "Sent";
      }}
    >
      {({ Input, values, message, isChanged, onSubmit }) => (
        <>
          <Input.Name />
          <Input.Age min={18} />
          <Input.Photo.File
              renderValue={value => <img style={{ height: "150px" }} src={value.url} />}
              onFiles={async files => ({ url: await toBase64(files[0]) })}
          />
          <Input.Date />
          <Input.Equipment>
            {({ Input, isFirst, onAdd, onRemove }) => (
              <>
                {isFirst && (
                  <button onClick={() => onAdd("NEW")}>Add equipment</button>
                )}
                <button onClick={onRemove}>Remove equipment</button>
                <Input label="Equipment" />
              </>
            )}
          </Input.Equipment>
          <Input.Confirm label="I agree with everything" />
          {message && <pre>{message}</pre>}
          <button onClick={onSubmit}>Send</button>
        </>
      )}
    </Form>
  );
}

Validation

There are implemented basic validations as validate* functions. You can validate on 3 levels.

In specific input

<Input.Name ... onValidate={async (value) => (value.length > 50 ? "Too long" : true)} />

On form

<Form ... onValidate={async values => values.name === "Jane" && values.age > 30 ? "Jane, you are too old" : true} />

With onSubmit

<Form ... onSubmit={async values => !values.confirm ? "You have to confirm" : await sendForm(values)} />

Input types

All can be nullable or/and select.

String

text

mail

password

textarea

Number

int

float

Boolean

checkbox

switch

Date

date

datetime

File

Array

Object