update a django form with jquery/ajax

Question

I want to update a form on the change event of my drop down list.

Here is my view:

from django.utils import simplejson
response_dic={}
#drop down list
ac         


        

Answer 1

To update a django form with jquery/ajax, here is my method... Three key points: put your form template in a separate html page, use render_to_string in your view and send an html response to ajax.

index.html page:

{% extends "base.html" %}

{% block content %}
    <!-- you can put here everything that doesn't need to be updated (text, css inclusion, etc.) -->
    <!-- act validation form -->
    <form id="act_ids_form"  class="form-inline" action="{% url act_ids %}" method="post">{% csrf_token %}
            <!-- drop down list -->
            <div id="actsToValidateChoice" class="fieldWrapper">
                  {{ add_form.actsToValidate.errors }}
                  {{ add_form.actsToValidate }}
            </div>
            <!-- div to update the part of the form that must be updated -->
            <div id="act_ids_form_div">{% include form_template %}</div>
    </form>

{% endblock %}

forms.py:

class ActsAddForm(forms.Form):
        #drop down list      
        actsToValidate=forms.ModelChoiceField(queryset=ActsIdsModel.objects.filter(validated=0), empty_label="Select an act to validate", widget=forms.Select(attrs={'onchange': 'display_act_ids()'}))

form.html:

<!-- act ids form -->
<!-- put here everything that must be updated on the change of your drop down list -->
<div class="row-fluid">{{ ids_form.non_field_errors }}</div>

{% if act.councilPath %}
        <div class="row-fluid"><a class="info_msg" href="{{act.councilPath}}" target="_blank">{{ displayName.councilPath }}</a></div>
{% endif %}

<table class="table table-bordered table-hover table-condensed span12">
        <tr>
            {% for field in ids_form %}
                <td>
                    <div class="fieldWrapper">
                        {{ field.errors }}
                        {{ field }}
                    </div>
                </td>
            {% endfor %}
        </tr>
</table>

urls.py:

from django.conf.urls import patterns, url

urlpatterns = patterns('actsIdsValidation.views',
    url(r'^/?$', 'act_ids', name='act_ids'),
    url(r'^form.html$', 'act_ids', name='act_ids'),
)

views.py:

def act_ids(request):
    response_dic={}
    #html page of the form
    form_template='actsIdsValidation/form.html'

    if request.method == 'POST':
        #if drop down list not empty
        if request.POST["actsToValidate"]!="":
            #add form: contains the drop down list only
            add_form = ActsAddForm(request.POST);
            actToValidateId=request.POST["actsToValidate"].pk
            act=ActsIdsModel.objects.get(id=actToValidateId)
            ids_form = ActsIdsForm(instance=act)
            response_dic['ids_form']=ids_form
            response_dic['act']=act

            return HttpResponse(render_to_string(form_template, response_dic, RequestContext(request)))

    #GET
    #unbound ids_form
    response_dic['ids_form'] = ActsIdsForm()
    response_dic['add_form'] = ActsAddForm()
    response_dic['form_template'] = form_template
    return render_to_response('actsIdsValidation/index.html', response_dic, context_instance=RequestContext(request))

Ajax call:

function display_act_ids()
{
    $form=$('#act_ids_form');
    var datastring = $form.serialize();
    $.ajax({
        type: "POST",
        url: $form.attr('action'),
        dataType: 'html',
        data: datastring,
        success: function(result)
        {
            /* The div contains now the updated form */
            $('#act_ids_form_div').html(result);
        }
    });

    //don't submit the form
    return false;
}

Voila !