tzangms / django-bootstrap-form

Twitter Bootstrap for Django Form
BSD 3-Clause "New" or "Revised" License
557 stars 183 forks source link

===================== Django bootstrap form

.. image:: https://badge.fury.io/py/django-bootstrap-form.png :alt: PyPI version :target: https://pypi.python.org/pypi/django-bootstrap-form

.. image:: https://travis-ci.org/tzangms/django-bootstrap-form.png?branch=master
:target: https://travis-ci.org/tzangms/django-bootstrap-form

.. image:: https://coveralls.io/repos/tzangms/django-bootstrap-form/badge.png?branch=master
:target: https://coveralls.io/r/tzangms/django-bootstrap-form?branch=master

Twitter Bootstrap for Django Form.

A simple Django template tag to work with Bootstrap <http://getbootstrap.com/>_

Installation

Install django-bootstrap-form with pip

.. code-block:: sh

$ pip install django-bootstrap-form

Usage

Add "bootstrapform" to your INSTALLED_APPS.

At the top of your template load in our template tags::

{% load bootstrap %}

Then to render your form::

<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>

You can also set class="form-vertical" on the form element.

To use class="form-inline" on the form element, also change the "|boostrap" template tag to "|bootstrap_inline".

It is also possible to create a horizontal form. The form class and template tag are both changed, and you will also need slightly different CSS around the submit button::

<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>

Demo

Checkout this Demo site <http://django-bootstrap-form.herokuapp.com/>_ to see it in action.