django-autohide-help 0.0.1

====================
django-autohide-help
====================

django-autohide-help是一个打包为Django应用程序的jQuery插件，便于安装。
它是一个插件，允许前端开发人员隐藏由`crispy forms`生成的帮助块。
。

安装
============

使用pip安装：

pip安装django-autohide-help

在将`autohide_help`添加到`INSTALLED_APPS`后，`autohide-help.js`将在`{{ STATIC_URL }}js/autohide-help.js`中可用。
。

如果您正在使用RequireJS_，可以将`autohide-help`添加到依赖项中，因为它已打包支持RequireJS。
。

如果您想通过简单的script标签使用它，可以像通常一样添加script标签：
。

<script src="{{ STATIC_URL}}js/autohide-help.js``"></script>

此插件需要jQuery（显然）。

基本用法
===========

选择一个表单（或多个表单），并在其上调用`autohideHelp`：

$('form').autohideHelp()

当用户输入字段时，帮助块会滑出，当用户离开字段时，它会滑回。
。

不使用crispy forms使用
==========================

Crispy forms不是必需的。只是使用它们很方便，因为它们会自动生成帮助块。
。

如果您想在没有crispy forms的情况下使用django-autohide-help，请确保您的帮助块具有以下格式的id：``help_FIELD_ID``
其中``FIELD_ID``是帮助块所属字段的id。例如，如果您的字段id为``id_name``，则帮助块的id必须是``help_id_name``。``django-authide-help``的未来版本可能会使此可配置。
。
。
。
。

报告错误
==============

请将错误报告到Bitbucket `问题跟踪器`_。

.. _jQuery: https://jqueryjs.cn/
.. _Django: https://django.ac.cn/
.. _crispy forms: http://django-crispy-forms.readthedocs.org/en/d-0/
.. _issue tracker: https://bitbucket.org/brankovukelic/django-autohide-help/issues