silverware / colorpicker
SilverWare Colorpicker Module.
Installs: 9 772
Dependents: 4
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 4
Open Issues: 2
Language:JavaScript
Type:silverstripe-vendormodule
Requires
- php: >=5.6.0
- silverstripe/framework: ^4@dev
This package is not auto-updated.
Last update: 2024-10-25 08:17:43 UTC
README
Provides a new form field and database field type for choosing a color via a colorpicker. Intended to be used with SilverWare, however this module can also be installed into a regular SilverStripe v4 project.
Contents
- Requirements
- Installation
- Configuration
- Usage
- Issues
- To-Do
- Contribution
- Attribution
- Maintainers
- License
Requirements
Installation
Installation is via Composer:
$ composer require silverware/colorpicker
Configuration
As with all SilverStripe modules, configuration is via YAML. The SilverStripe dependency injector is
used to configure the color field type. Extensions to LeftAndMain
are also applied via config.yml
.
Usage
Field Type
To make use of the color field type in your code, you can reference the type in your $db
array:
use SilverStripe\ORM\DataObject; class MyObject extends DataObject { private static $db = [ 'MyColor' => 'Color' ]; }
You can also use
the field type within your class file, and reference the field type directly:
use SilverStripe\ORM\DataObject; use SilverWare\Colorpicker\ORM\FieldType\DBColor; class MyObject extends DataObject { private static $db = [ 'MyColor' => DBColor::class ]; }
Form Field
Within your getCMSFields
method, create a ColorField
to allow the user to choose a color:
ColorField::create('MyColor', $this->fieldLabel('MyColor'));
Don't forget to first use
the field in the header of your class file:
use SilverWare\Colorpicker\Forms\ColorField;
Issues
Please use the GitHub issue tracker for bug reports and feature requests.
To-Do
- Tests
Contribution
Your contributions are gladly welcomed to help make this project better. Please see contributing for more information.
Attribution
- Makes use of Bootstrap Colorpicker by Javi Aguilar.
Maintainers
License
BSD-3-Clause © Praxis Interactive