Skip to main content
Help us improve Python packaging – donate today!

Add FontAwesome icons to StreamField.

Project Description

https://travis-ci.org/alexgleason/wagtailfontawesome.svg?branch=master https://coveralls.io/repos/github/alexgleason/wagtailfontawesome/badge.svg?branch=master

Add FontAwesome icons to StreamField.

Screenshot

Install

pip install wagtailfontawesome

Then add wagtailfontawesome to your installed apps.

Usage

StreamField

Add FontAwesome icons to StreamField the regular way, just set icon="fa-something". Reference the full list.

wagtailmodeladmin

wagtailmodeladmin is supported if you’re using Wagtail 1.4 or above. Similar to StreamField, just set icon="fa-something" on your menu item.

Hallo plugins

You can use FontAwesome icons on custom Hallo buttons by setting the icon option to icon icon-fa-something.

button.hallobutton({
  label: "Blockquote",
  icon: 'icon icon-fa-quote-left',
});

Other parts of the admin

You can include icons anywhere in the admin with:

<i class="icon icon-fa-something"></i>

In Wagtail 1.3.x and below you can only use icons on the page editor screen.

On the front-end

You can also include the CSS on the front end, and follow FontAwesome’s documentation.

{% load wagtailfontawesome %}

{% fontawesome_css %}

This will generate equivalent markup to:

<link rel="stylesheet" href="{% static 'wagtailfontawesome/css/fontawesome.css' %}">

Then include icons anywhere on the front-end with:

<i class="fa fa-something"></i>

Using wagtailfontawesome as an optional dependency

If you want to distribute a Wagtail plugin with FontAwesome icons, you can use this package as an optional dependency by checking if it’s installed in Django, and falling back otherwise.

from django.apps import apps
try:
    from wagtail.core.blocks import StructBlock
except ImportError:  # fallback for Wagtail <2.0
    from wagtail.wagtailcore.blocks import StructBlock


class BlockquoteBlock(StructBlock):
    quote = TextBlock()
    author = TextBlock()

    class Meta:
        if apps.is_installed('wagtailfontawesome'):
            icon = 'fa-quote-left'

(in this case, the fallback is to do nothing)

Release history Release notifications

This version
History Node

1.1.3

History Node

1.1.2

History Node

1.1.1

History Node

1.1.0

History Node

1.0.7

History Node

1.0.6

History Node

1.0.5

History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

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
wagtailfontawesome-1.1.3-py2.py3-none-any.whl (654.7 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Feb 5, 2018
wagtailfontawesome-1.1.3.tar.gz (650.1 kB) Copy SHA256 hash SHA256 Source None Feb 5, 2018

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