silverstripe-font-awesome/readme.md

54 lines
1.2 KiB
Markdown
Raw Normal View History

2015-05-09 05:23:07 +02:00
## Synopsis
Provides a field to easily pick font-awesome icons
2015-05-09 02:31:32 +02:00
## Features
* Easily pick icons to be used anywhere in the frontend
* Can filter on icon name
2015-05-09 02:31:32 +02:00
## Installation
### Composer
Make sure you're not double loading the css/fonts with a theme.
Ideally composer will be used to install this module.
```composer require "moe/font-awesome:@stable"```
## Screen shots
### Font awesome icon view
![Font awesome icon]( "Colour swabs")
---------------------------------------
### Filter view
![Filter]( "Colour filter")
2015-05-09 02:31:32 +02:00
## Usage
A basic working example, and the following to any class you want the field on;
```php
private static $db = array(
'Icon' => 'Varchar(255)',
);
2015-05-09 02:31:32 +02:00
public function getCMSFields()
2015-05-09 02:31:32 +02:00
{
$fields = parent::getCMSFields();
$fields->addFieldsToTab('Root.Main', array(
FontAwesomeField::create("Icon", "Font Awesome icon")
2015-05-09 02:31:32 +02:00
));
return $fields;
}
```
Then simple include in the template where you want the icon placed
2015-05-09 02:31:32 +02:00
```html
<i class="fa $Icon"></i>
2015-05-09 02:31:32 +02:00
```
The controller extension should make sure you've got access to the icons so you don't need to double up the CSS file.
2015-05-09 05:23:07 +02:00
## Libraries used/modified
* Font Awesome Icon Picker