solid-hook-form 1.1.0 → 1.1.2

package/README.md

@@ -1,39 +1,53 @@
-# solid-hook-form
+# Solid Hook Form
 
-```tsx
-import { useForm } from "solid-hook-form";
+### Playground
+
+[<img width="1171" alt="Screenshot 2025-04-05 at 15 01 47" src="https://github.com/user-attachments/assets/072eb398-85fa-4240-b305-dcbbe9c0a9c8" />](https://solid-hook-form.vercel.app/)
+
+### Install
 
-const { errors, isValid, register, onSubmit } = useForm({
-  defaultValues: {
-    date: new Date().toISOString().split("T")[0],
-    email: "",
-    password: "",
-    age: 0,
-    remember: false,
-  },
-});
+```sh
+npm install solid-hook-form
 ```
 
+### Quickstart
+
 ```tsx
-<form onSubmit={onSubmit(handleSubmit)}>
-  <input type="date" {...register("date", { required: "Required" })} />;
-  <input
-    {...register("email", {
-      required: "Required",
-      pattern: {
-        value: /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
-        message: "Invalid email",
-      },
-    })}
-  />
-  <input
-    {...register("password", {
-      required: "Required",
-      minLength: { value: 8, message: "Min 8" },
-    })}
-  />
-  <input type="number" {...register("age", { min: 18, max: 100 })} />
-  <input type="checkbox" {...register("remember", { required: "Required" })} />
-  <button type="submit">Submit</button>
-</form>
+import { useForm } from "solid-hook-form";
+
+const Form = () => {
+  const { errors, isValid, register, onSubmit } = useForm({
+    defaultValues: {
+      date: new Date().toISOString().split("T")[0],
+      email: "",
+      password: "",
+      age: 0,
+      remember: false,
+    },
+  });
+
+  return (
+    <form onSubmit={onSubmit(handleSubmit)}>
+      <input type="date" {...register("date", { required: "Required" })} />;
+      <input
+        {...register("email", {
+          required: "Required",
+          pattern: {
+            value: /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
+            message: "Invalid email",
+          },
+        })}
+      />
+      <input
+        {...register("password", {
+          required: "Required",
+          minLength: { value: 8, message: "Min 8" },
+        })}
+      />
+      <input type="number" {...register("age", { min: 18, max: 100 })} />
+      <input type="checkbox" {...register("remember", { required: "Required" })} />
+      <button type="submit">Submit</button>
+    </form>
+  );
+};
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solid-hook-form",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "type": "module",
   "main": "./dist/main.umd.cjs",
   "module": "./dist/main.js",
@@ -34,7 +34,7 @@
   },
   "author": "thorn_pear",
   "license": "ISC",
-  "description": "Performant, flexible and extensible forms library for Solid",
+  "description": "Performant, flexible and extensible forms with easy to use validation",
   "repository": {
     "type": "git",
     "url": "https://github.com/tatsmaki/solid-hook-form.git"