kixe

FieldtypeColor

Recommended Posts

FieldtypeColor is on github

Fieldtype stores a 32bit integer value reflecting a RGBA value.

Input
5 types of Inputfields provided

  1. Html5 Inputfield of type='color' (if supported by browser)   
  2. Inputfield type='text' expecting a 24bit hexcode string (RGB). Input format: '#4496dd'.
    The background color of the input field shows selected color
  3. Inputfield of type='text' expecting 32bit hexcode strings (RGB + alpha channel) Input format: '#fa4496dd'
  4. Inputfield with Spectrum Color Picker
    (Options modifiable)
  5. Inputfield type='text' with custom JavaScript and/or CSS (since version 1.0.3)

Output
Define output format under 'Details' tab in field settings. Select from the following 9 options

  1. string 6-digit hex color. Example: '#4496dd'
  2. string 8-digit hex color (limited browser support).  Example: '#fa4496dd'
  3. string CSS color value RGB. Example: 'rgb(68, 100, 221)'
  4. string CSS color value RGB. Example: 'rgba(68, 100, 221, 0.98)'
  5. string CSS color value RGB. Example: 'hsl(227, 69.2%, 56.7%)'
  6. string CSS color value RGB. Example: 'hsla(227, 69.2%, 56.7%, 0.98)'
  7. string 32bit raw hex value. Example: 'fa4496dd'(unformatted output value)
  8. int 32bit. Example: '4198799069' (storage value)
  9. array()
    array(
            [0] => 0-255, // opacity
            [1],['r'] => 0-255,
            [2],['g'] => 0-255,
            [3],['b'] => 0-255,
            ['rx'] => 00-ff,
            ['gx'] => 00-ff,
            ['bx'] => 00-ff,
            ['ox'] => 00-ff, // opacity
            ['o'] => 0-1 // opacity
        )

     

The Fieldtype includes
Spectrum Color Picker by Brian Grinstead


SCREENSHOTS

Input type=text with changing background and font color (for better contrast)
5961bca865f8b_Bildschirmfoto2017-07-09um07_15_59.jpg.f1eb7e6755c9f4294ed153c55ce21099.jpg5961bcada5afb_Bildschirmfoto2017-07-09um07_15_44.jpg.7973bcaf133505bbd00e2f7d376a766b.jpg5961bcbc7a5e4_Bildschirmfoto2017-07-09um07_15_28.jpg.2d5a1f057957060664401e59a5cd5c27.jpg5961bcc326fc1_Bildschirmfoto2017-07-09um07_15_11.jpg.5c5e04f682c8c45ede37075f6754b108.jpg

Input type=color (in Firefox)

5961bd89d58be_Bildschirmfoto2017-07-09um07_11_36.jpg.dbfabd7c9baa0539c0955b3ab75c15ae.jpg


Javascript based input (Spectrum Color Picker)

5961be102fdb8_Bildschirmfoto2017-07-09um06_38_04.jpg.650494794d4f7c37be8f458270726ac7.jpg


Settings Output

5961bdf1aa93a_Bildschirmfoto2017-07-09um07_10_19.jpg.0fb6aff0e5d1eed95778a886a1544d52.jpg

 

Settings Input
5961bdf624096_Bildschirmfoto2017-07-09um07_09_03.jpg.f19af3f408630fde0681923577569cd2.jpg

  • Like 19

Share this post


Link to post
Share on other sites

hi kixe,

thanks for sharing this :) would you mind adding some screenshots or a sample usecase to know when your module would be useful? maybe you could also point out the differences to somas colorpicker module?

thanks!

  • Like 1

Share this post


Link to post
Share on other sites

Updated to Version 1.0.3 with one more Inputfield Option which allows to use any custom JavaScript.
59621ba2834e7_Bildschirmfoto2017-07-09um13_56_41.thumb.jpg.c1bfb55ab2e59b3a0da77e28c8c8a47b.jpg

  • Like 4

Share this post


Link to post
Share on other sites

Some time ago, I made a site for a company which sells wool. In this case I use the fieldtype color for the different colors of a wool product (as a color scheme board). In this case I use the old color picker field (I think it was from Soma). This could be a possible usecase example for this fieldtype.

Share this post


Link to post
Share on other sites

I played around a bit with custom JS based Input. Here are the settings for 3 individual JS based input options:

