CKEditor 5 Icons: A fast & native Font Awesome icon picker
This module provides a native Font Awesome icon picker for CKEditor 5, allowing users to easily search, select, and style icons directly within the editor. It supports both Font Awesome 5 and 6, with options to customize categories, styles, and icon attributes like size and alignment.
This is a fast and native Font Awesome icon picker for CKEditor 5, built using CKEditor 5's modern TypeScript plugin APIs and designed to look like it belongs in the editor. It enables browsing, searching for, and and selecting icons without leaving the editor, and changing attributes such as size and style after an icon is inserted from a convenient widget toolbar.
Features
Core features
- Browse through all Font Awesome icons or Font Awesome's provided categories without leaving CKEditor.
- Search for the icon you're looking for with a fast and entirely client-side icon search.
- Change the Font Awesome style of an icon either from the icon picker or after you insert it via a convenient widget toolbar.
- Change the size and alignment of the icon easily from the toolbar.
- Icons inserted using this plugin have all the qualities of a CKEditor 5 inline widget. Cut and paste or drag them around as you see fit!
Features for text format admins
- Change between Font Awesome 6 and legacy Font Awesome 5. Both are supported.
- Add a default "Recommended" category with frequently-used icons specific to your site.
- Add or remove any Font Awesome style (such as Solid, Regular, Brands) from the picker.
- Supply Font Awesome Pro metadata.
Features for developers
- Build a custom CKEditor 5 plugin to add your own items to an icon's toolbar, simply by altering the
icon.toolbarItemsconfiguration.
Post-Installation
After installation, enable the plugin by dragging the "Icons" item onto the toolbar of your text format (/admin/config/content/formats). A good spot is next to "Special characters". The plugin provides a configuration form, be sure to review the configuration before saving.
Additional Requirements
This plugin was developed exclusively for modern Drupal 9.5+ sites and requires CKEditor 5, meaning it is entirely incompatible with CKEditor 4 or other editors. It has been tested on Drupal 10 and is fully compatible, 10.1.3 or later is recommended for the latest CKEditor bug fixes.
CKEditor 4 users should use the plugin provided by Font Awesome Icons.
Recommended modules/libraries
Installing the Font Awesome Icons module is strongly recommended as this module consists only of the plugin and does not attach the required Font Awesome library to your site. It isn't required if you would like to attach the library using your own custom module and don't need Font Awesome Pro metadata (the metadata included with this plugin comes from Font Awesome Free).