Metadata-Version: 1.1
Name: wagtailfontawesome
Version: 1.1.2
Summary: Add FontAwesome icons to StreamField.
Home-page: https://github.com/alexgleason/wagtailfontawesome
Author: Alex Gleason
Author-email: alex@alexgleason.me
License: MIT
Description: Wagtail FontAwesome
        ====================
        
        Add `FontAwesome <https://github.com/FortAwesome/Font-Awesome>`_ icons to StreamField.
        
        .. image:: https://github.com/alexgleason/wagtailfontawesome/raw/master/screenshot.png
          :alt: Screenshot
        
        Install
        -------
        
        .. code-block:: shell
        
            pip install wagtailfontawesome
            
        
        
        Then add `wagtailfontawesome` to your installed apps.
        
        Usage
        -----
        
        StreamField
        ~~~~~~~~~~~
        
        Add FontAwesome icons to StreamField `the regular way <http://docs.wagtail.io/en/latest/topics/streamfield.html#basic-block-types>`_, just set `icon="fa-something"`. Reference `the full list <http://fontawesome.io/icons/>`_.
        
        wagtailmodeladmin
        ~~~~~~~~~~~~~~~~~
        
        `wagtailmodeladmin <https://github.com/rkhleics/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`.
        
        .. code-block:: javascript
        
            button.hallobutton({
              label: "Blockquote",
              icon: 'icon icon-fa-quote-left',
            });
            
        
        
        Other parts of the admin
        ~~~~~~~~~~~~~~~~~~~~~~~~
        
        You can include icons anywhere in the admin with:
        
        ```html+django
        <i class="icon icon-fa-something"></i>
        .. code-block:: None
        
            
            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.
            
            
        html+django
        {% load wagtailfontawesome %}
        
        {% fontawesome_css %}
        .. code-block:: None
        
            
            This will generate equivalent markup to:
            
            
        html+django
        <link rel="stylesheet" href="{% static 'wagtailfontawesome/css/fontawesome.css' %}">
        .. code-block:: None
        
            
            Then include icons anywhere on the front-end with:
            
            
        html+django
        <i class="fa fa-something"></i>
        .. code-block:: None
        
            
            ### 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.
            
            
        python
        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)
        
Keywords: development
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