ColorPicker by Stefan Petr (http://www.eyecon.ro/colorpicker/)

initial JS

$('#{id}').ColorPicker({
    color: '{value}',
    onChange: function (hsb, hex, rgb) {
        $('#{id}').attr('value', '#' + hex);
    }
});

include JS
colorpicker/js/colorpicker.js

include CSS
colorpicker/css/colorpicker.css

5996bb73a3eba_Bildschirmfoto2017-08-17um10_25_35.jpg.dd8c3958bde64fc22e9d0f83bb1191de.jpg

 

 

JSColor by Jan Odvarko (http://jscolor.com/)

initial JS

var input = document.getElementById('{id}');
var picker = new jscolor(input);

include JS
jscolor-2.0.4/jscolor.js

5996bb39235e0_Bildschirmfoto2017-08-17um10_56_43.jpg.2fe2df34fbaed5354c851f8a20e515f4.jpg

 

 

Color Picker (http://dematte.at)

initial JS

$('#{id}').colorPicker();

include JS
dematte/jQueryColorPicker.min.js

Pull js file from here: https://github.com/PitPik/colorPicker/blob/master/jQuery_implementation/jQueryColorPicker.min.js

5996baff218b8_Bildschirmfoto2017-08-17um11_22_03.jpg.ce0d7c3e52b7a163a15ebe2d8ab50f37.jpg


 

 

 

 

  • Like 2

Share this post


Link to post
Share on other sites

Thanks  kixe for this great picker, but I do not know why when saving color lost settings to the defolt? I'm using processwire 3.0.62 Master

Share this post


Link to post
Share on other sites

@rafaoski
Are you talking about the field settings? Could you please explain more detailed what happened that I can reproduce the issue. Thanks.

Share this post


Link to post
Share on other sites

I'm sorry kixe for my bad english ... Maybe this video will bring something ... Maybe somewhere I make a mistake when configuring the plugin ... View and rate ...

 

Share this post


Link to post
Share on other sites

@rafaoski
thanks for the video. Unfortunately I cannot reproduce. Could you check if the value is changed in the database? It looks like the setting is falling back to a previous default value. Could you unset the default value and try again?

I made a screenshop of the fieldsettings. Is it similar to yours? Did you try custom js code?

59a4293c5a7f7_Bildschirmfoto2017-08-28um16_30_10.jpg.f4f13eb7b7a389c6775407e186f16d53.jpg

Share this post


Link to post
Share on other sites

Thanks kixe for the reply ... My table is out of date:

Firefox_Screenshot_2017-08-28T16-16-44_798Z.thumb.png.92609adda1bb8ddee5c973591e71369d.png

And Field Settings Screenshot :

Firefox_Screenshot_2017-08-28T15-25-58_186Z.png.b7928a5f9bcbfaf1b510b675fadc8096.png

I did not add my own js code ... How to solve the problem I will let you know ... Thanks again for help ...

Share this post


Link to post
Share on other sites

I will be testing Laragon ... I just started to refresh the partition on some Linux derivative (maybe manjaro) ... I have to admit that Processwire has very good people around you who help ... Thank you both @kixe and you @bernhard ... Next time before I start looking for problems I will check on other machines - Such a lesson for the future :)

  • Like 1

Share this post


Link to post
Share on other sites

I'm having the problem that i always get the 2nd option output (8 digit hex color, and no hash), no matter what i select for the Output Format.

Right now i'm doing an ltrim($widget->color, 'ff');  on the output, and then adding the hash myself, but would be good to get this fixed...

TIA

Share this post


Link to post
Share on other sites

@Macrura

Page output formatting?

$page->of(false);
var_dump($page->color); // string(8) "ff5a01fd"
$page->of(true);
var_dump($page->color); // string(7) "#5a01fd"

 

  • Like 1

Share this post


Link to post
Share on other sites

Yes - thanks, i'm using the color on an admin dashboard, which is being wireRendered from a module, so i assume that output formatting is off; Is there any way to get the formatted output in this situation?

Share this post


Link to post
Share on other sites

If $widget is a page object it should be possible to put outputformatting on just to grab the value and switch it of after.

If not you can use the formatValue() function from the module. You need a page and a field object as arguments. $page can be any page in this case but $field should be the one where the OF type is stored.

$FieldtypeColor = wire('modules')->get('FieldtypeColor');
$field = new Field();
$unformattedColor = "ff5a01fd";
$page = new Page();
$field->type = $FieldtypeColor;
$field->outputFormat = 0;
$color = $FieldtypeColor->formatValue($page,$field,$unformattedColor);
var_dump($color); // string(7) "#5a01fd" 

 

  • Like 2

Share this post


Link to post
Share on other sites

this does work:

    $FieldtypeColor = wire('modules')->get('FieldtypeColor');
    $field = $fields->get('dw_color');
    $field->outputFormat = 0;
    $widgetColor = $FieldtypeColor->formatValue($widget,$field,$widget->dw_color);

i just wonder if it is simpler/more efficient to do it this way:

$widgetColor = '#' . ltrim($widget->dw_color, 'ff');

 

Share this post


Link to post
Share on other sites

Hi, thanks for this really nice module.

I'm trying to initiate this module from within another module and have no luck so far. This is my config:

$colors[] = [
    'name'         => 'color',
    'type'         => 'color',
    // 'inputType'    => 3,
    'outputFormat' => 3,
    'showInput'    => true,
    'defaultValue' => '#ff0080ff',
    'collapsed'    => 0,
    'alpha'        => 0,
    'spectrum'     => "showInput: true\nallowEmpty:true\nshowAlpha: true\nshowInitial: true\nchooseText: \"Alright\",\ncancelText: \"No way\"\npreferredFormat: \"hex3\"",
    'class'        => 'FieldtypeColor',
    'label'        => $this->_($key),
    'description'  => $this->_(''),
    'required'     => false,
    'value'        => '#ff3300',
    'columnWidth'  => 25,
    'notes'        => $this->_('Initial value: ' . $value),
];

If I comment in "inputType => 3", ProcessWire returns "The process returned no content." when saving my modules config. Ok, as a workaround, I could live without Spectrum. When is commented out, it saves and returns the modules config page correctly.

But the field "color" doesn't show the value of #ff0000. It returns in JS console: "The specified value "#00000" does not conform to the required format." That's weird: where has my Value of "#ff3300" gone? Alright, it seems to return the FieldtypeColor's default of "#000000". But wait, there is a "0" missing in JS error log's message...

Obviously I'm doing something wrong here. I hope someone has an idea how to call this module from within my other custom module correctly. Thanks in advance.

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Macrura
      This is a new module, hope to release soon, which allows extended field descriptions, in currently 2 ways.
      The main feature of the module is that you can have a short description and then a 'more...' link which drops down a longer block of text.
      This is achieved by separating the intro/visible text and the rest with 5 dashes.

      Example setup:

      the 2nd way is if you are using AdminThemeUiKit, you can show extended field instructions in a panel. The content of the panel is edited on a regular PW page. This use case would probably not be that common, but if you had a field that required some extended instructions for how to use, this could be useful; Also, since this allows you to target information and instructions down at the field level, it could reduce the amount of documentation needed on a global level, since it is a lot more context targeted.

    • By netcarver
      Part 1 of a 2 part Module & Service Reveal.
      I'm currently working on a new module: ModuleReleaseNotes that was inspired by the work I originally did on making Ryan's ProcessWireUpgrades module "release" aware. In the end, I decided to ditch the approach I was originally taking and instead work on a module that hooked in to the UpgradeConfirmation dialog and the module edit page.
      Aims
      My aims for this module are as follows...
      Make discovery of a module's changes prior to an upgrade a trivial task. Make breaking changes very obvious. Make reading of a module's support documentation post-install a trivial task. Make module authors start to think about how they can improve the change discovery process for their modules. Make sure the display of information from the module support files/commit messages doesn't introduce a vulnerability. Looking at these in turn...
      Making discovery of a module's changes prior to upgrade a trivial task.
      This is done by adding a "What's changed section" to the upgrade confirmation dialog.  This section takes a best-effort approach to showing what's changed between the installed version and the updated version that's available via the module repository.
      At present, it is only able to talk to github-hosted repositories in order to ask them for the release notes, the changelog file (if present) and a list of commits between the git tag that matches the installed version and the tag matching the latest version.
      It will display the Release Notes (if the author is using the feature), else it will display the commits between the tags (if tagging is used by the module author) else it will show the changelog file (if present) else it will show the latest N commits on the master branch (N, of course, being configurable to your liking.)
      An example of the Github Release Notes pulled in for you, taken from Mike Rockett's TextformatterTypographer Module...

      An example of a tag-to-tag commit list from the same module...

      An example of a changelog - formatted to show just the changes (formatting styles will change)...

      Finally, an example of a fallback list of commits - sorry Adrian ...

       
      Making breaking changes obvious.
      This is currently done by searching for a set of configurable search strings. Later versions may be able to support breaking change detection via use of Semantic Versioning - but this may require some way of signalling the use of this versioning standard on a module-by-module basis.
      For now, then, you can customise the default set of change markers. Here I have added my own alias to the list of breaking change markers and the changes section of the changelog is styled accordingly (these will be improved)...

       
      Make reading of a module's support documentation, post-install, a trivial task.
      This is done by making some of the support files (like the README, CHANGELOG and LICENSE files) readable from the module's information/settings screen. There is an option to control the initial open/closed state of this section...

      Here is Tracy's README file from within the module settings page... 

       
      Make module authors start to think about how they can improve the change discovery process for their modules.
      There are notes in each of the sections displayed on the upgrade confirmation page that help authors use each of the features...

       
      Make sure display of external information doesn't introduce a vulnerability.
      This is an ongoing concern, and is the thing that is most likely to delay or prevent this module's release. Currently, output is formatted either via Markdown + HTML Purifier (if it was originally a Markdown file) or via htmlspecialchars() if it has come from a plaintext file.
       
      Ongoing...
      For now, I've concentrated on integration with GitHub, as most people use that platform to host their code. I know a few people are hosting their repositories with BitBucket (PWFoo comes to mind) and some with GitLab (Mike Rockett?) and I would eventually like to have adaptor implementations for these providers (and perhaps GitKraken) - but for now, GitHub rules and the other hosts are unsupported.
      I hope to have this ready for general release within the next week.
    • By blynx
      Hej,
      A module which helps including Photoswipe and brings some modules for rendering gallery markup. Feedback highly appreciated

      Modules directory: http://modules.processwire.com/modules/markup-processwire-photoswipe
      .zip download: https://github.com/blynx/MarkupProcesswirePhotoswipe/archive/master.zip
      You can add a photoswipe enabled thumbnail gallery / lightbox to your site like this. Just pass an image field to the renderGallery method:
      <?php $pwpswp = $modules->get('Pwpswp'); echo $pwpswp->renderGallery($page->nicePictures); Options are provided like so:
      <?php $galleryOptions = [ 'imageResizerOptions' => [ 'size' => '500x500' 'quality' => 70, 'upscaling' => false, 'cropping' => false ], 'loresResizerOptions' => [ 'size' => '500x500' 'quality' => 20, 'upscaling' => false, 'cropping' => false ], 'pswpOptions' => (object) [ 'shareEl' => false, 'indexIndicatorSep' => ' von ', 'closeOnScroll' => false ] ]; echo $pswp->renderGallery($page->images, $galleryOptions); More info about all that is in the readme: https://github.com/blynx/MarkupProcesswirePhotoswipe
      What do you think? Any ideas, bugs, critique, requests?
      cheers
      Steffen
    • By mtwebit
      Tasker is a module to handle and execute long-running jobs in Processwire. It provides a simple API  to create tasks (stored as PW pages), to set and query their state (Active, Waiting, Suspended etc.), and to execute them via Cron, LazyCron or HTTP calls.
      Creating a task
      $task = wire('modules')->Tasker->createTask($class, $method, $page, 'Task title', $arguments); where $class and $method specify the function that performs the job, $page is the task's parent page and $arguments provide optional configuration for the task.
      Executing a task
      You need to activate a task first
      wire('modules')->Tasker->activateTask($task); then Tasker will automatically execute it using one of its schedulers: Unix cron, LazyCron or TaskerAdmin's REST API + JS client.
      Getting the job done
      Your method that performs the task looks like
      public function longTask($page, &$taskData, $params) { ... } where $taskData is a persistent storage and $params are run-time options for the task.
      Monitoring progress, management
      The TaskerAdmin module provides a Javascript-based front-end to list tasks, to change their state and to monitor their progress (using a JQuery progressbar and a debug log area). It also allows the on-line execution of tasks using periodic HTTP calls performed by Javascript.

       
      Monitoring task progress (and log messages if debug mode is active)

       
      Task data and log

      Detailed info (setup, task dependencies, time limits, REST API etc.) and examples can be found on GitHub.
      This is my first public PW module. I'm sure it needs improvement
       
    • By netcarver
      A very simple textformatter that was inspired by Diogo's RemoveHeight textformatter.
      This one strips the height from any images and either adds a custom class or adds a max-width:100% as an embedded style.
      Github: https://github.com/netcarver/TextformatterFluidImages
      PW Repo: To Be Confirmed.