Skip to main content

Add FontAwesome icons to StreamField.

Project description

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 import this on the front-end, if you want.

{% load staticfiles %}

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

Then include icons anywhere on the front-end with:

<i class="icon icon-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.conf import settings
from wagtail.wagtailcore.blocks import StructBlock


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

    class Meta:
        if 'wagtailfontawesome' in settings.INSTALLED_APPS:
            icon = 'fa-quote-left'

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

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

wagtailfontawesome-1.0.6-py2.py3-none-any.whl (632.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file wagtailfontawesome-1.0.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for wagtailfontawesome-1.0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 acc43e2c0cf54add8be9170184613b6fcd85641d6595eaad7f160283edd874db
MD5 91fae3aea949cd8b5a74225e698d4126
BLAKE2b-256 76c8e610273db0f76d5cd8260174535ce53f2535b23f1dcc5c62ec79522cc9c2

See more details on using hashes here.

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