Skip to main content

Bootstrap helper for Flask/Jinja2.

Project description

Bootstrap-Flask

Bootstrap 4 helper for Flask/Jinja2. Based on Flask-Bootstrap, but lighter and better.

Installation

$ pip install bootstrap-flask

Initialization

from flask_bootstrap import Bootstrap
from flask import Flask

app = Flask(__name__)

bootstrap = Bootstrap(app)

Resources helpers

When development, Bootstrap-Flask provides two helper functions that can be used to generate resources load code in template: bootstrap.load_css() and bootstrap.load_js()

Call it at your template, for example:

<head>
{{ bootstrap.load_css() }}
</head>
<body>
...
{{ bootstrap.load_js() }}
</body>

Macros

Macro Templates Path Description
render_field() bootstrap/form.html Redner a WTForms form field
render_form() bootstrap/form.html Render a WTForms form
render_pager() bootstrap/pagination.html Render a basic pagination, only include previous and next button.
render_pagination() bootstrap/pagination.html Render a standard pagination
render_nav_item() bootstrap/nav.html Render a navigation item
render_breadcrumb_item() bootstrap/nav.html Render a breadcrumb item
render_static() bootstrap/utils.html Render a resource reference code (i.e. <link>, <script>)

How to use these macors? It's quite simple, just import them from the correspond path and then call them like any other macro:

{% from 'bootstrap/form.html' import render_form %}

{{ render_form(form) }}

API documentation will coming soon...

Run the demo application

$ git clone https://github.com/greyli/bootstrap-flask.git
$ pip install flask flask-wtf flask-sqlalchemy bootstrap-flask
$ cd bootstrap-flask/examples
$ flask run

Now go to http://localhost:5000.

Changelog

1.0.1

Release date: 2018/7/1

  • Fix local resources path error
  • Add basic unit tests

1.0

Release date: 2018/6/11

Initialize release.

License

This project is licensed under the MIT License (see the LICENSE file for details).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for Bootstrap-Flask, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size Bootstrap_Flask-1.0.1-py2.py3-none-any.whl (767.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size Bootstrap-Flask-1.0.1.tar.gz (750.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page