Download the PHP package silverware/iconsetfield without Composer
On this page you can find all versions of the php package silverware/iconsetfield. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download silverware/iconsetfield
More information about silverware/iconsetfield
Files in silverware/iconsetfield
Package iconsetfield
Short Description SilverWare IconSetField Module.
License BSD-3-Clause
Homepage https://github.com/praxisnetau/silverware-iconsetfield
Informations about the package iconsetfield
SilverWare IconSetField Module
A responsive form field for SilverStripe v4, similar to CheckboxSetField... but with Font Awesome icons!
Contents
- Requirements
- Installation
- Configuration
- Usage
- Issues
- Contribution
- Attribution
- Maintainers
- License
Requirements
- SilverStripe Framework v4
- SilverWare Font Icons (includes Font Awesome)
- default CSS classes are configured for the Bootstrap grid
Installation
Installation is via Composer:
Note: forms on the website will automatically load the field requirements if the app is using SilverWare. If you are using a vanilla SilverStripe project, you'll need to load the module script and styles in your app bundle (jQuery is required):
silverware/iconsetfield: client/dist/js/bundle.js
silverware/iconsetfield: client/dist/styles/bundle.css
Configuration
As with all SilverStripe modules, configuration is via YAML. Extensions to LeftAndMain
and
ContentController
are applied via config.yml
.
Theme
The module supports a theme for both the CMS and forms on the website. To define the theme, use the following YAML configuration:
Replace each <color>
with your desired color hex or rgba code.
Columns
By default, the field uses Bootstrap column classes. You can change the column classes by adding them to your YAML:
Usage
Create the field either as part of a Form
, or within your getCMSFields()
method:
The first parameter is the name of the field or many-many relation to save to, and the
second is the field title. The third parameter defines the source for the field,
and is a nested array consisting of ID values mapped to arrays containing
the icon code (i.e. fa-<code>
) and the text for the option.
Maximum Height
You can define a maximum height (in pixels) for your field by using the setMaxHeight()
method:
This will fix the maximum height of your field to 200 pixels, and add a scrollbar to view the remaining options.
Column Widths
The field supports custom column widths for small and large devices. By default,
the field uses a value of 6
for small devices, and 4
for large devices. Based
on the Bootstrap grid of 12
, this means you'll see two options per row on
small devices, and three options per row on large devices.
You can change these values by using:
Options will always be one per row on the smallest screens (i.e. mobile).
Issues
Please use the GitHub issue tracker for bug reports and feature requests.
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.
- Makes use of Bootstrap by the Bootstrap Authors and Twitter, Inc.
Maintainers
Colin Tucker | Praxis Interactive |
License
BSD-3-Clause © Praxis Interactive