Django Bootstrap Form 技术文档

1. 安装指南

安装步骤

1. 使用 pip 安装
   你可以通过 pip 来安装 django-bootstrap-form 包。打开终端并运行以下命令：

   $ pip install django-bootstrap-form
   

2. 添加到 INSTALLED_APPS
   在 Django 项目的 settings.py 文件中，将 bootstrapform 添加到 INSTALLED_APPS 列表中：

   INSTALLED_APPS = [
       ...
       'bootstrapform',
       ...
   ]
   

2. 项目的使用说明

基本用法

1. 加载模板标签
   在你的 Django 模板文件的顶部，加载 bootstrap 模板标签：

   {% load bootstrap %}
   

2. 渲染表单
   使用 bootstrap 模板标签来渲染表单。以下是一个基本的表单示例：

   <form role="form">
       <legend>Form Title</legend>
       {% csrf_token %}
       {{ form|bootstrap }}
       <div class="form-group">
         <button type="submit" class="btn btn-primary">Submit</button>
       </div>
   </form>
   

内联表单

如果你希望使用内联表单，可以在表单元素上添加 class="form-inline"，并将模板标签更改为 bootstrap_inline：

<form class="form-inline">
    <legend>Form Title</legend>
    {% csrf_token %}
    {{ form|bootstrap_inline }}
    <div class="form-group">
      <button type="submit" class="btn btn-primary">Submit</button>
    </div>
</form>

水平表单

要创建水平表单，需要在表单元素上添加 class="form-horizontal"，并将模板标签更改为 bootstrap_horizontal。同时，提交按钮的 CSS 也需要稍作调整：

<form class="form-horizontal">
    <legend>Form Title</legend>
    {% csrf_token %}
    {{ form|bootstrap_horizontal }}
    <div class="form-group">
      <div class="col-sm-10 col-sm-offset-2">
        <button type="submit" class="btn btn-primary">Submit</button>
      </div>
    </div>
</form>

3. 项目API使用文档

模板标签

• bootstrap: 用于渲染标准表单。
• bootstrap_inline: 用于渲染内联表单。
• bootstrap_horizontal: 用于渲染水平表单。

示例

{% load bootstrap %}

<form role="form">
    <legend>Form Title</legend>
    {% csrf_token %}
    {{ form|bootstrap }}
    <div class="form-group">
      <button type="submit" class="btn btn-primary">Submit</button>
    </div>
</form>

4. 项目安装方式

通过 pip 安装

$ pip install django-bootstrap-form

添加到 INSTALLED_APPS

在 settings.py 中添加 bootstrapform：

INSTALLED_APPS = [
    ...
    'bootstrapform',
    ...
]

通过以上步骤，你就可以在 Django 项目中使用 django-bootstrap-form 来快速创建美观的表单。