Metadata-Version: 1.1
Name: django-twitterbootstrap-form
Version: 0.3.1
Summary: Render Django forms as described using the twitter bootstrap HTML layout
Home-page: https://github.com/geelweb/django-twitter-bootstrap-form
Author: Guillaume Luchet
Author-email: <guillaume@geelweb.org>
License: MIT
Download-URL: https://github.com/geelweb/django-twitter-bootstrap-form/tarball/0.3
Description: =============================
        Django Twitter Bootstrap Form
        =============================
        
        Render Django forms using the HTML described by the `Bootstrap 3 <http://getbootstrap.com/css/#forms>`_.
        
        Demo
        ====
        
        A basic demo is availaible on this `sandbox <http://django-sandbox.geelweb.org/twitter-bootstrap-form>`_
        
        Install
        =======
        
        From PyPI::
        
            pip install django-twitterbootstrap-form
        
        From Source::
        
            python setup.py install
        
        About Bootstrap 2
        -----------------
        
        You can install the 0.2 version of this lib if you still work with old versions
        of `Bootstrap <http://twitter.github.com/bootstrap/base-css.html#forms>`_
        
        From PyPI::
        
            pip install django-twitterbootstrap-form==0.2
        
        From Source::
        
            git checkout 0.2
            python setup.py install
        
        Requirements
        ------------
        
         * Django>=1.4
         * django-widget-tweaks==1.3
        
        Configuring
        ===========
        
        Add ``geelweb.django.twitter_bootstrap_form`` to ``INSTALLED_APPS`` in your settings
        
        Load the tags adding ``{% load twitter_bootstrap %}`` in templates
        
        Template filters
        ================
        
        **twitter_bootstrap**
        
        This tag takes 4 optional parameters
        
         * *layout*: Default: "default". Existing layouts are, default, search, inline,
           horizontal
         * *size*: Default: "sm". The column sizes. xs, sm, md, lg.
         * *labelcols*: Default: 2. Number of columns used for labels
         * *fieldcols*: Default: 12 - labelcols. NUmber of columns used for fields.
        
        Example::
        
            {{ form|twitter_bootstrap }}
        
        Advanced usage::
        
            {{ form|twitter_bootstrap:"horizontal,md,3,3" }}
        
        More examples
        -------------
        
        Default form::
        
            <form role="form">
                {{ default_form|twitter_bootstrap }}
                <button type="submit" class="btn btn-default">Submit</button>
            </form>
        
        Search form / Navbar form::
        
            <form role="search" class="navbar-form">
                {{ search_form|twitter_bootstrap:"search" }}
                <button type="submit" class="btn btn-default">Search</button>
            </form>
        
        Inline form::
        
            <form role="form" class="form-inline">
                {{ inline_form|twitter_bootstrap:"inline" }}
                <button type="submit" class="btn btn-default">Sign in</button>
            </form>
        
        Horizontal form::
        
            <form role="form" class="form-horizontal">
                {{ horizontal_form|twitter_bootstrap:"horizontal" }}
                <div class="form-group">
                    <div class="col-sm-offset-2 col-sm-10">
                        <button type="submit" class="btn btn-default">Sign in</button>
                    </div>
                </div>
            </form>
        
        Settings
        ========
        
        **BOOTSTRAP_REQUIRED_SUFFIX**
        
        Default: ' \*'
        
        Required field label suffix.
        
        
Keywords: django,twitter,bootstrap,form
Platform: UNKNOWN
