Download the PHP package buckleshusky/fontawesomeiconpicker without Composer
On this page you can find all versions of the php package buckleshusky/fontawesomeiconpicker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download buckleshusky/fontawesomeiconpicker
More information about buckleshusky/fontawesomeiconpicker
Files in buckleshusky/fontawesomeiconpicker
Package fontawesomeiconpicker
Short Description Adds a Font Awesome 6.x icon picker for SilverStripe.
License BSD-3-Clause
Informations about the package fontawesomeiconpicker
Font Awesome Icon Picker
Adds a Font Awesome 6.x icon picker to SilverStripe 4. This uses the CDN for Fontawesome 6.2.0. This will work with Fontawesome 6.2.0 pro out-of-the-box (but you will need to have a copy of the kit).
With the Free version of Font Awesome
Starts out slim: Expands to allow you to seach for your desired icon: A list of your recently toggled icons:
With the Pro version of Font Awesome
Everything that you can do in the free version, you can do in the pro version. The pro version however comes with more options.
When enabled, Light and Duotone icon styles are unlocked:
Sharp icons, by default, are enabled when you switch to pro:
Requirements
- SilverStripe 4.x or 5.x
Installation
Installation is supported via composer only
- Run
dev/build?flush=all
to regenerate the manifest
Usage
Simply add the field to a DataObject or Page like you normally would. This will save the Font Awesome Icon's class info to a dbfield for use on the front end.
If needed, you can add the following to your PageController
or any page controller that extends PageController
. This can be added to the init()
method like below:
Notes
The field has not been tested for use on the frontend of a site.
Settings
Enable Font Awesome Pro
To enable Font Awesome Pro, add this to your yml file.
Replace all.min.css
and sharp-solid.min.css
with the Font Awesome Pro css name.
These files should be located in your theme's css folder.
Options: | Option | Description | Values | default |
---|---|---|---|---|
free_css_cdn_version | for the FREE version. This is the version to get from the fontawesome CDN. This can be used to get the new version. You will still need a copy of icon-families.yml. | the version to get from the CDN | 6.2.0 | |
unlock_pro_mode | enable this to switch to PRO version | true/false | false | |
disable_sharp_icons | with this enabled, the sharp icons will not be loaded. pro_sharp_css will also not be required. | true/false | false | |
pro_css | the name of the PRO version css file | string | ||
pro_sharp_css | the name of the PRO version sharp css file. This should be a combined css file containing the sharp-solid, sharp-regular, sharp-light. Example: `` | string | ||
pro_sharp_css_folder | the name of the folder that contains the css files that start with sharp-. Using this, it will scan through the folder and load all css files that start with sharp-. Example: `` | string | ||
icon_yml_location | This is the location of the icon-families.yml file in your theme. | string | ||
disable_generate_on_build | This will disable generating icons on dev/build. If you don't feel you'll update your icons, you can set this to disabled | true/false | false |
How to setup the PRO version of fontawesome?
- You will need to download a kit from the fontawesome site.
- Grab the css file for
all.min.css
andsharp-[x].min.css
(where x is the different variants of sharp) and place it in your theme's css folder. - Grab the
webfonts
folder and place it in your theme's folder. Examplethemes\simple
. -
update your config:
- place the
icon-families.yml
yml file into your site's app folder. In this example, it would be placed inapp/fontawesome/icon-families.yml
. - do a
dev/build
, or, if you have it disabled, run the following tasksdev/tasks/generate-font-awesome
How do I use a newer version of Fontawesome?
- Get a copy of
icon-families.yml
.- You can obtain this from their github.
- for pro, you will get this file when you download pro from fontawesome
- Place this file into your site's app folder.
- Updated
icon_yml_location
to point to the yml's folder i.e.app/fontawesome/icon-families.yml
-
For the FREE version you can optionally do the following:
- add the following to your yml with the desired version you would like from the CDN:
- For the PRO version:
- follow the steps above for How to setup the PRO version of fontawesome?
What's New
- switched to use FontawesomeIconsListCustom yml config to prevent duplicate icons
- clicking sharp now allows you to select type
- when you click a family, the type buttons are filtered down to only show you what's available
- added support for display logic
- added support for all sharp icons not just sharp solid
- pagination no longer remembers the page when choose a family/type
- when you expand the field, it will get the family and switch to the proper tab
- updated documentation
Future
- add back in removing icons
- removed for now to clean this up and get it released
- add documentation for adding your own icons
- dynamic generating of style types