class Color in Zircon Profile 8

Provides a form element for choosing a color.

Properties:

• #default_value: Default value, in a format like #ffffff.

Example usage:

$form['color'] = array(
  '#type' => 'color',
  '#title' => 'Color',
  '#default_value' => '#ffffff',
);

Plugin annotation

@FormElement("color");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
        • class \Drupal\Core\Render\Element\Color

7 string references to 'Color'

AjaxFormsTestSimpleForm::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestSimpleForm.php

Form constructor.

color.info.yml in core/modules/color/color.info.yml

core/modules/color/color.info.yml

core.data_types.schema.yml in core/config/schema/core.data_types.schema.yml

core/config/schema/core.data_types.schema.yml

FormTest::testColorValidation in core/modules/system/src/Tests/Form/FormTest.php

Tests validation of #type 'color' elements.

FormTestColorForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestColorForm.php

Form constructor.

... See full list

2 #type uses of Color

FormTestColorForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestColorForm.php

Form constructor.

FormTestDisabledElementsForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestDisabledElementsForm.php

Form constructor.

File

core/lib/Drupal/Core/Render/Element/Color.php, line 31

Contains \Drupal\Core\Render\Element\Color.

Namespace

Drupal\Core\Render\Element

class Color extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return array(
      '#input' => TRUE,
      '#process' => array(
        array(
          $class,
          'processAjaxForm',
        ),
      ),
      '#element_validate' => array(
        array(
          $class,
          'validateColor',
        ),
      ),
      '#pre_render' => array(
        array(
          $class,
          'preRenderColor',
        ),
      ),
      '#theme' => 'input__color',
      '#theme_wrappers' => array(
        'form_element',
      ),
    );
  }

  /**
   * Form element validation handler for #type 'color'.
   */
  public static function validateColor(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = trim($element['#value']);

    // Default to black if no value is given.
    // @see http://www.w3.org/TR/html5/number-state.html#color-state
    if ($value === '') {
      $form_state
        ->setValueForElement($element, '#000000');
    }
    else {

      // Try to parse the value and normalize it.
      try {
        $form_state
          ->setValueForElement($element, ColorUtility::rgbToHex(ColorUtility::hexToRgb($value)));
      } catch (\InvalidArgumentException $e) {
        $form_state
          ->setError($element, t('%name must be a valid color.', array(
          '%name' => empty($element['#title']) ? $element['#parents'][0] : $element['#title'],
        )));
      }
    }
  }

  /**
   * Prepares a #type 'color' render element for input.html.twig.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #description, #attributes.
   *
   * @return array
   *   The $element with prepared variables ready for input.html.twig.
   */
  public static function preRenderColor($element) {
    $element['#attributes']['type'] = 'color';
    Element::setAttributes($element, array(
      'id',
      'name',
      'value',
    ));
    static::setAttributes($element, array(
      'form-color',
    ));
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Color::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
Color::preRenderColor	public static	function	Prepares a #type 'color' render element for input.html.twig.
Color::validateColor	public static	function	Form element validation handler for #type 'color'.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormElement::processAutocomplete	public static	function	Adds autocomplete functionality to elements.
FormElement::processPattern	public static	function	#process callback for #pattern form element property.
FormElement::validatePattern	public static	function	#element_validate callback for #pattern form element property.
FormElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback	15
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object.	69
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.