Metadata-Version: 2.1
Name: django-buttons
Version: 0.9.2
Summary: An application providing some template-tags to add buttons to pages
Home-page: https://github.com/frague59/django-buttons
Author: François GUÉRIN
Author-email: fguerin@ville-tourcoing.fr
License: MIT
Keywords: django,buttons,bootstrap3
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
Requires-Dist: django-appconf
Provides-Extra: fa4
Requires-Dist: django-fontawesome ; extra == 'fa4'
Provides-Extra: fa5
Requires-Dist: django-fontawesome-5 ; extra == 'fa5'

# django-buttons

This application provides some simple template tags to insert buttons into templates.

## Installation

Install application with pypi:

```sh
$ pip install django-buttons                # Does not installs any fontawesome -- Must be installed manually
$ pip install django-buttons[fontawesome4]  # Installs django-fontawesome
$ pip install django-buttons[fontawesome5]  # Installs django-fontawesome5
```
Add application to your INSTALLED_APPS:

```python
INSTALLED_APPS = [
   ...
   'buttons',
   ...
]

BUTTONS_FONTAWESOME_VERSION = 4 # Use 5 ti use fontawesome-5 as icon library
```

## Use buttons in your templates

```html
 {% load buttons_tags %}
 ...
 {% btn_home %}
```

Buttons can have some parameters :

+ **url**: target url
+ **title**: displayed text
+ **icon**: fa aware name, ie. 'home' for
  [fa-home](http://fontawesome.io/icon/home/)
+ **icon_position**: Position of the icon, 'right', 'left' or 'none'
  (no icon displayed) ...

**Enjoy !**


