How to Add Colour Picker in Magento 2 System Configuration?

Le’ts add a color picker to textbox through system.xml file located at
app\code\Vendor\Extension\etc\adminhtml

<system>
	<section>
    	<group id="my_color_group" ...>
        	<field id="my_color_option" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
                <label>Background Color</label>
                <comment><![CDATA[Background color]]></comment>
                <frontend_model>Vendor\Extension\Block\Color</frontend_model>                     
            </field>
    	</group>
	</section>
</system>

<label>Background Color</label>

<frontend_model>Vendor\Extension\Block\Color</frontend_model>

</field>

</group>

</section>

</system>

Now we have to create one Color.php file at below location under the hood of extension
app\code\Vendor\Extension\Block

<?php
namespace Vendor\Extension\Block; 
class Color extends \Magento\Config\Block\System\Config\Form\Field { 
	public function __construct(
    \Magento\Backend\Block\Template\Context $context, array $data = []
	) {
        parent::__construct($context, $data);
	}
 
	protected function _getElementHtml(\Magento\Framework\Data\Form\Element\AbstractElement $element) {
    	$html = $element->getElementHtml();
    	$value = $element->getData('value');
 
    	$html .= '<script type="text/javascript">
            require(["jquery","jquery/colorpicker/js/colorpicker"], function ($) {
                $(document).ready(function () {
                	var $el = $("#' . $element->getHtmlId() . '");
                    $el.css("backgroundColor", "'. $value .'");
 
                	// Attach the color picker
                    $el.ColorPicker({
                    	color: "'. $value .'",
                        onChange: function (hsb, hex, rgb) {
                            $el.css("backgroundColor", "#" + hex).val("#" + hex);
                    	}
                	});
            	});
        	});
	        </script>';
    	return $html;
	}
 
}

<?php

namespace Vendor\Extension\Block;

class Color extends \Magento\Config\Block\System\Config\Form\Field {

public function __construct(

\Magento\Backend\Block\Template\Context $context, array $data = []

) {

parent::__construct($context, $data);

}

protected function _getElementHtml(\Magento\Framework\Data\Form\Element\AbstractElement $element) {

$html = $element->getElementHtml();

$value = $element->getData('value');

$html .= '<script type="text/javascript">

require(["jquery","jquery/colorpicker/js/colorpicker"], function ($) {

$(document).ready(function () {

var $el = $("#' . $element->getHtmlId() . '");

$el.css("backgroundColor", "'. $value .'");

// Attach the color picker

$el.ColorPicker({

color: "'. $value .'",

onChange: function (hsb, hex, rgb) {

$el.css("backgroundColor", "#" + hex).val("#" + hex);

}

});

</script>';

return $html;

}

We need to implement JavaScript color picker library to adminhtml_system_config_edit.xml file available at app\code\Vendor\Extension\view\adminhtml\layout

<?xml version="1.0" encoding="UTF-8"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" layout="admin-2columns-left" xsi:noNamespaceSchemaLocation="../../../../../../../lib/internal/Magento/Framework/View/Layout/etc/page_configuration.xsd">
	<head>
    	<css src="jquery/colorpicker/css/colorpicker.css"/>
    	<link src="jquery/colorpicker/js/colorpicker.js"/>
	</head>
</page>

<?xml version="1.0" encoding="UTF-8"?>

<head>

</head>

</page>

Fill the below form if you have any Magento programming need.

Add an image programmatically from any url in Magento 2
[crayon-63e0a8f32e1a3208397538/] Using above fucntion Images can be imported directly from...
Magento 2 : Override the Category view block file
Override view block using di.xml and add the below code...
How to check list of Layout XML called for a specific page in Magento 2?
You can check a list of called layout XML for...
Magento 2 : Setup PWA from Scratch
Follow the below steps to install and set up PWA...
How to remove leading zero’s from the order, invoice and shipment number in Magento 2?
If you want to remove all leading zero's from order,...

Author Info

Magento 2 Developer

Hire H. Shingala

Let’s have a call

Fill the form & Get Installation Support