documented the form class based view

Author: amirreza8002

docs/views/async-class-based-views/edit.md

@@ -0,0 +1,65 @@
+## Generic editing views
+
+### AsyncFormView
+
+`AsyncFormView` works like django's [FormView](https://docs.djangoproject.com/en/5.1/ref/class-based-views/generic-editing/#formview)
+but the inheritance tree has changed to work asynchronously:
+
+* [TemplateResponseMixin](https://docs.djangoproject.com/en/5.1/ref/class-based-views/mixins-simple/#django.views.generic.base.TemplateResponseMixin)
+* [AsyncBaseFormView](...)
+* [AsyncFormMixin](mixins-editing.md#asyncformmixin)
+* [AsyncProcessFormMixin](mixins-editing.md#asyncprocessformview)
+* [AsyncView](base.md#asyncview)
+* [View](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#django.views.generic.base.View)
+
+
+*Example myapp/forms.py*
+```python
+from django import forms
+
+class ContactForm(forms.Form):
+    name = forms.CharField()
+    message = forms.CharField(widget=forms.Textarea)
+
+    def send_email(self):
+        # send some email
+        pass
+```
+
+*Example myapp/views.py*
+```python
+from myapp.forms import ContactForm
+from django_async_extensions.aviews.generic.edit import AsyncFormView
+
+
+class ContactFormView(AsyncFormView):
+    template_name = "contact.html"
+    form_class = ContactForm
+    success_url = "/thanks/"
+
+    async def form_valid(self, form):
+        # This method is called when valid form data has been POSTed.
+        # It should return an HttpResponse.
+        form.send_email()
+        return await super().form_valid(form)
+```
+
+*Example myapp/contact.html*
+```html
+<form method="post">{% csrf_token %}
+    {{ form.as_p }}
+    <input type="submit" value="Send message">
+</form>
+```
+
+## Base Class
+
+### AsyncBaseFormView
+A base view for displaying a form. It is not intended to be used directly,
+but rather as a parent class of the django_async_extensions.aviews.generic.edit.AsyncFormView or other views displaying a form.
+
+similar to django's [BaseFormView](https://docs.djangoproject.com/en/5.1/ref/class-based-views/generic-editing/#django.views.generic.edit.BaseFormView)
+but the ancestors are different:
+
+* [AsyncFormMixin](mixins-editing.md#asyncformmixin)
+* [AsyncProcessFormMixin](mixins-editing.md#asyncprocessformview)

docs/views/async-class-based-views/mixins-editing.md

@@ -0,0 +1,28 @@
+## AsyncFormMixin
+
+A mixin class that provides facilities for creating and displaying forms.
+
+`AsyncFormMixin` is similar to django's [FormMixin](https://docs.djangoproject.com/en/5.1/ref/class-based-views/mixins-editing/#django.views.generic.edit.FormMixin)
+with a number of differences:
+
+1. `get_form_class()` method is async.
+2. `get_form()` method is async.
+3. `form_valid()` method is async.
+4. `form_invalid()` method is async.
+5. `get_context_data()` is async.
+
+
+## AsyncModelFormMixin
+A form mixin that works on ModelForms, rather than a standalone form.
+
+`AsyncModelFormMixin` similar to django's [ModelFormMixin](https://docs.djangoproject.com/en/5.1/ref/class-based-views/mixins-editing/#modelformmixin)
+with a number of differences:
+
+1. `AsyncModelFormMixin` inherits from [AsyncFormMixin](mixins-editing.md#asyncformmixin) and [AsyncSingleObjectMixin](detail.md#asyncsingleobjectmixin) so anything mentioned on those classes also applies here.
+2. `get_form_class()` method is async.
+
+## AsyncProcessFormView
+A mixin that provides basic HTTP GET and POST workflow.
+
+`AsyncProcessFormView` works similar to django's [ProcessFormView](https://docs.djangoproject.com/en/5.1/ref/class-based-views/mixins-editing/#processformview),
+but it inherits from [AsyncView](base.md#asyncview) and all the http methods are async.