silverstripe-font-awesome/readme.md
2015-05-09 14:58:24 +12:00

974 B

Synopsis

A simple form field for selecting font-awesome classes in the CMS.

Features

  • The latest version of font-awesome
  • Easy to integrate into any project
  • Option to use CDN for loading assets (Defaults to use local)

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"

Usage

A basic working example, and the following to any class you want the field on;


private static $db = array(
   'Icon'  => 'Varchar',
);

public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $fields->addFieldsToTab('Root.ButtonDetails', array(
            FontAwesomeField::create("Icon", "Font Awesome icon"),
        ));

        return $fields;
    }

Then simple include in the template

 <i class="fa $Icon"></i>

Alternatively you can just use the font family via CSS.