FontAwesome icons

Filters ::: filter_fontawesome
Maintained by FFHS (Fernfachhochschule Schweiz), Adrian Perez Rodriguez, Christoph Karlen, Sascha Vogel
This filter allows you to use fontawesome icons in the Moodle text editor without worrying about the HTML syntax.
Latest release:
1709 sites
487 downloads
73 fans

Moodle FontAwesome Filter Build Status Coverage Status

Introduction

This filter allows you to use fontawesome icons in the Moodle text editor without worrying about having your div's stripped out by the Moodle Atto/TinyMCE HTML cleaner.

This plugin supports the legacy FontAwesome 4 icon set and the newer version 5.

Furthermore it's important to know, that this plugin doesn't supply the newer free FontAwesome 5 icon set.  This is the responsibility of Moodle or your theme developer. So it can be, that not all FA icons will be displayed, for more information consult these links:

Requirements

Your site/theme must have FontAwesome embedded already. This filter does not provide the font.

  • Moodle 3.3 upwards

Installation

Install the plugin like any other plugin to folder filter/fontawesome

Use git to install this plugin:

cd /var/www/html/moodle
git clone https://github.com/adpe/moodle-filter_fontawesome.git filter/fontawesome


Then complete upgrade over CLI:

sudo -u apache /usr/bin/php admin/cli/upgrade.php

or GUI.

See MoodleDocs] for details on installing Moodle plugins

Configuration

First, activate the filter_tabs plugin in Site Administration -> Plugins -> Filters -> Manage filters

Additional

filter_fontawesome has a settings page to allow you to limit the filter to only certain text-box formats.

Usage

To create FontAwesome icons in text fields, use the following syntax: [fa-*] where * is the name of the icon you wish to display.

First you will need to find the icon you wish to use. This list provides a full overview.

Some examples and guide to start:

  • Anywhere you wish to add an icon just surround it with square brackets and type in the icon name. e.g.: [fa-camera-retro]
  • If the icon name is a brand, please add fab at the beginning of the square brackets.
  • If you wish to make the icon larger you can use a multiplier. e.g.: [fa-camera-retro fa-2x] or [fa-camera-retro fa-4x]
  • If you wish to rotate the icon you can specify how many degrees clockwise. e.g.: [fa-camera-retro fa-rotate-90]
  • You can also flip an icon horizontally or vertically. e.g.: [fa-camera-retro fa-flip-horizontal] or [fa-camera-retro fa-flip-vertical]
  • You can mute the colour to a dull grey. e.g.: [fa-camera-retro fa-muted]
  • You can "pull" the icon to the left or right. If it is "pulled" to the left text will wrap to the right. e.g.: [fa-camera-retro pull-left]
  • All the settings above can be mixed and matched e.g.: [fa-quote-left fa-4x pull-left fa-muted]

Further information

License

Screenshots

Screenshot #0
Screenshot #1

Contributors

FFHS (Fernfachhochschule Schweiz) (Lead maintainer)
Adrian Perez Rodriguez: Developer
Christoph Karlen: Developer
Sascha Vogel: Developer
Julian Ridden
Julian Ridden: Original author
Usman Asar: Previous maintainer
Please login to view contributors details and/or to contact them

Comments RSS

Show comments
  • Fri, Dec 14, 2018, 6:20 PM
    Approval issue created: CONTRIB-7571
  • Thu, Jan 31, 2019, 3:32 PM
    Hi Adrian - thanks for updating the plugin - I've re-approved the plugin again!
  • Tue, Apr 2, 2019, 12:40 AM
    Hi,

    First of all, very nice plugin! I recently installed it in our Moodle test environment, but
    I am having an issue that not all icons display. I am using the codes for free solid icons, and certain (random) icons like volume-mute or uber logo don't render. Do you have any idea why this might be happening? Also, I am having an issue with flipping the icons as well.

    Thanks in advance!
    Best,
    Liana
  • Tue, Apr 2, 2019, 2:33 PM
    Hello Liana

    I've just opened a new issue on the bug tracker, please have a look at https://github.com/adpe/moodle-filter_fontawesome/issues/6. Does the FontAwesome version is the newest one (5.8.1)?

    Greets
    Adrian
  • Sat, Oct 12, 2019, 5:45 AM
    Can someone tell me why only few icons work? and why the ones I like from the link they send don't (they show as free)? where is the list of usefull icons? Do I have to download the icons? and where in the database are theese icons?
    Thanks
  • Mon, Oct 14, 2019, 2:19 PM
    Hello Marina

    It depends on your FontAwesome icon set that you're providing. In Moodle core is still FontAwesome 4 provided so this list https://fontawesome.com/v4.7.0/icons should help you.

    If you want to use FontAwesome 5 you must import them in your theme to use them. We've added our FA to use overall the light style with a little "hack", look
    at https://moodle.org/mod/forum/discuss.php?d=360259

    HTH
    Adrian
  • Thu, Oct 31, 2019, 12:58 AM
    Hi
    Is it possible to get FontAwesome icons on headings of activities? Moodle 3.5. filter_fontawesome_moodle35_2019022702. I have posted screen-shots here: https://moodle.org/mod/forum/discuss.php?d=392842.
  • Wed, Dec 4, 2019, 3:47 PM
    Oh my god it works like MAGIC, thank you so much!
  • Sun, Dec 15, 2019, 4:13 PM
    I love the filter!
    Is it possible to set the color of the icon?
  • Sun, Apr 19, 2020, 9:46 PM
    Hi, when can we expect the release for moodle 3.8? Thanks!
  • Mon, Apr 20, 2020, 2:19 PM
    Hi Victor

    We'll release it soon. The plan was Mid/End of May but I'll put it forward.
  • Fri, Feb 5, 2021, 10:42 AM
    This is so awesome! Kudos to all who contributed to this work!
  • Thu, Oct 7, 2021, 3:29 PM
    Using [fa-*] filter codes in topic titles appears to break the backup process. Tested in Moodle 3.10.3, plugin version 3.10-r1. Backup fails with 'error/setting_invalid_ui_label'. Just putting anything in square brackets, e.g. [not-acode] is fine, so it looks like maybe the filter is invoked when the backup tries to validate the title, so the validator sees the renderable html from the filter and not just something in square brackets.
  • Thu, Oct 7, 2021, 4:17 PM
    Thank you for the bug report, Kirk.

    We'll tackle this issue soon (https://github.com/ffhs/moodle-filter_fontawesome/issues/8).
  • Fri, Oct 22, 2021, 10:18 PM
    Hello Kirk

    Using a newer Moodle core version, the error disappears and will not be thrown. I can only reproduce it on a Moodle 3.11.3 (Build: 20210913), but not on Moodle 3.11.3+ (Build: 20210917) or Moodle 3.11.3+ (Build: 20211022).

    Could you please have a look after updating your Moodle core version?

    It's also related to this setting "formatstringstriptags". More information can be found under https://tracker.moodle.org/browse/MDL-71093. As you see here, 3.10.8 and 3.11.4 are the fixed versions.

    Greets
    Adrian
1 2 3
Please login to post comments