Skip to content

Commit

Permalink
feat: release & describe features
Browse files Browse the repository at this point in the history
  • Loading branch information
MiroslavPetrik committed Feb 5, 2024
1 parent 32fe8d6 commit 0562af0
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,23 @@

End-to-end typesafe success, error & validation state control for Next.js 14 form actions.

## Features

**Action Creator**

- ✅ Provides `"invalid" | "success" | "failure"` response objects.
- ✅ Define generic payload for each of the response type.

**Form Action builder**

- ✅ tRPC-like builder API for `.input(zodSchema)` & context `.use(middleware)`
- ✅ Parses `formData` with [`zod-form-data`](https://www.npmjs.com/package/zod-form-data)

**Stateful `<Form />`**

-`<Form />` component reads the action's response.
- ✅ Computes progress meta-state like `isInvalid`, `isSuccess` and more.

## Install

```
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-form-action",
"version": "0.2.0",
"version": "0.3.0",
"description": "State management helpers for the react form actions.",
"repository": {
"type": "git",
Expand Down

0 comments on commit 0562af0

Please sign in to comment.