silverware / font-icons
SilverWare Font Icons Module.
Installs: 6 636
Dependents: 4
Suggesters: 0
Security: 0
Stars: 8
Watchers: 2
Forks: 5
Open Issues: 2
Type:silverstripe-vendormodule
Requires
- php: >=5.6.0
- silverstripe/framework: ^4.0
- silverware/colorpicker: ^1.0
- silverware/select2: ^1.0
- symfony/yaml: ~3.2
README
Provides a new form field and database field type for referencing a font icon. Intended to be used with SilverWare, however this module can also be installed into a regular SilverStripe v4 project. A backend for Font Awesome is provided with the module.
Contents
- Background
- Requirements
- Installation
- Configuration
- Usage
- Issues
- To-Do
- Contribution
- Attribution
- Maintainers
- License
Background
Font icons are neat. They look great on all devices, and are really easy to reference via HTML and CSS. However, font icon libraries such as Font Awesome provide a staggering amount of icons, and we can't really expect users to remember the icon names, codes, or have to refer to a cheatsheet.
We could just provide a standard select field listing all of the icons on offer, but users need to know
what the icons look like. Enter FontIconField
provided by this module. An extension of the SilverWare
Select2AjaxField
class, it provides an Ajax-powered searchable list of icons provided by the configured
backend, along with a preview of each icon.
Requirements
Installation
Installation is via Composer:
$ composer require silverware/font-icons
Configuration
As with all SilverStripe modules, configuration is via YAML. The SilverStripe dependency injector is used to configure the font icon backend. Font Awesome is configured by default:
SilverStripe\Core\Injector\Injector: FontIconBackend: class: SilverWare\FontIcons\Backends\FontAwesomeBackend properties: version: 4.7.0 classes: icon: fa-%s list-item: fa-li fixed-width: fa-fw
You can specify the version of Font Awesome in use by changing the version
property. Upon flush, the
backend will download a full list of icons from GitHub and cache the results until the next flush.
Usage
Field Type
To make use of font icons in your code, you can reference the field type in your $db
array:
use SilverStripe\ORM\DataObject; class MyObject extends DataObject { private static $db = [ 'Icon' => 'FontIcon' ]; }
You can also use
the field type within your class file, and reference the field type directly:
use SilverStripe\ORM\DataObject; use SilverWare\FontIcons\ORM\FieldType\DBFontIcon; class MyObject extends DataObject { private static $db = [ 'Icon' => DBFontIcon::class ]; }
Form Field
Within your getCMSFields
method, create a FontIconField
to allow the user to select an icon:
FontIconField::create('Icon', $this->fieldLabel('Icon'));
Don't forget to first use
the field in the header of your class file:
use SilverWare\FontIcons\Forms\FontIconField;
Data Extension
The module also comes with a data extension class to easily add font icons to data objects within
SilverStripe. The extension adds a FontIcon
database field, and a new Icon tab within the CMS
containing a FontIconField
.
To apply the extension to your class, use YAML configuration:
MyNamespace\MyObject: extensions: - SilverWare\FontIcons\Extensions\FontIconExtension
Issues
Please use the GitHub issue tracker for bug reports and feature requests.
To-Do
- Tests
Contribution
Your contributions are gladly welcomed to help make this project better. Please see contributing for more information.
Attribution
- Makes use of Font Awesome by Dave Gandy.
- Special thanks to @hailwood for providing a sane example of how to parse the source icons from Font Awesome with his SilverStripe v3 module.
Maintainers
License
BSD-3-Clause © Praxis Interactive