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 BitPoet
      Here's a small new module that started as a spinoff of a memcache proof-of-concept. Cache your strings and partials in-memory using Redis as a backend.
      CacheRedis
      All you need is a running Redis database. The module supports connection through regular TCP, over TLS and via unix domain sockets. Host and port are configurable, and authentication is supported too. Here's a screenshot of the module configuration options:

      I'll not go into too many details about the usage, you can see everything explained in the README on GitHub, and just highlight the most important points.
      When the module is active, you'll have a wired $redis variable, which means you can reach the module as $redis, wire("redis") or within Wire classes / modules as $this->redis.
      CacheRedis is strongly influenced by WireCache, and its usage is (hopefully) straight forward.
      // Store an entry in the cache under the given key name with the given value: $redis->store("cached_value_number_one", $expire, $value); // Retrieve a value from the cache $value = $redis->fetch($key); // Delete a cache entry $redis->delete("my_other_cached_value"); // Clear the whole cache $redis->flush(); // Retrieve a value from the cache, and if not found, create it through the given function // and store it with a lifetime of 5 minutes (300 seconds) $value = $redis->fetch($key, 300, function() use($page) { return "Page last changed on " . strftime('%m/%d/%Y %H:%M', $page->modified | $page->created); }); // Render a file using wireRenderFile and store it in the cache. // We'll pass a selector as the expiry value so this cache gets // emptied every time a page matching the selector is saved. $news = $redis->renderFile("partials/news.php", 'template=blog-post', ["page" => $page]); The module is still very crude work in progress, but I hope some of you feel daring, try it out and let me know in case anything breaks.
      Have fun!
    • By joshua
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="optin" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="optin" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="optin" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="optin" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The type has to be "optin" to get recognized by PrivacyWire, the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button> This module is still in development, but we already use it on several production websites.
      You find it here: PrivacyWire Git Repo
      Download as .zip
      I would love to hear your feedback 🙂
      CHANGELOG
      0.0.5 Multi-language support included completely (also in TextFormatter). Added possibility to async load other assets (e.g. <img type="optin" data-category="marketing" data-src="https://via.placeholder.com/300x300">) 0.0.4 Added possibility to add an imprint link to the banner 0.0.3 Multi-language support for module config (still in development) 0.0.2 First release 0.0.1 Early development
    • By MoritzLost
      This is a new module that 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) 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.
      Beta release
      Note that I consider this a Beta release. Since the module is relatively aggressive in deleting some caches, I would advise you to install in on a test environment before using it on a live site.
      Let me know if you're getting any errors, have trouble using the module or if you have suggestions for improvement!
      In particular, can someone let me know if this module causes any problems with the ProCache module? I don't own or use it, so I can't check. As far as I can tell, ProCache uses a folder inside the cache directory to cache static pages, so my module should be able to clear the ProCache site cache as well, I'd appreciate it if someone can test that for me.
      Future plans
      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

    • By David Karich
      Admin Page Tree Multiple Sorting
      ClassName: ProcessPageListMultipleSorting
      Extend the ordinary sort of children of a template in the admin page tree with multiple properties. For each template, you can define your own rule. Write each template (template-name) in a row, followed by a colon and then the additional field names for sorting.
      Example: All children of the template "blog" to be sorted in descending order according to the date of creation, then descending by modification date, and then by title. Type:
      blog: -created, -modified, title  Installation
      Copy the files for this module to /site/modules/ProcessPageListMultipleSorting/ In admin: Modules > Check for new modules. Install Module "Admin Page Tree Multible Sorting". Alternative in ProcessWire 2.4+
      Login to ProcessWire backend and go to Modules Click tab "New" and enter Module Class Name: "ProcessPageListMultipleSorting" Click "Download and Install"   Compatibility   I have currently tested the module only under PW 2.6+, but think that it works on older versions too. Maybe someone can give a feedback.     Download   PW-Repo: http://modules.processwire.com/modules/process-page-list-multiple-sorting/ GitHub: https://github.com/FlipZoomMedia/Processwire-ProcessPageListMultipleSorting     I hope someone can use the module. Have fun and best regards, David
×
×
  • Create New...