class ColorPickerWidget

Plugin implementation of the 'field_example_color_picker' widget.

Plugin annotation

@FieldWidget(
  id = "field_example_color_picker",
  module = "field_example",
  label = @Translation("Color Picker"),
  field_types = {
    "field_example_rgb"
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface
      • class \Drupal\Core\Field\WidgetBase extends \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\WidgetInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
        • class \Drupal\field_example\Plugin\Field\FieldWidget\TextWidget extends \Drupal\Core\Field\WidgetBase
          • class \Drupal\field_example\Plugin\Field\FieldWidget\ColorPickerWidget extends \Drupal\field_example\Plugin\Field\FieldWidget\TextWidget

Expanded class hierarchy of ColorPickerWidget

File

modules/field_example/src/Plugin/Field/FieldWidget/ColorPickerWidget.php, line 20

Namespace

class ColorPickerWidget extends TextWidget {
    
    /**
     * {@inheritdoc}
     */
    public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
        $element = parent::formElement($items, $delta, $element, $form, $form_state);
        $element['value'] += [
            '#suffix' => '<div class="field-example-color-picker"></div>',
            '#attributes' => [
                'class' => [
                    'edit-field-example-color-picker',
                ],
            ],
            '#attached' => [
                // Add Farbtastic color picker and the JavaScript file to trigger it.
'library' => [
                    'field_example/color.picker',
                ],
            ],
        ];
        return $element;
    }

}

Members