ajax views

Ajax-Ansichten

Eine einfache Django-Anwendung zur einfachen Verwendung von AJAX-Ansichten mit JavaScript.

Kompatibilität

• django >= 3.2
• python >= 3.9

Merkmale

• Möglichkeit, Ihre AJAX-URLs für JavaScript verfügbar zu machen
• Unterstützte funktionsbasierte und klassenbasierte Ansichten
• Ein URL-Muster um sie alle zu beherrschen für alle AJAX-Ansichten
• Jinja2-Unterstützung

Installation

Installieren Sie das Paket über Pip:

 pip install ajax-views

Fügen Sie es Ihrer INSTALLED_APPS -Liste hinzu:

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

Fügen Sie ajax_views.urls zu Ihrer URLconf hinzu:

 from django . urls import include , path

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

Verwendung

@ajax_view("name")

Verwenden Sie diesen Dekorator, um Ihre Ansichten zu registrieren (funktionsbasiert oder klassenbasiert).

 from ajax_views . decorators import ajax_view

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

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

HINWEIS : Der angegebene Name muss eindeutig sein.

Sie können ajax_view mit anderen Dekoratoren kombinieren:

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

{% ajax_views_json %}

Template-Tag zur Ausgabe registrierter URLs als JSON.

 {% load ajax_views %}

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

Jetzt können Sie das deklarierte Objekt verwenden, um wie folgt auf die entsprechenden URLs zu verweisen:

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

{% ajax_url 'name' %}

Dieses Tag wird verwendet, um AJAX-URLs in den Vorlagendateien hinzuzufügen:

 {% load ajax_views %}

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

Mehrere Namen

Sie können mehrere Namen für dieselbe Ansicht verwenden:

 from ajax_views . decorators import ajax_view

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

Jinja2-Unterstützung

Aktivieren Sie die Jinja2-Erweiterung

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

HINWEIS : Wenn Sie Django-Jinja verwenden, müssen Sie dies nicht tun.

Die Verwendung ähnelt Django, außer dass ajax_url eine globale Funktion ist:

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