Metadata-Version: 2.0
Name: django-svg-icons
Version: 0.1.2
Summary: Django SVG Icons made easy
Home-page: https://github.com/mikedingjan/django-svg-icons
Author: Mike Dingjan
Author-email: mike@mikedingjan.nl
License: Apache License
Keywords: SVG icons,django icons
Platform: osx
Platform: linux
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5

Django SVG Icons
================

Simple django templatetag to display `SVG` icons in your django application.
Icon paths will loaded from a provided `JSON` file, formatted according the icomoon format.

More info: [Icomoon website](http://icomoon.io/)


Installation
------------

Installation from pypi via pip

    pip install django-svg-icons


Configuration
-------------

In your django project add `svg_icons` to your installed apps and set the `SVG_ICONS_SOURCE_FILE` setting to your source file.

    INSTALLED_APPS = [
        # ...
        'svg_icons',
    ]

    SVG_ICONS_SOURCE_FILE = '/path/to/source_file.json'


Usage
-----

In your templates you can load the templatetag and start including your icons.

    {% load svg_icons %}
    {% icon 'icon_name' %}

The templatetag accepts some kwargs for icon configuration as well.

 - **size** for setting both width and height
 - **width** for only setting a specific width
 - **height** for only setting a specific height
 - **className** css classnames applied on the `<svg>` object

All kwargs are optional, when not provided the deaults are used.

    {% icon 'icon_name' size=50 className="css classnames" %}


Todo
----

 - Write tests


