Skip to main content

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 https://img.shields.io/github/license/mashape/apistatus.svg

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)

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.3.tar.gz (650.1 kB view details)

Uploaded Source

Built Distribution

wagtailfontawesome-1.1.3-py2.py3-none-any.whl (654.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for wagtailfontawesome-1.1.3.tar.gz
Algorithm Hash digest
SHA256 55864c5167dd49d1a25e76412d17ce27b0d369e55143e447dabb1c157f8a7556
MD5 b0b99dfcbe6c2e8300d6acc47620d765
BLAKE2b-256 f6e05e879f68ee142f9578cab0c062c0f6b9a7ae552c47d9fc8d401395c6178f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wagtailfontawesome-1.1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f83de7208e294ecd23df357cdfcf8a4c6b78191e487703ba6a65ad903cd4e535
MD5 d4cf5bed154867c9504fa04b981105bb
BLAKE2b-256 a5e0a180a5aa3573a2666f497b184e5a98cae9225eb9f511f2e2094632d5f6b0

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