toastnz / iconfield
Icon field for SilverStripe
Installs: 568
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 8
Type:silverstripe-vendormodule
Requires
This package is auto-updated.
Last update: 2024-09-29 05:48:53 UTC
README
Simplifies the use of icons in a way content authors can set icons without interfering with the asset library. Instead, the web developer provides the icon set which the end-user can use but not manipulate.
Requirements
- SilverStripe 4
Usage
- Import the required classes:
use Jaedb\IconField\Icon;
use Jaedb\IconField\IconField;
- Set your
$db
field to typeIcon
(eg'PageIcon' => Icon::class
) IconField::create($name, $title, $iconFolder)
$name
is the database field as defined in your class$title
is the label for this field$iconFolder
(optional) defines the directory where your icons can be found. Defaults to/site/icons
.- To change your default icon directory, see
_config/config.yml
. - Use your icon in templates as you would any other property (eg
$PageIcon
). If your icon is an SVG, the SVG image data will be injected into the template. To prevent this, you can call$PageIcon.IMG
instead to enforce use of<img>
tags.