This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
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'

### Settings

Configuration and defaults of the templatetag are defined in django settings.

#### SVG_ICONS_READER_CLASS
_default: `svg_icons.readers.icomoon.IcomoonReader`_

Reader class to load the SVG data file and serve the right icon data

#### SVG_ICONS_SOURCE_FILE
Location of the (icomoon formatted) source file which contains the paths of all `svgs`

#### SVG_ICONS_DEFAULT_WIDTH
_default: 22_

Default width which gets set when no width or size is provided.

#### SVG_ICONS_DEFAULT_HEIGHT
_default: 22_

Default height which gets set when no height or size is provided.


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
Release History

Release History

0.1.1

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django_svg_icons-0.1.1-py2-none-any.whl (6.9 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Aug 9, 2016
django-svg-icons-0.1.1.tar.gz (3.9 kB) Copy SHA256 Checksum SHA256 Source Aug 9, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting