ajax views

vues ajax

Une application Django simple pour utiliser facilement les vues AJAX avec JavaScript.

Compatibilité

• django >= 3.2
• python >= 3,9

Caractéristiques

• Possibilité d'exposer vos URL AJAX à JavaScript
• Vues basées sur les fonctions et basées sur les classes prises en charge
• Un modèle d'URL pour les gouverner tous pour toutes les vues AJAX
• Prise en charge de Jinja2

Installation

Installez le package via Pip :

 pip install ajax-views

Ajoutez-le à votre liste INSTALLED_APPS :

 INSTALLED_APPS = (
    # ...
    "ajax_views" ,
    # ...
)

Ajoutez ajax_views.urls à votre URLconf :

 from django . urls import include , path

urlpatterns = [
    path ( "ajax/" , include ( "ajax_views.urls" )),
]

Usage

@ajax_view("nom")

Utilisez ce décorateur pour enregistrer vos vues (basées sur les fonctions ou basées sur les classes).

 from ajax_views . decorators import ajax_view

@ ajax_view ( "myapp.form" )
def form_view ( request ):
    ...

@ ajax_view ( "myapp.form_cbv" )
class AjaxFormView ( FormView ):
    ...

REMARQUE : Le nom spécifié doit être unique.

Vous pouvez combiner ajax_view avec d'autres décorateurs :

 @ csrf_exempt
@ require_POST
@ ajax_view ( "myapp.contact_form" )
def csrf_exempt_view ( request ):
    # ... 

{% ajax_views_json %}

Balise de modèle pour générer les URL enregistrées au format JSON.

 {% load ajax_views %}

<script>
    window.ajax_views = {% ajax_views_json %};
</script>

Vous pouvez maintenant utiliser l'objet déclaré pour faire référence aux URL correspondantes comme ceci :

 $ . ajax ( {
    url : window . ajax_views . myapp . form ,
    ...
} ) ; 

{% ajax_url 'nom' %}

Cette balise est utilisée pour ajouter des URL AJAX dans les fichiers modèles :

 {% load ajax_views %}

<form action="{% ajax_url 'myapp.form' %}" method="post">
    ...
</form>

Plusieurs noms

Vous pouvez avoir plusieurs noms pour la même vue :

 from ajax_views . decorators import ajax_view

@ ajax_view ([ "myapp.form" , "myapp.fallback" ])
def example_view ( request ):
    ...

Prise en charge de Jinja2

Activer l'extension Jinja2

 TEMPLATES = [
    {
        "BACKEND" : "django.template.backends.jinja2.Jinja2" ,
        "OPTIONS" : {
            "extensions" : [
                # ...
                "ajax_views.templatetags.ajax_views.AjaxViewsExtension" ,
            ]
        }
    }
]

REMARQUE : si vous utilisez Django-jinja, vous n'avez pas besoin de le faire.

L'utilisation est similaire à Django, sauf que ajax_url est une fonction globale :

< form action = " {{ ajax_url('myapp.form') }} " method = " post " >
    ...
</ form >