backdrop-contrib / font_awesome Goto Github PK

The current version of FontAwesome (as of 2021-01-15) is 5.15.4, but the version that's hard-coded in this module is 5.2.0. Consider either:

• Updating the hard-coded version to the most recent, or
• Adding an option setting to config to the let the user choose to stick with 5.2.0 or upgrade to a more recent version.

I'm not sure how/if this relates to the implementation used in this module, but wanted to mark it down for future review:

• Accessibility the Awesome Way: Making Icons More Accessible to Screen Readers

I will become maintainer of this as it is quite important to me.
PR to follow

I was troubleshooting why a certain icon wasn't appearing despite it being there on the Font Awesome site -- turns out it was added in a later version than what this module calls.

When saving configuration please be selective of what config to save. Right now it's saving everything in the form array. For example,

{
    "_config_name": "font_awesome.settings",
    "font_awesome_1": 1,
    "submit": "Save configuration",
    "form_build_id": "form-Efk2RAJc-gErBMeffdfdfcTVz-Q5wKzdUKtkJ6DYkL2_Qs",
    "form_token": "DRoHLlNdx6YFLa4uPqi3g8sdfsHra7BvFdYg-QLj2wuzzVY",
    "form_id": "font_awesome_admin_settings",
    "op": "Save configuration"
}

Only the font_awesome variables needs to be saved.

We should set the default to be the newest option as and when we add new options. Updating to 6.4

In my use case I want to preset a bunch of icons for a field, and not leave it up to the author to know what classes mean.

This is easily done with the list_text field type. I've got it working so I can provide a pr soon.

By the way, it wasn't clear at first where this formatter would be available and how one should use it. I had to look in the code. (Oops, I missed that part of the readme).

The README.md file for this project is not quite properly formatted.

The only real problem is the first heading. If properly formatted, this heading (usually the project name) will be removed by backdropcms.org. Take a look at the modules page to see the problem: https://backdropcms.org/modules?keys=font

Please refer to our contributor guidelines for an example README.md file that you can copy.

FontAwesome v5 renamed some icons, which breaks some v4 icon names. But FontAwesome also provides a shim file that restores compatiblity with v4 while allowing one to use all the goodness of v5. It would be nice to offer that as a option, which the attached PR does.

To see the difference, put this code in a page and compare the 3 configuration settings:

<p>
FontAwesome 4 icons (bandcamp, cart): <i class="fa fa-bandcamp"></i>, <i class="fa fa-shopping-cart"></i>
</p>

<p>
FontAwesome 5 icons (bandcamp, cart): <i class="fab fa-bandcamp"></i>, <i class="fas fa-shopping-cart"></i>
</p>

"v4" and "v5" don't display all of the icons, but the "v5 + shims" option will display both pairs of icons.

This PR does the same for the Bootstrap Icons module and should be pretty straightforward to adapt for Font Awesome:

• backdrop-contrib/bootstrap_icons#4

Hi @biolithic,

I'm interested in using and updating this module. Was wondering if I could take over maintainership of it? The readme says you're seeking one (maintainer, that is)...

This would allow for some customization of the icon set.

Can we get a better explanation for the "Font Awesome Field"?

It took me a while to figure out where to set it, then it took me a min to figure out what to actually put into the field.

Here's something to start from:

Also included with the Font Awesome module is the Font Awesome Field module which is a field formatter used in the Manage Display area of an entity.

The easiest way to get an icon going is to first create a new Text Field (short) for the entity where you want the icon. Next, navigate to Manage Display and set the Format to Font Awesome Icon. Save the display settings and create a new entity that uses this icon field and put in the designator for the font awesome icon you want. For example: fas fa-star is all you need to put into the field to show an icon of a solid star.

The Font Awesome Icon formatter takes the value you enter and inserts it into a CSS class for that field.

Note that you can only add one icon selector per field.

backdrop_add_library backdrop_add_html_head is more robust for adding third party libraries instead of backdrop_add_css.

It might not be an issue currently but I was playing around with adding Fork Awesome as an option and realized I couldn't create the link with the integrity and crossorigin attributes. I wonder if the other libraries have similar options.

The latest available version of FontAwesome is 6.4.2. We can add that CDN to the list of choices.

PR to follow.