django-easy-pjax 1.3.0

什么是pjax？

pjax利用pushstate和ajax将html从服务器加载到当前 页面没有完全重新加载。它是ajax，有真正的永久链接，页面标题， 以及一个完全退化的后退按钮。

Check out the demo说明了这个概念 在实践中，查看jquery-pjax的文档以获取更多信息。

django-easy-pjax应用程序是一个帮助程序，它使集成变得容易 jquery-pjax与您的django 1.5+网站。

快速启动

首先在requirements.txt文件中包含django-easy-pjax==1.3， 将easy_pjax添加到INSTALLED APPS中，并确保 django.template.context_processors.request已添加到模板 context_processors。

如果您使用的是django 1.9+，则还需要添加 easy_pjax.templatetags.pjax_tags到模板builtins中 django设置：

TEMPLATES=[{"BACKEND":"django.template.backends.django.DjangoTemplates","DIRS":[...],"APP_DIRS":True,"OPTIONS":{"builtins":["easy_pjax.templatetags.pjax_tags"],"context_processors":["django.template.context_processors.request","django.template.context_processors.static",...]}}]

然后只需在站点模板中添加|pjax:request过滤器extends标记：

{% extends "theme_base.html"|pjax:request %}

pjax筛选器将决定应基于哪个布局模板进行扩展 在http头上。在上面的例子中，它将返回theme_base.html 对于常规请求和pjax_base.html对于pjax请求。

这个应用程序提供了一个通用的pjax_base.html模板，但是 可能需要将其复制到您的模板根目录并调整它以匹配 项目的模板块。

不需要对视图、代码或url配置进行其他修改， 因此，与其他应用程序的集成不应该是一个问题。

模板过滤器还采用逗号分隔的名称base和pjax 模板作为第一个参数：

{% extends "base.html,pjax_base2.html"|pjax:request %}

如果需要指定另一个模板集，这将非常有用。

有关工作示例，请参见demo.py文件和tests目录。

UNPJAX

jquery-pjax使用缓存破坏技术并附加_pjax=true 查询字符串参数。

如果出于某种原因需要从查询字符串中删除该参数 您可以使用easy_pjax.middleware.UnpjaxMiddleware来删除它 在将所有请求传递给django视图之前，或从unpjax 用于修改模板中发出的URL的筛选器：

<a href="{{ request.get_full_path|unpjax }}">

文档

完整的文档位于django-easy-pjax.rtfd.org。

现场演示在easy-pjax.herokuapp.com。 通过运行^{tt23}，可以在安装依赖项后在本地运行它$ 来自克隆存储库的脚本。

django 1.9

在django 1.9之前，easy-pjax库使用了django.template.base.add_to_builtins 用于在添加模板后自动在模板内置程序中注册自身的私有api 到INSTALLED_APPS列表。 这种解决方法是由于{% load  %}标记不能放在 无法显式加载{% extends %}标记和pjax模板筛选器。

从django 1.9开始easy-pjax不必依赖这样的解决方案，因为 django现在提供了一种向模板添加过滤器和标记的干净方法。 built-ins。 现在，这是安装easy-pjaxtemplate标记的推荐和唯一方法，因为 add_to_builtins API was removed。

这是一个向后不兼容的更改，但是它使集成更加明确 遵循Python的禅意。

从django 1.9开始使用的配置设置示例：

INSTALLED_APPS=["easy_pjax"]MIDDLEWARE_CLASSES=["easy_pjax.middleware.UnpjaxMiddleware"]TEMPLATES=[{"BACKEND":"django.template.backends.django.DjangoTemplates","DIRS":[],"APP_DIRS":True,"OPTIONS":{"builtins":["easy_pjax.templatetags.pjax_tags"],"context_processors":["django.template.context_processors.request",]}}]

Django 1.8或更高版本不需要更改。

许可证

django-easy-pjax是根据bsd许可证发布的。

其他资源

• github存储库-https://github.com/nigma/django-easy-pjax
• PYPI包站点-http://pypi.python.org/pypi/django-easy-pjax

请注意，jquery-pjaxjavascript库未与此绑定 应用程序和您仍然需要添加正确的处理到您的浏览器端代码。

商业支持

此应用程序和许多其他帮助我们构建更好的软件 专注于更快地交付高质量的项目。 我们很乐意为您的下一个项目提供帮助，请与我们联系 通过在en@ig.ma删除电子邮件。