class Color

Same name in this branch
  1. 9 core/modules/color/src/Plugin/migrate/destination/Color.php \Drupal\color\Plugin\migrate\destination\Color
  2. 9 core/modules/color/src/Plugin/migrate/source/d7/Color.php \Drupal\color\Plugin\migrate\source\d7\Color
  3. 9 core/lib/Drupal/Component/Utility/Color.php \Drupal\Component\Utility\Color
Same name in other branches
  1. 8.9.x core/modules/color/src/Plugin/migrate/destination/Color.php \Drupal\color\Plugin\migrate\destination\Color
  2. 8.9.x core/modules/color/src/Plugin/migrate/source/d7/Color.php \Drupal\color\Plugin\migrate\source\d7\Color
  3. 8.9.x core/lib/Drupal/Core/Render/Element/Color.php \Drupal\Core\Render\Element\Color
  4. 8.9.x core/lib/Drupal/Component/Utility/Color.php \Drupal\Component\Utility\Color
  5. 10 core/lib/Drupal/Core/Render/Element/Color.php \Drupal\Core\Render\Element\Color
  6. 10 core/lib/Drupal/Component/Utility/Color.php \Drupal\Component\Utility\Color
  7. 11.x core/lib/Drupal/Core/Render/Element/Color.php \Drupal\Core\Render\Element\Color
  8. 11.x core/lib/Drupal/Component/Utility/Color.php \Drupal\Component\Utility\Color

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' => $this->t('Color'),
    '#default_value' => '#ffffff',
);

Plugin annotation

@FormElement("color");

Hierarchy

Expanded class hierarchy of Color

37 string references to 'Color'
AjaxCssTest::testCkeditorAjaxAddCss in core/modules/ckeditor/tests/src/FunctionalJavascript/AjaxCssTest.php
Tests adding style sheets dynamically to CKEditor.
AjaxFormsTestSimpleForm::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestSimpleForm.php
Form constructor.
claro_preprocess_input in core/themes/claro/claro.theme
Implements template_preprocess_HOOK() for input.
color.info.yml in core/modules/color/color.info.yml
core/modules/color/color.info.yml
color.migrate_drupal.yml in core/modules/color/migrations/state/color.migrate_drupal.yml
core/modules/color/migrations/state/color.migrate_drupal.yml

... 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 26

Namespace

Drupal\Core\Render\Element
View source 
class Color extends FormElement {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $class = static::class;
        return [
            '#input' => TRUE,
            '#process' => [
                [
                    $class,
                    'processAjaxForm',
                ],
            ],
            '#element_validate' => [
                [
                    $class,
                    'validateColor',
                ],
            ],
            '#pre_render' => [
                [
                    $class,
                    'preRenderColor',
                ],
            ],
            '#theme' => 'input__color',
            '#theme_wrappers' => [
                '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.', [
                    '%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, [
            'id',
            'name',
            'value',
        ]);
        static::setAttributes($element, [
            'form-color',
        ]);
        return $element;
    }

}

Members

Title Modifiers Object type Summary Overriden Title 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'.
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 16
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.