class JqueryMinicolorsWidget in jQuery minicolors 8

Plugin implementation of the 'jquery_minicolors_widget' widget.

Plugin annotation


@FieldWidget(
  id = "jquery_minicolors_widget",
  label = @Translation("Jquery minicolors widget"),
  field_types = {
    "string"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\Core\Field\Plugin\Field\FieldWidget\StringTextfieldWidget
    class \Drupal\jquery_minicolors\Plugin\Field\FieldWidget\JqueryMinicolorsWidget

Expanded class hierarchy of JqueryMinicolorsWidget

File

src/Plugin/Field/FieldWidget/JqueryMinicolorsWidget.php, line 20

Namespace

Drupal\jquery_minicolors\Plugin\Field\FieldWidget

View source

class JqueryMinicolorsWidget extends StringTextfieldWidget {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'size' => 25,
      'placeholder' => '',
      'control' => 'hue',
      'format' => 'hex',
      'opacity' => 0,
      'swatches' => '',
      'position' => 'bottom left',
      'theme' => 'default',
      'animation_speed' => 50,
      'animation_easing' => 'swing',
      'change_delay' => 0,
      'letter_case' => 'lowercase',
      'show_speed' => 100,
      'hide_speed' => 100,
      'keywords' => '',
      'inline' => 0,
    ) + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $control = [
      'hue' => $this
        ->t('Hue'),
      'brightness' => $this
        ->t('Brightness'),
      'saturation' => $this
        ->t('Saturation'),
      'wheel' => $this
        ->t('Wheel'),
    ];
    $elements['control'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Control'),
      '#options' => $control,
      '#default_value' => $this
        ->getSetting('control'),
      '#description' => $this
        ->t('Determines the type of control.'),
    );
    $format = [
      'hex' => $this
        ->t('Hexadecimal'),
      'rgb' => $this
        ->t('RGB notation'),
    ];
    $elements['format'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Format'),
      '#options' => $format,
      '#default_value' => $this
        ->getSetting('format'),
      '#description' => $this
        ->t('The format miniColors should use.'),
    );
    $elements['opacity'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Opacity'),
      '#empty' => 0,
      '#return_value' => 1,
      '#default_value' => $this
        ->getSetting('opacity'),
      '#description' => $this
        ->t('Check this option to enable the opacity slider.'),
    );
    $elements['swatches'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Swatches'),
      '#default_value' => $this
        ->getSetting('swatches'),
      '#description' => $this
        ->t('A list separated by pipe of colors, in either rgb(a) or hex format, that will show up under the main color grid. There can be only up to 7 colors.'),
    );
    $position = [
      'bottom left' => $this
        ->t('Bottom left'),
      'bottom right' => $this
        ->t('Bottom right'),
      'top left' => $this
        ->t('Top left'),
      'top right' => $this
        ->t('Top right'),
    ];
    $elements['position'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Position'),
      '#options' => $position,
      '#default_value' => $this
        ->getSetting('position'),
      '#description' => $this
        ->t('Sets the position of the dropdown.'),
    );
    $theme = [
      'default' => $this
        ->t('Default'),
      'bootstrap' => $this
        ->t('Bootstrap'),
    ];
    $elements['theme'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Theme'),
      '#options' => $theme,
      '#default_value' => $this
        ->getSetting('theme'),
      '#description' => $this
        ->t('jQuery minicolors library provide support for bootstrap theme. Select the theme you want to use for prefixing the selectors.'),
    );
    $elements['inline'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Inline'),
      '#empty' => 0,
      '#return_value' => 1,
      '#default_value' => $this
        ->getSetting('inline'),
      '#description' => $this
        ->t('Check this option to force the color picker to appear inline.'),
    );
    $elements['animation_speed'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Animation Speed'),
      '#default_value' => $this
        ->getSetting('animation_speed'),
      '#description' => $this
        ->t('The animation speed, in milliseconds, of the sliders when the user taps or clicks a new color. Set to 0 for no animation.'),
    );
    $elements['animation_easing'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Animation Easing'),
      '#default_value' => $this
        ->getSetting('animation_easing'),
      '#description' => $this
        ->t('The easing to use when animating the sliders.'),
    );
    $elements['change_delay'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Change Delay'),
      '#default_value' => $this
        ->getSetting('change_delay'),
      '#description' => $this
        ->t('The time, in milliseconds, to defer the change event from firing while the user makes a selection. This is useful for preventing the change event from firing frequently as the user drags the color picker around.'),
    );
    $letter_case = [
      'uppercase' => $this
        ->t('Uppercase'),
      'lowercase' => $this
        ->t('Lowercase'),
    ];
    $elements['letter_case'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Letter Case'),
      '#options' => $letter_case,
      '#default_value' => $this
        ->getSetting('letter_case'),
      '#description' => $this
        ->t('Determines the letter case of the hex code value.'),
    );
    $elements['show_speed'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Show speed'),
      '#default_value' => $this
        ->getSetting('show_speed'),
      '#description' => $this
        ->t('The speed, in milliseconds, at which to show the color picker.'),
    );
    $elements['hide_speed'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Hide speed'),
      '#default_value' => $this
        ->getSetting('hide_speed'),
      '#description' => $this
        ->t('The speed, in milliseconds, at which to hide the color picker.'),
    );
    $elements['keywords'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Keywords'),
      '#default_value' => $this
        ->getSetting('keywords'),
      '#description' => $this
        ->t('A comma-separated list of keywords that the control should accept (e.g. inherit, transparent, initial).'),
    );
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = t('Textfield size: @size', array(
      '@size' => $this
        ->getSetting('size'),
    ));
    if (!empty($this
      ->getSetting('placeholder'))) {
      $summary[] = t('Placeholder: @placeholder', array(
        '@placeholder' => $this
          ->getSetting('placeholder'),
      ));
    }
    $summary[] = t('Control: @control', array(
      '@control' => $this
        ->getSetting('control'),
    ));
    $summary[] = t('Format: @format', array(
      '@format' => $this
        ->getSetting('format'),
    ));
    $summary[] = t('Opacity: @opacity', array(
      '@opacity' => $this
        ->getSetting('opacity') ? 'true' : 'false',
    ));
    if (!empty($this
      ->getSetting('swatches'))) {
      $summary[] = t('Swatches: @swatches', array(
        '@swatches' => $this
          ->getSetting('swatches'),
      ));
    }
    $summary[] = t('Position: @position', array(
      '@position' => $this
        ->getSetting('position'),
    ));
    $summary[] = t('Theme: @theme', array(
      '@theme' => $this
        ->getSetting('theme'),
    ));
    if (!empty($this
      ->getSetting('animation_speed'))) {
      $summary[] = t('Animation speed: @animation_speed', array(
        '@animation_speed' => $this
          ->getSetting('animation_speed'),
      ));
    }
    if (!empty($this
      ->getSetting('animation_easing'))) {
      $summary[] = t('Animation easing: @animation_easing', array(
        '@animation_easing' => $this
          ->getSetting('animation_easing'),
      ));
    }
    $summary[] = t('Change delay: @change_delay', array(
      '@change_delay' => $this
        ->getSetting('change_delay'),
    ));
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element['value'] = $element + array(
      '#type' => 'textfield',
      '#default_value' => isset($items[$delta]->value) ? $items[$delta]->value : NULL,
      '#size' => $this
        ->getSetting('size'),
      '#placeholder' => $this
        ->getSetting('placeholder'),
      '#maxlength' => $this
        ->getFieldSetting('max_length'),
      '#attributes' => [
        'class' => [
          'mini-colors',
        ],
        'data-control' => $this
          ->getSetting('control'),
        'data-format' => $this
          ->getSetting('format'),
        'data-opacity' => $this
          ->getSetting('opacity'),
        'data-position' => $this
          ->getSetting('position'),
        'data-theme' => $this
          ->getSetting('theme'),
        'data-letter-case' => $this
          ->getSetting('letter_case'),
        'data-change-delay' => $this
          ->getSetting('change_delay'),
        'data-show-speed' => $this
          ->getSetting('show_speed'),
        'data-hide-speed' => $this
          ->getSetting('hide_speed'),
      ],
    );
    if ($this
      ->getSetting('swatches')) {

      // Remove all spaces.
      $swatches = preg_replace('/\\s+/', '', $this
        ->getSetting('swatches'));
      $element['value']['#attributes']['data-swatches'] = $swatches;
    }
    if ($this
      ->getSetting('keywords')) {

      // Remove all spaces.
      $keywords = preg_replace('/\\s+/', '', $this
        ->getSetting('keywords'));
      $element['value']['#attributes']['data-keywords'] = $keywords;
    }
    if ($this
      ->getSetting('animation_speed')) {
      $element['value']['#attributes']['data-animation-speed'] = $this
        ->getSetting('animation_speed');
    }
    if ($this
      ->getSetting('animation_easing')) {
      $element['value']['#attributes']['data-animation-easing'] = $this
        ->getSetting('animation_easing');
    }
    if ($this
      ->getSetting('inline')) {
      $element['value']['#attributes']['data-inline'] = $this
        ->getSetting('inline');
    }
    if ($this
      ->getSetting('size')) {
      $element['value']['#attributes']['data-size'] = $this
        ->getSetting('size');
    }
    $element['#attached']['library'][] = 'jquery_minicolors/jquery_minicolors';
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AllowedTagsXssTrait::allowedTags	public	function	Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags	public	function	Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss	public	function	Filters an HTML string to prevent XSS vulnerabilities.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
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
JqueryMinicolorsWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides StringTextfieldWidget::defaultSettings
JqueryMinicolorsWidget::formElement	public	function	Returns the form for a single field widget. Overrides StringTextfieldWidget::formElement
JqueryMinicolorsWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides StringTextfieldWidget::settingsForm
JqueryMinicolorsWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides StringTextfieldWidget::settingsSummary
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
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	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
WidgetBase::$fieldDefinition	protected	property	The field definition.
WidgetBase::$settings	protected	property	The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax	public static	function	Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit	public static	function	Submission handler for the "Add another item" button.
WidgetBase::afterBuild	public static	function	After-build handler for field elements in a form.
WidgetBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	5
WidgetBase::errorElement	public	function	Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement	8
WidgetBase::extractFormValues	public	function	Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues	2
WidgetBase::flagErrors	public	function	Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors	2
WidgetBase::form	public	function	Creates a form element for a field. Overrides WidgetBaseInterface::form	3
WidgetBase::formMultipleElements	protected	function	Special handling to create form elements for multiple values.	1
WidgetBase::formSingleElement	protected	function	Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting	protected	function	Returns the value of a field setting.
WidgetBase::getFieldSettings	protected	function	Returns the array of field settings.
WidgetBase::getFilteredDescription	protected	function	Returns the filtered field description.
WidgetBase::getWidgetState	public static	function	Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents	protected static	function	Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues	protected	function	Returns whether the widget handles multiple values.
WidgetBase::isApplicable	public static	function	Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable	4
WidgetBase::isDefaultValueWidget	protected	function	Returns whether the widget used for default value form.
WidgetBase::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues	7
WidgetBase::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct	public	function	Constructs a WidgetBase object. Overrides PluginBase::__construct	5

You are here

class JqueryMinicolorsWidget in jQuery minicolors 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation