Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Django SVG Icons made easy

Project description

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

Project details


Release history Release notifications

This version
History Node

0.1.2

History Node

0.1.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
django_svg_icons-0.1.2-py2-none-any.whl (6.5 kB) Copy SHA256 hash SHA256 Wheel py2 Mar 30, 2017
django-svg-icons-0.1.2.tar.gz (4.2 kB) Copy SHA256 hash SHA256 Source None Mar 30, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page