@arudovwen/form-builder-react 1.0.6 → 1.0.8

package/README.md

@@ -3,7 +3,7 @@
 
 The **Form Builder Package** is a reusable library designed to simplify the creation and management of dynamic forms in web applications. It provides a robust API and customizable components to streamline form-building workflows.
 
- **This package is still in development**
+> **Note**: This package is still in development.
 
 ## Features
 
@@ -20,10 +20,17 @@ Install the package via npm:
 ```bash
 npm install @arudovwen/form-builder-react
 ```
+
 ## Demo
 
-Check out the live demo of the Form Builder Package: [Form Builder Demo](https://form-builder-inky-nine.vercel.app/), 
-To view after saving : [Form Viewer ](https://form-builder-inky-nine.vercel.app/viewer)
+Explore the live demo of the Form Builder Package:  
+- [Form Builder Demo](https://form-builder-inky-nine.vercel.app/)  
+- [Form Viewer](https://form-builder-inky-nine.vercel.app/viewer)
+
+## GitHub Repository
+
+Find the source code and contribute to the project on GitHub:  
+[Form Builder GitHub Repository](https://github.com/arudovwen/Form.Builder)
 
 ## Usage
 
@@ -34,7 +41,6 @@ import React, { useState, useEffect } from "react";
 import { FormBuilder, FormViewer } from "@arudovwen/form-builder-react";
 import "@arudovwen/form-builder-react/dist/index.css";
 
-
 function App() {
   const [formData, setFormData] = useState(null);
   const [loading, setLoading] = useState(true);
@@ -61,28 +67,23 @@ function App() {
   };
 
   return (
-   
-     <>
-          <FormBuilder
-            onSubmit={(form_data: any) => console.log(form_data)}
-            config={config}
-          />
-      
-     
-          <FormViewer
-            onSubmit={(e: any) => console.log(e)}
-            form_data={formData}
-            anwserData={answerData}
-            config={config}
-            loading={loading}
-          />
-          </>
-      
+    <>
+      <FormBuilder
+        onSubmit={(form_data: any) => console.log(form_data)}
+        config={config}
+      />
+      <FormViewer
+        onSubmit={(e: any) => console.log(e)}
+        form_data={formData}
+        answerData={[]}
+        config={config}
+        loading={loading}
+      />
+    </>
   );
 }
 
 export default App;
-
 ```
 
 ### Props for `FormBuilder`
@@ -90,11 +91,12 @@ export default App;
 | Prop         | Type               | Description                                      |
 |--------------|--------------------|--------------------------------------------------|
 | `form_data`  | `FormElement[]`    | Array of form elements to render in the form.   |
-| `anwserData` | `any[]`            | Array of user-provided answers to the form.     |
+| `answerData` | `any[]`            | Array of user-provided answers to the form.     |
 | `config`     | `object`           | Configuration object (e.g., `buttonColor`, `loaderColor`). |
 | `onSubmit`   | `(data: any) => void` | Callback function triggered when the form is submitted. |
 | `loading`    | `boolean`          | Indicates whether the form is in a loading state. |
 | `isReadOnly` | `boolean`          | Determines if the form is rendered in read-only mode. |
+| `renderType` | `string`           | Determines the style the form is rendered, either `multi` or `single`. |
 
 ### Form Element Types
 
@@ -114,8 +116,8 @@ To contribute or modify the package:
 1. Clone the repository:
 
    ```bash
-   git clone https://github.com/your-username/form-builder.git
-   cd form-builder
+   git clone https://github.com/arudovwen/Form.Builder.git
+   cd Form.Builder
    ```
 
 2. Install dependencies:
@@ -160,4 +162,4 @@ Contributions are welcome! Please fork the repository, create a feature branch,
 ---
 
 Happy form building!
-```
+