ajax views

ajax-представления

Простое приложение Django, позволяющее легко использовать представления AJAX с JavaScript.

Совместимость

• django >= 3.2
• python >= 3.9

Функции

• Возможность предоставлять URL-адреса AJAX для JavaScript.
• Поддерживаемые представления на основе функций и классов
• Один шаблон URL править ими всеми для всех представлений AJAX
• Поддержка Джинджа2

Установка

Установите пакет через Pip:

 pip install ajax-views

Добавьте его в свой список INSTALLED_APPS :

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

Добавьте ajax_views.urls в ваш URLconf:

 from django . urls import include , path

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

Использование

@ajax_view("имя")

Используйте этот декоратор для регистрации ваших представлений (на основе функций или классов).

 from ajax_views . decorators import ajax_view

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

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

ПРИМЕЧАНИЕ . Указанное имя должно быть уникальным.

Вы можете комбинировать ajax_view с другими декораторами:

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

{% ajax_views_json %}

Тег шаблона для вывода зарегистрированных URL-адресов в формате JSON.

 {% load ajax_views %}

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

Теперь вы можете использовать объявленный объект для ссылки на соответствующие URL-адреса следующим образом:

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

{% ajax_url 'имя' %}

Этот тег используется для добавления URL-адресов AJAX в файлы шаблонов:

 {% load ajax_views %}

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

Несколько имен

У одного и того же представления может быть несколько имен:

 from ajax_views . decorators import ajax_view

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

Поддержка Джинджа2

Включить расширение Jinja2

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

ПРИМЕЧАНИЕ . Если вы используете django-jinja, вам не нужно этого делать.

Использование похоже на Django, за исключением того, что ajax_url — глобальная функция:

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