Skip to main content

Adds icon plugin to django CMS.

Project description

pypi build coverage

django CMS Icon is a plugin for django CMS that allows you to insert an icon (font or svg) into your project.

This addon is compatible with Divio Cloud and is also available on the django CMS Marketplace for easy installation.

preview.gif

Contributing

This is a an open-source project. We’ll be delighted to receive your feedback in the form of issues and pull requests. Before submitting your pull request, please review our contribution guidelines.

One of the easiest contributions you can make is helping to translate this addon on Transifex.

Documentation

See REQUIREMENTS in the setup.py file for additional dependencies:

  • Python 2.7, 3.3 or higher

  • Django 1.8 or higher

Installation

For a manual install:

  • run pip install djangocms-icon

  • add djangocms_icon to your INSTALLED_APPS

  • run python manage.py migrate djangocms_icon

Configuration

The django CMS Icon plugin ships with Font Awesome as default. You can configure this through:

DJANGOCMS_ICON_SETS = [
    ('fontawesome', 'fa', 'Font Awesome'),
    (ICONSET, 'icon', 'SVG icons'),
]

In this example we keep the Font Awesome default and add our own SVG icon set on top of it. ICONSET is an external reference to a JSON file at the root of your project setting up your custom SVG icon set:

with open('iconset.json') as fh:
    ICONSET = fh.read()

Here an example of its content:

{
    "svg": true,
    "spritePath": "sprites/icons.svg",
    "iconClass": "icon",
    "iconClassFix": "icon-",
    "icons": [
        "icon-icon1",
        "icon-icon2",
        "..."
    ]
}

svg and spritePath are only required when using an SVG set. You can also use this to generate your own icon font definitions or add them straight to the DJANGOCMS_ICON_SETS setting.

djangocms-boilerplate-webpack can generate the iconset.json automatically for you through gulp icons.

In addition you need to load the resources for your fonts in /admin/djangocms_icon/includes/assets.html through your project in order for the icon picker to pick up your custom icons.

Make sure the icons names contain the iconset prefix as shown in the example, the widget will determine the iconset based on that. They can be omitted if only one iconset is used.

Running Tests

You can run tests by executing:

virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test

Project details


Download files

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

Source Distribution

djangocms-icon-1.0.0.tar.gz (66.9 kB view details)

Uploaded Source

File details

Details for the file djangocms-icon-1.0.0.tar.gz.

File metadata

File hashes

Hashes for djangocms-icon-1.0.0.tar.gz
Algorithm Hash digest
SHA256 c27aac78c18ad96a0c27c8db38742ebbb67641e7d8ee4d9f363ecd718ae6e4ab
MD5 f4af8dc7f5f7436ebdc9e34428f249e8
BLAKE2b-256 bc22a4c87f797e71dc1b246250ecdc78cd33ce26979f4ef7c471df32f5fe7dd7

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page