# Bootstrap-Flask

Bootstrap-Flask is a collection of Jinja macros for Bootstrap and Flask. It helps you to render Flask-related data and objects to Bootstrap markup HTML more easily.

## Contents

- Basic Usage
  - Installation
  - Initialization
  - Resources Helpers
  - Starter template
  - Macros
  - Run the Demo Application
  - Configurations
- Use Macros
  - render_nav_item()
  - render_breadcrumb_item()
  - render_field()
  - render_form()
  - render_hidden_errors()
  - render_form_row()
  - render_pager()
  - render_pagination()
  - render_static()
  - render_messages()
  - render_table()
  - render_icon()
- Migrate from Flask-Bootstrap
  - Uninstall and Install
  - Initialize the Extension
  - Create Base Template
  - Change Template and Macro Name
- Advanced Usage
  - Form Button Customization
  - Form Checkbox Customization
  - Form Input Customization
  - Bootswatch Themes
- Run the demo application
  - Overview of icons

## API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

- API Reference
  - `_Bootstrap`
  - `Bootstrap4`
  - `Bootstrap5`
  - `SwitchField`

## Changelog

- Changelog
  - 2.5.0
  - 2.4.2
  - 2.4.1
  - 2.4.0
  - 2.3.3
  - 2.3.2
  - 2.3.1
  - 2.3.0
  - 2.2.0
  - 2.1.0
  - 2.0.2
  - 2.0.1
  - 2.0.0
  - 1.8.0
  - 1.7.0
  - 1.6.0
  - 1.5.3
  - 1.5.2
  - 1.5.1
  - 1.5
  - 1.4
  - 1.3.2
  - 1.3.1
  - 1.3.0
  - 1.2.0
  - 1.1.0
  - 1.0.10
  - 1.0.9
  - 1.0.8
  - 1.0.7
  - 1.0.6
  - 1.0.5
  - 1.0.4
  - 1.0.3
  - 1.0.2
  - 1.0.1
  - 1.0

## Development

We welcome all kinds of contributions. You can build the development environment locally with the following commands:

    $ git clone git@github.com:helloflask/bootstrap-flask.git
    $ cd bootstrap-flask
    $ python3 -m venv venv
    $ . venv/bin/activate
    $ pip install -e .
    $ pip install -r requirements/dev.txt

Run the tests with pytest:

    $ pytest

Or run the full checks with tox:

    $ tox

## Authors

Maintainers:

- Grey Li

- Pander

See also the list of contributors who participated in this project.

## License

This project is licensed under the MIT License (see the `LICENSE` file for details). Some macros were part of Flask-Bootstrap and were modified under the terms of its BSD License.