django-forms-frontend-validation 1.0.3__py3-none-any.whl → 1.0.5__py3-none-any.whl

{django_forms_frontend_validation-1.0.3.dist-info → django_forms_frontend_validation-1.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-forms-frontend-validation
-Version: 1.0.3
+Version: 1.0.5
 Summary: A Django app for front-end form validation
 Home-page: https://github.com/andrew-kyle92/django-forms-frontend-validation
 Author: Andrew Kyle
@@ -34,11 +34,13 @@ The application is designed to streamline the process of form validation, ensuri
   - Includes CSRF token management for secure AJAX-based form submissions.
 
 ## Usage
+### Installation
+1. Install the Django project
+    ```cmd
+   pip install django-frontend-forms-validation
+   ```
 ### Setting Up
-1. Include Required Components:
-   - Include the JavaScript files in your project to enable client-side functionality.
-   - Ensure `form_utils.py` is imported and accessible in your Django app.
-2. Define Settings in settings.py
+1. Define Settings in settings.py
    - Add `formvalidator` to installed apps.
       ```python
       INSTALLED_APPS = [
@@ -54,7 +56,7 @@ The application is designed to streamline the process of form validation, ensuri
       IGNORE_VALIDATION = ['example-ignore-validation', ...]
       VALIDATE_ONLY_ON_SUBMIT = ['all']  # Options: "__all__", specific class names, or leave empty.
       ```
-3. Initial Forms:
+2. Initial Forms:
    - Ensure the `_InitializeForms` method is called during page load to attach validation logic to forms dynamically.
    To your HTML template with the form, add this.
    ```html
@@ -74,7 +76,7 @@ The application is designed to streamline the process of form validation, ensuri
     });
    </script>
    ```
-4. Server-Side Context:
+3. Server-Side Context:
    - Use the `FormsValidator` class to pass configuration to templates:
    ```python
     from formvalidator.form_utils import FormsValidator
@@ -87,3 +89,39 @@ The application is designed to streamline the process of form validation, ensuri
         }    
         return render(request, 'my_template.html', context)
    ```
+4. Add `div` Groups to the HTML Form:
+   - The JavaScript in this project relies on each form field being wrapped inside an outer div with the classname of ```form-group```.
+   - It helps set apart each input from other inputs within the form.
+   - Here is an example of the setup:
+   ```html
+    <form ...>
+        {% csrf_token %}
+   
+        <div class="form-group">
+            <label for="field1">Field 1</label>
+            <input type="text" name="field1">
+        </div>
+   
+        <div class="form-group">
+            <label for="field2">Field 1</label>
+            <input type="text" name="field2">
+        </div>
+        
+        <-- Adding the rest of the form groups below -->
+        ...
+    </form>
+    ```
+   - If iterating through each form input using the ```form``` context variable:
+    ```html
+    <form ...>
+        {% csrf_token %}
+        
+        <-- iterating through each form field -->
+        {% for field in form %}
+            <div class="form-group">
+                <label for="{{ field.name }}">{{ field.label }}</label>
+                {{ field }}
+            </div>
+        {% endfor %}
+    </form>
+    ```

{django_forms_frontend_validation-1.0.3.dist-info → django_forms_frontend_validation-1.0.5.dist-info}/RECORD

@@ -21,8 +21,8 @@ formvalidator/templates/base.html,sha256=husejzZpyn7DKk-3S6frsalTMz4-ZO5EV5GWobW
 formvalidator/templates/formvalidator/sample.html,sha256=IKklx25wt-paXmfaMbSZfTZaWFzlq_BGMOuVKACNpyI,2048
 formvalidator/templates/formvalidator/sample2.html,sha256=_E5Rtv4fWOut5dbpRsguoEUw-X_Hln6wok4g2KPlzCo,2129
 formvalidator/templates/includes/header.html,sha256=5EWbHxj-JFu7fzmGUWWqOxoG2bwl03UwwUG_O68qzj0,946
-django_forms_frontend_validation-1.0.3.dist-info/LICENSE,sha256=gA3cqug2Eqh9zkbcEDQ1Ez1APddDnmbX6bO6_wcBRM8,1095
-django_forms_frontend_validation-1.0.3.dist-info/METADATA,sha256=CBcTNNGQmUCUWmrWMIXpfcd8nHVBm7gduXzM3QzBr1s,4028
-django_forms_frontend_validation-1.0.3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-django_forms_frontend_validation-1.0.3.dist-info/top_level.txt,sha256=E9SLf9Mg8MAqnCin_sgh__XTquz_st_-Qyy9w3-3fms,14
-django_forms_frontend_validation-1.0.3.dist-info/RECORD,,
+django_forms_frontend_validation-1.0.5.dist-info/LICENSE,sha256=gA3cqug2Eqh9zkbcEDQ1Ez1APddDnmbX6bO6_wcBRM8,1095
+django_forms_frontend_validation-1.0.5.dist-info/METADATA,sha256=kSXSZ8Qzv7JojQleBT7Sww0Wed-QagqPsSuVkDtUirY,5091
+django_forms_frontend_validation-1.0.5.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+django_forms_frontend_validation-1.0.5.dist-info/top_level.txt,sha256=E9SLf9Mg8MAqnCin_sgh__XTquz_st_-Qyy9w3-3fms,14
+django_forms_frontend_validation-1.0.5.dist-info/RECORD,,