Jump to content
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 22

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 5

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 tested on Hosting and it works Correctly ... It's a bit weird, maybe it's through the Win 10 + Xampp Server ...

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 3

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

@titanium

Sorry for the extremely delayed answer.

On 22.10.2017 at 9:28 PM, titanium said:

But wait, there is a "0" missing in JS error log's message...

Thanks for pointing on this. I pushed an update which allows to use InputfieldColor as a config field for modules.

I have made some changes in the code you have posted and tested it within the following module. Everything seems to work. Please check out.

<?php namespace ProcessWire;

class My2Module extends WireData implements Module, ConfigurableModule {

	/**
	 *
	 * @return array
	 *
	 */
	public static function getModuleInfo() {

		return array(
			'title' => 'My2Module',
			'summary' => 'Module with Config Input of type Color', 
			'version' => 100
			);
	}

	static public function getDefaultConfig() {
		return array(
			'color' => '#ff3300'
		);
	}

	public function __construct() {
		foreach(self::getDefaultConfig() as $key => $value) {
			$this->$key = $value;
		}
	}

	/**
	 * Initialize, attach hooks 
	 *
	 */
	public function init() {
		// ...
	}

	/**
	 * module settings
	 *
	 */
	static public function getModuleConfigInputfields(array $data) {
		
		$fields = new InputfieldWrapper();
		$defaults = self::getDefaultConfig();
		$data = array_merge($defaults, $data);
	
		$colors = [
				'name'         => 'color',
				'inputType'    => 3,
				'type'         => 'color', // will search for 'InputfieldColor'
				// 'outputFormat' => 3, // REMOVED outputFormat is related to the Fieldtype and not to the Inputfield
				// 'defaultValue' => '#ff0080ff', // REMOVED @see getDefaultConfig() and __construct()
				// 'alpha'        => 0, // REMOVED related to 'inputType=4', otherwise automatically set by the Inputfield
				'spectrum'     => "showInput: true\nallowEmpty:true\nshowAlpha: true\nshowInitial: true\nchooseText: \"Alright\"\ncancelText: \"No way\"\npreferredFormat: \"hex3\"",
				// 'class'        => 'FieldtypeColor', // REMOVED (unnecessary)
				'label'        => __('Label'),
				'description'  => __('Description'),
				'required'     => false,
				'value'        => $data['color'],
				'notes'        => __('Initial value: '.$defaults['color']),
			];

		$fields->add($colors);
		return $fields;
	}
}

 

  • Like 3

Share this post


Link to post
Share on other sites

@kixe - it might be worth noting that this module requires PHP's bcmath extension because of the call to: bcmod (and maybe others). 

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 MoritzLost
      TrelloWire
      This is a module that allows you to automatically create Trello cards for ProcessWire pages and update them when the pages are updated. This allows you to setup connected workflows. Card properties and change handling behaviour can be customized through the extensive module configuration. Every action the module performs is hookable, so you can modify when and how cards are created as much as you need to. The module also contains an API-component that makes it easy to make requests to the Trello API and build your own connected ProcessWire-Trello workflows.
      Features
      All the things the module can do for you without any custom code: Create a new card on Trello whenever a page is added or published (you can select applicable templates). Configure the target board, target list, name and description for new cards. Add default labels and checklists to the card. Update the card whenever the page is updated (optional). When the status of the card changes (published / unpublished, hidden / unhidden, trashed / restored or deleted), move the card to a different list or archive or delete it (configurable). You can extend this through hooks in many ways: Modifiy when and how cards are created. Modify the card properties (Target board & list, title, description, et c.) before they are sent to Trello. Create your own workflows by utilizing an API helper class with many convenient utility methods to access the Trello API directly. Feedback & Future Plans
      Let me know what you think! In particular:
      If you find any bugs report them here or on Github, I'll try to fix them. This module was born out of a use-case for a client project where we manage new form submissions through Trello. I'm not sure how many use-cases there are for this module. If you do use it, tell me about it! The Trello API is pretty extensive, I'll try to add some more helper methods to the TrelloWireApi class (let me know if you need anything in particular). I'll think about how the module can support different workflows that include Twig – talk to me if you have a use-case! Next steps could be a dashboard to manage pages that are connected to a Trello card, or a new section in the settings tab to manage the Trello connection. But it depends on whether there is any interest in this 🙂 Links
      Repository on Github Complete module documentation (getting started, configuration & API documentation) [Module directory pending approval] Module configuration

    • By MoritzLost
      Process Cache Control
      This module provides a simple solution to clearing all your cache layers at once, and an extensible interface to perform various cache-related actions.
      The simple motivation behind this module was that I was tired of manually clearing caches in several places after deploying a change on a live site. The basic purpose of this module is a simple Clear all caches link in the Setup menu which clears out all caches, no matter where they hide. You can customize what exactly the module does through it's configuration menu:
      Expire or delete all cache entries in the database, or selectively clear caches by namespace ($cache API) Clear the the template render cache. Clear out specific folders inside your site's cache directory (/site/assets/cache) Clear the ProCache page render cache (if your site is using ProCache) Refresh version strings for static assets to bust client-side browser caches (this requires some setup, see the full documentation for details). This is the basic function of the module. However, you can also add different cache management action through the API and execute them through the module's interface. For this advanced usage, the module provides:
      An interface to see all available cache actions and execute them. A system log and logging output on the module page to see verify what the module is doing. A CacheControlTools class with utility functions to clear out different caches. An API to add cache actions, execute them programmatically and even modify the default action. Permission management, allowing you granular control over which user roles can execute which actions. The complete documentation can be found in the module's README.
      Plans for improvements
      If there is some interest in this, I plan to expand this to a more general cache management solution. I particular, I would like to add additional cache actions. Some ideas that came to mind:
      Warming up the template render cache for publicly accessible pages. Removing all active user sessions. Let me know if you have more suggestions!
      Links
      https://github.com/MoritzLost/ProcessCacheControl ProcessCacheControl in the Module directory CHANGELOG in the repository Screenshots


    • By Macrura
      PrevNextTabs Module
      Github: https://github.com/outflux3/PrevNextTabs
      Processwire helper modules for adding page navigation within the editor.
      Overview
      This is a very simple module that adds Previous and Next links inline with the tabs on the page editor. Hovering over the tab shows the title of the previous or next page (using the admin's built in jqueryUI tooltips.)
      Usage
      This module is typically used during development where you or your editors need to traverse through pages for the purpose of proofing, flagging and/or commenting. Rather than returning to the page tree or lister, they can navigate with these links.
      Warnings
      If you are using PW version 2.6.1 or later, the system will prevent you from leaving the page if you have unsaved edits.
      For earlier versions, to avoid accidentally losing changes made to a page that might occur if a user accidentally clicks on one of these, make sure to have the Form Save Reminder module installed.
      http://modules.processwire.com/modules/prev-next-tabs/
    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
×
×
  • Create New...