Redactor Icon Buttons plugin for Craft CMS

Redactor Icon Buttons , _(*1)

This plugin allows to replace the text buttons with icons in the Redactor editor toolbar in Craft CMS., _(*2)

Installation

The plugin is available on Packagist and can be installed using Composer. You can also download the [latest release]0 and copy the files into craft/plugins/redactoriconbuttons/., _(*3)

$ composer require carlcs/craft-redactoriconbuttons

Enable the plugin in your Redactor config files stored in craft/config/redactor/ by adding iconbuttons to the plugins setting. Make sure you have a config file in your Redactor field settings selected where the plugin is enabled., _(*4)

Icon Sets

The icon set the plugin uses by default contains a collection of icons from the Redactor 10 editor and some handcrafted icons to complement the set., _(*5)

If you want to use a custom icon set, create a folder craft/config/redactoriconbuttons/ and add a SVG sprite named icons.svg to it. You can now use the iconMapping config setting to map symbols contained in the SVG to individual buttons., _(*6)

The plugin includes an example file with icons from the Google Material icon set in the _examples/ folder, the file was created with the Icomoon App., _(*7)

Configuration

The plugin is pre-configured for Redactor’s default buttons. To customize it, create a new plugin configuration file in the craft/config/ folder named redactoriconbuttons.php, which returns an array of settings., _(*8)

iconMapping (see defaults) – Maps buttons to icons. The setting expects an array of key-value pairs that map a button’s index (inspect the “rel” attribute in the toolbar!) to the symbol ID of an icon in the SVG sprite.
ieShim (default true) – Adds external spritemap support for IE9+ and Edge 12.