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 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
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)

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

wagtailfontawesome-1.1.0.tar.gz (653.2 kB view details)

Uploaded Source

Built Distribution

wagtailfontawesome-1.1.0-py2.py3-none-any.whl (655.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file wagtailfontawesome-1.1.0.tar.gz.

File metadata

File hashes

Hashes for wagtailfontawesome-1.1.0.tar.gz
Algorithm Hash digest
SHA256 88398ee3b67d5c82b9828a89a6a1bc3e9108d012e118d9c3e9213ee57df43e41
MD5 6ef274f1b40ee5b03b7c3177de580af8
BLAKE2b-256 e21ba1e7afea0ea1fa0cdc48d9dba155e02258ae4a5284c63d9cc83ec195feb7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wagtailfontawesome-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3a7069c42ba767336938e47f1748706661c42fa4a0d5ff2ac0e7a9e3b657d7e1
MD5 005eb3d1ed703ff9b11ed7b5dcce90a7
BLAKE2b-256 50d6a6e02f7d1e5972226c98e6113204f17794fc0bc5e70735e49f99ccd2164f

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