{"title":"管理的 JavaScript 自定义","version":"3.2","locale":"zh-hans","docname":"ref/contrib/admin/javascript","url":"/zh-hans/3.2/ref/contrib/admin/javascript/","canonical":"https://djangodocs.dev/zh-hans/3.2/ref/contrib/admin/javascript/","summary":"内联表单事件 Link to this heading # 当一个内联表单在管理更改表单中被添加或删除时，你可能想执行一些 JavaScript。 formset:add 和 formset:remove 的 jQuery 事件允许这样做。事件处理程序被传递给三个参数： event 是 jQuery 事件。 $row…","html":"<h1>管理的 JavaScript 自定义<a class=\"heading-anchor\" href=\"#javascript-customizations-in-the-admin\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h1>\n<section id=\"inline-form-events\">\n<span id=\"admin-javascript-inline-form-events\"></span><h2>内联表单事件<a class=\"heading-anchor\" href=\"#inline-form-events\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>当一个内联表单在管理更改表单中被添加或删除时，你可能想执行一些 JavaScript。<code class=\"docutils literal notranslate\"><span class=\"pre\">formset:add</span></code> 和 <code class=\"docutils literal notranslate\"><span class=\"pre\">formset:remove</span></code> 的 jQuery 事件允许这样做。事件处理程序被传递给三个参数：</p>\n<ul class=\"simple\">\n<li><p><code class=\"docutils literal notranslate\"><span class=\"pre\">event</span></code> 是 <code class=\"docutils literal notranslate\"><span class=\"pre\">jQuery</span></code> 事件。</p></li>\n<li><p><code class=\"docutils literal notranslate\"><span class=\"pre\">$row</span></code> 是新增加（或删除）的行。</p></li>\n<li><p><code class=\"docutils literal notranslate\"><span class=\"pre\">formsetName</span></code> 是该行所属的表单集。</p></li>\n</ul>\n<p>该事件使用 <a class=\"reference internal\" href=\"/zh-hans/3.2/ref/contrib/admin/#contrib-admin-jquery\"><span class=\"std std-ref\">django.jQuery 命名空间</span></a> 来启动。</p>\n<p>在你的自定义 <code class=\"docutils literal notranslate\"><span class=\"pre\">change_form.html</span></code> 模板中，扩展 <code class=\"docutils literal notranslate\"><span class=\"pre\">admin_change_form_document_ready</span></code> 块并添加事件监听器代码：</p>\n<div class=\"code-block\" data-language=\"html+django\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Django template</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Django template code\"><code><span class=\"cp\">{%</span> <span class=\"k\">extends</span> <span class=\"s1\">&#39;admin/change_form.html&#39;</span> <span class=\"cp\">%}</span>\n<span class=\"cp\">{%</span> <span class=\"k\">load</span> <span class=\"nv\">static</span> <span class=\"cp\">%}</span>\n\n<span class=\"cp\">{%</span> <span class=\"k\">block</span> <span class=\"nv\">admin_change_form_document_ready</span> <span class=\"cp\">%}</span>\n<span class=\"cp\">{{</span> <span class=\"nb\">block</span><span class=\"nv\">.super</span> <span class=\"cp\">}}</span>\n<span class=\"p\">&lt;</span><span class=\"nt\">script</span> <span class=\"na\">src</span><span class=\"o\">=</span><span class=\"s\">&quot;</span><span class=\"cp\">{%</span> <span class=\"k\">static</span> <span class=\"s1\">&#39;app/formset_handlers.js&#39;</span> <span class=\"cp\">%}</span><span class=\"s\">&quot;</span><span class=\"p\">&gt;&lt;/</span><span class=\"nt\">script</span><span class=\"p\">&gt;</span>\n<span class=\"cp\">{%</span> <span class=\"k\">endblock</span> <span class=\"cp\">%}</span>\n</code></pre></div>\n<figure class=\"code-block code-block-captioned\" data-language=\"javascript\"><figcaption class=\"code-block-caption\"><code class=\"docutils literal notranslate\"><span class=\"pre\">app/static/app/formset_handlers.js</span></code></figcaption>\n<div class=\"code-block-toolbar\"><span class=\"code-block-language\">JavaScript</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"JavaScript code\"><code><span class=\"p\">(</span><span class=\"kd\">function</span><span class=\"p\">(</span><span class=\"nx\">$</span><span class=\"p\">)</span><span class=\"w\"> </span><span class=\"p\">{</span>\n<span class=\"w\">    </span><span class=\"nx\">$</span><span class=\"p\">(</span><span class=\"nb\">document</span><span class=\"p\">).</span><span class=\"nx\">on</span><span class=\"p\">(</span><span class=\"s1\">&#39;formset:added&#39;</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"kd\">function</span><span class=\"p\">(</span><span class=\"nx\">event</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"nx\">$row</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"nx\">formsetName</span><span class=\"p\">)</span><span class=\"w\"> </span><span class=\"p\">{</span>\n<span class=\"w\">        </span><span class=\"k\">if</span><span class=\"w\"> </span><span class=\"p\">(</span><span class=\"nx\">formsetName</span><span class=\"w\"> </span><span class=\"o\">==</span><span class=\"w\"> </span><span class=\"s1\">&#39;author_set&#39;</span><span class=\"p\">)</span><span class=\"w\"> </span><span class=\"p\">{</span>\n<span class=\"w\">            </span><span class=\"c1\">// Do something</span>\n<span class=\"w\">        </span><span class=\"p\">}</span>\n<span class=\"w\">    </span><span class=\"p\">});</span>\n\n<span class=\"w\">    </span><span class=\"nx\">$</span><span class=\"p\">(</span><span class=\"nb\">document</span><span class=\"p\">).</span><span class=\"nx\">on</span><span class=\"p\">(</span><span class=\"s1\">&#39;formset:removed&#39;</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"kd\">function</span><span class=\"p\">(</span><span class=\"nx\">event</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"nx\">$row</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"nx\">formsetName</span><span class=\"p\">)</span><span class=\"w\"> </span><span class=\"p\">{</span>\n<span class=\"w\">        </span><span class=\"c1\">// Row removed</span>\n<span class=\"w\">    </span><span class=\"p\">});</span>\n<span class=\"p\">})(</span><span class=\"nx\">django</span><span class=\"p\">.</span><span class=\"nx\">jQuery</span><span class=\"p\">);</span>\n</code></pre></figure>\n<p>有两点需要注意：</p>\n<ul class=\"simple\">\n<li><p>如果你继承了 <code class=\"docutils literal notranslate\"><span class=\"pre\">admin/change_form.html</span></code>，JavaScript 代码必须放在模板块中，否则它不会在最终的 HTML 中呈现。</p></li>\n<li><p>添加 <code class=\"docutils literal notranslate\"><span class=\"pre\">{{</span> <span class=\"pre\">block.super</span> <span class=\"pre\">}}</span></code> 是因为 Django 的 <code class=\"docutils literal notranslate\"><span class=\"pre\">admin_change_form_document_ready</span></code> 块中包含了 JavaScript 代码，用于处理更改表单中的各种操作，而我们也需要渲染这些代码。</p></li>\n</ul>\n<p>有时你需要使用没有在 <code class=\"docutils literal notranslate\"><span class=\"pre\">django.jQuery</span></code> 命名空间注册的 <code class=\"docutils literal notranslate\"><span class=\"pre\">jQuery</span></code> 插件。要做到这一点，改变代码监听事件的方式。不在 <code class=\"docutils literal notranslate\"><span class=\"pre\">django.jQuery</span></code> 命名空间中封装监听器，而是监听从那里触发的事件。比如说：</p>\n<div class=\"code-block\" data-language=\"html+django\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Django template</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Django template code\"><code><span class=\"cp\">{%</span> <span class=\"k\">extends</span> <span class=\"s1\">&#39;admin/change_form.html&#39;</span> <span class=\"cp\">%}</span>\n<span class=\"cp\">{%</span> <span class=\"k\">load</span> <span class=\"nv\">static</span> <span class=\"cp\">%}</span>\n\n<span class=\"cp\">{%</span> <span class=\"k\">block</span> <span class=\"nv\">admin_change_form_document_ready</span> <span class=\"cp\">%}</span>\n<span class=\"cp\">{{</span> <span class=\"nb\">block</span><span class=\"nv\">.super</span> <span class=\"cp\">}}</span>\n<span class=\"p\">&lt;</span><span class=\"nt\">script</span> <span class=\"na\">src</span><span class=\"o\">=</span><span class=\"s\">&quot;</span><span class=\"cp\">{%</span> <span class=\"k\">static</span> <span class=\"s1\">&#39;app/unregistered_handlers.js&#39;</span> <span class=\"cp\">%}</span><span class=\"s\">&quot;</span><span class=\"p\">&gt;&lt;/</span><span class=\"nt\">script</span><span class=\"p\">&gt;</span>\n<span class=\"cp\">{%</span> <span class=\"k\">endblock</span> <span class=\"cp\">%}</span>\n</code></pre></div>\n<figure class=\"code-block code-block-captioned\" data-language=\"javascript\"><figcaption class=\"code-block-caption\"><code class=\"docutils literal notranslate\"><span class=\"pre\">app/static/app/unregistered_handlers.js</span></code></figcaption>\n<div class=\"code-block-toolbar\"><span class=\"code-block-language\">JavaScript</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"JavaScript code\"><code><span class=\"nx\">django</span><span class=\"p\">.</span><span class=\"nx\">jQuery</span><span class=\"p\">(</span><span class=\"nb\">document</span><span class=\"p\">).</span><span class=\"nx\">on</span><span class=\"p\">(</span><span class=\"s1\">&#39;formset:added&#39;</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"kd\">function</span><span class=\"p\">(</span><span class=\"nx\">event</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"nx\">$row</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"nx\">formsetName</span><span class=\"p\">)</span><span class=\"w\"> </span><span class=\"p\">{</span>\n<span class=\"w\">    </span><span class=\"c1\">// Row added</span>\n<span class=\"p\">});</span>\n\n<span class=\"nx\">django</span><span class=\"p\">.</span><span class=\"nx\">jQuery</span><span class=\"p\">(</span><span class=\"nb\">document</span><span class=\"p\">).</span><span class=\"nx\">on</span><span class=\"p\">(</span><span class=\"s1\">&#39;formset:removed&#39;</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"kd\">function</span><span class=\"p\">(</span><span class=\"nx\">event</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"nx\">$row</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"nx\">formsetName</span><span class=\"p\">)</span><span class=\"w\"> </span><span class=\"p\">{</span>\n<span class=\"w\">    </span><span class=\"c1\">// Row removed</span>\n<span class=\"p\">});</span>\n</code></pre></figure>\n</section>","rootId":"javascript-customizations-in-the-admin","toc":[{"title":"内联表单事件","anchor":"inline-form-events","children":[]}],"breadcrumbs":[{"docname":"ref/index","title":"API 参考","url":"/zh-hans/3.2/ref/"},{"docname":"ref/contrib/index","title":"contrib 包","url":"/zh-hans/3.2/ref/contrib/"},{"docname":"ref/contrib/admin/index","title":"Django 管理站点","url":"/zh-hans/3.2/ref/contrib/admin/"}],"prev":{"docname":"ref/contrib/admin/admindocs","title":"Django 管理文档生成器","url":"/zh-hans/3.2/ref/contrib/admin/admindocs/"},"next":{"docname":"ref/contrib/auth","title":"django.contrib.auth","url":"/zh-hans/3.2/ref/contrib/auth/"},"formats":{"html":"/zh-hans/3.2/ref/contrib/admin/javascript/","markdown":"/zh-hans/3.2/ref/contrib/admin/javascript.md","json":"/zh-hans/3.2/ref/contrib/admin/javascript.json"},"source":"https://github.com/django/django/blob/stable/3.2.x/docs/ref/contrib/admin/javascript.txt","official":"https://docs.djangoproject.com/zh-hans/3.2/ref/contrib/admin/javascript/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0"],"inLocales":["en","zh-hans","fr","ja","id","it","pt-br","ko","es","el","pl"]}