Skip to main content

Add FontAwesome icons to StreamField.

Project description

https://img.shields.io/pypi/l/wagtailfontawesome.svg

Add FontAwesome 4.7 icons to your Wagtail project.

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.

ModelAdmin

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

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

Uploaded Source

Built Distribution

wagtailfontawesome-1.1.4-py2.py3-none-any.whl (654.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: wagtailfontawesome-1.1.4.tar.gz
  • Upload date:
  • Size: 650.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.5.2

File hashes

Hashes for wagtailfontawesome-1.1.4.tar.gz
Algorithm Hash digest
SHA256 8b4935d285904c7e9f1d33606d58f794a230298cfd50f363e833500ff734751e
MD5 65f5337b980b58a214b4b28b8c2accf1
BLAKE2b-256 7597d2f48908f5235d0e3d2ec7dda371ae1ae3966e6c46ab90408704bc19b1d3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wagtailfontawesome-1.1.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 654.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.5.2

File hashes

Hashes for wagtailfontawesome-1.1.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 01b2a68bbf84984ddbb154c8c5733e38f537ecf53090269637f0b510ea2708ef
MD5 4fe797da0bdce8b7d74e22aed7220d91
BLAKE2b-256 b3a5626b1e057265f5447b8c18f828d94dc94042d2ff57ea38988793f35f7ae7

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