rfhook 1.1.0 → 1.1.2

package/README.md

@@ -4,13 +4,13 @@ A lightweight React hook for handling form submissions with advanced form data p
 
 ## Features
 
-- 🚀 **Simple API** - Just one hook to handle all your form needs
-- 🎯 **TypeScript Support** - Fully typed with generic support
-- 🔧 **Nested Objects** - Parse nested form data with dot notation (`user.name`)
-- 📋 **Array Support** - Handle arrays with indexed notation (`items[0]`)
-- �️ **Automatic Prevention** - Prevents default form submission behavior by default
-- �📦 **Lightweight** - Zero dependencies (except React)
-- 🎨 **Framework Agnostic** - Works with any form structure
+- :rocket: **Simple API** - Just one hook to handle all your form needs
+- :dart: **TypeScript Support** - Fully typed with generic support
+- :wrench: **Nested Objects** - Parse nested form data with dot notation (`user.name`)
+- :clipboard: **Array Support** - Handle arrays with indexed notation (`items[0]`)
+- :floppy_disk: **Automatic Prevention** - Prevents default form submission behavior by default
+- :money_with_wings: **Lightweight** - Zero dependencies (except React)
+- :memo: **Framework Agnostic** - Works with any form structure
 
 ## Installation
 
@@ -38,19 +38,23 @@ interface FormData {
 }
 
 function LoginForm() {
-  const { ref, submit } = useForm<FormData>({
-    handleSubmit: (data) => {
+  const { ref, onSubmit } = useForm<FormData>({
+    submit: (data) => {
       console.log(data); // { email: "user@example.com", password: "secret" }
     }
   });
 
   return (
-    <form ref={ref} onSubmit={submit}>
+    <form ref={ref} onSubmit={onSubmit}>
       <input name="email" type="email" />
       <input name="password" type="password" />
       <button type="submit">Login</button>
     </form>
   );
+}
+      <button type="submit">Login</button>
+    </form>
+  );
 }
 ```
 
@@ -74,8 +78,8 @@ interface UserForm {
 }
 
 function UserForm() {
-  const { ref, submit } = useForm<UserForm>({
-    handleSubmit: (data) => {
+  const { ref, onSubmit } = useForm<UserForm>({
+    submit: (data) => {
       console.log(data);
       // {
       //   user: {
@@ -92,7 +96,7 @@ function UserForm() {
   });
 
   return (
-    <form ref={ref} onSubmit={submit}>
+    <form ref={ref} onSubmit={onSubmit}>
       <input name="user.profile.name" placeholder="Name" />
       <input name="user.profile.age" type="number" placeholder="Age" />
       <select name="user.preferences.theme">
@@ -118,8 +122,8 @@ interface TodoForm {
 }
 
 function TodoForm() {
-  const { ref, submit } = useForm<TodoForm>({
-    handleSubmit: (data) => {
+  const { ref, onSubmit } = useForm<TodoForm>({
+    submit: (data) => {
       console.log(data);
       // {
       //   todos: [
@@ -131,7 +135,7 @@ function TodoForm() {
   });
 
   return (
-    <form ref={ref} onSubmit={submit}>
+    <form ref={ref} onSubmit={onSubmit}>
       <input name="todos[0].title" placeholder="First todo" />
       <input name="todos[0].completed" type="checkbox" />
 
@@ -150,12 +154,59 @@ function TodoForm() {
 
 #### Parameters
 
-- `options.handleSubmit: (data: T) => void` - Callback function called when form is submitted
+- `options.submit: (data: T) => void` - Callback function called when form is submitted with parsed form data
 
 #### Returns
 
-- `ref: RefObject<HTMLFormElement>` - React ref to attach to your form element
-- `submit: (event: React.FormEvent) => void` - Submit handler to attach to form's `onSubmit`
+- `ref: React.RefObject<HTMLFormElement>` - React ref to attach to your form element
+- `onSubmit: (event: React.FormEvent<HTMLFormElement>) => void` - Form submission handler that prevents default behavior and calls submit with parsed data
+- `reset: () => void` - Resets the form to its initial state
+- `getFormData: () => T | null` - Gets current form data without triggering submission (returns null if form ref is not available)
+- `setValue: (name: string, value: string) => void` - Sets the value of a specific form field by name
+
+### Additional Usage Examples
+
+#### Using Form Utilities
+
+```tsx
+function MyForm() {
+  const form = useForm<FormData>({
+    submit: (data) => console.log('Submitted:', data)
+  });
+
+  const handleReset = () => {
+    form.reset(); // Reset form to initial state
+  };
+
+  const handlePreview = () => {
+    const currentData = form.getFormData();
+    if (currentData) {
+      console.log('Current form data:', currentData);
+    }
+  };
+
+  const handlePrefill = () => {
+    form.setValue('email', 'user@example.com');
+    form.setValue('name', 'John Doe');
+  };
+
+  return (
+    <>
+      <form ref={form.ref} onSubmit={form.onSubmit}>
+        <input name="name" placeholder="Name" />
+        <input name="email" type="email" placeholder="Email" />
+        <button type="submit">Submit</button>
+      </form>
+
+      <div>
+        <button onClick={handleReset}>Reset Form</button>
+        <button onClick={handlePreview}>Preview Data</button>
+        <button onClick={handlePrefill}>Prefill Form</button>
+      </div>
+    </>
+  );
+}
+```
 
 ### Form Data Parsing Rules
 
@@ -183,8 +234,8 @@ interface ContactData {
 }
 
 function ContactForm() {
-  const { ref, submit } = useForm<ContactData>({
-    handleSubmit: async (data) => {
+  const { ref, onSubmit } = useForm<ContactData>({
+    submit: async (data) => {
       try {
         const response = await fetch('/api/contact', {
           method: 'POST',
@@ -202,7 +253,7 @@ function ContactForm() {
   });
 
   return (
-    <form ref={ref} onSubmit={submit}>
+    <form ref={ref} onSubmit={onSubmit}>
       <input name="name" placeholder="Your Name" required />
       <input name="email" type="email" placeholder="Your Email" required />
       <textarea name="message" placeholder="Your Message" required />

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "rfhook",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/evandroishikawa/rfhook.git"
+  },
   "type": "module",
   "types": "dist/index.d.ts",
   "keywords": [],