You are here

Home » API reference » Bootstrap Styles 1.0.x » BoxShadow.php

class BoxShadow in Bootstrap Styles 1.0.x

Class BoxShadow.

@package Drupal\bootstrap_styles\Plugin\Style

Plugin annotation


@Style(
  id = "box_shadow",
  title = @Translation("Box shadow"),
  group_id = "shadow",
  weight = 5
)

Hierarchy

Expanded class hierarchy of BoxShadow

File

src/Plugin/BootstrapStyles/Style/BoxShadow.php, line 20

Namespace

Drupal\bootstrap_styles\Plugin\BootstrapStyles\Style
View source 
class BoxShadow extends StylePluginBase {

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config();
    $form['shadow']['box_shadow'] = [
      '#type' => 'textarea',
      '#default_value' => $config
        ->get('box_shadow'),
      '#title' => $this
        ->t('Box shadow (classes)'),
      '#description' => $this
        ->t('<p>Enter one value per line, in the format <b>key|label</b> where <em>key</em> is the CSS class name (without the .), and <em>label</em> is the human readable name of the text.</p>'),
      '#cols' => 60,
      '#rows' => 5,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config()
      ->set('box_shadow', $form_state
      ->getValue('box_shadow'))
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  public function buildStyleFormElements(array &$form, FormStateInterface $form_state, $storage) {
    $form['box_shadow'] = [
      '#type' => 'radios',
      '#options' => $this
        ->getStyleOptions('box_shadow'),
      '#title' => $this
        ->t('Box Shadow'),
      '#title_display' => 'invisible',
      '#default_value' => $storage['box_shadow']['class'] ?? NULL,
      '#validated' => TRUE,
      '#attributes' => [
        'class' => [
          'bs-field-box-shadow',
        ],
      ],
    ];

    // Add icons to the container types.
    foreach ($form['box_shadow']['#options'] as $key => $value) {
      $form['box_shadow']['#options'][$key] = '<span class="input-icon ' . $key . '"></span>' . $value;
    }

    // Attach the Layout Builder form style for this plugin.
    $form['#attached']['library'][] = 'bootstrap_styles/plugin.box_shadow.layout_builder_form';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitStyleFormElements(array $group_elements) {
    return [
      'box_shadow' => [
        'class' => $group_elements['box_shadow'],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function build(array $build, array $storage, $theme_wrapper = NULL) {
    $classes = [];
    if (isset($storage['box_shadow']['class'])) {
      $classes[] = $storage['box_shadow']['class'];
    }

    // Add the classes to the build.
    $build = $this
      ->addClassesToBuild($build, $classes, $theme_wrapper);

    // Attach bs-classes to the build.
    $build['#attached']['library'][] = 'bootstrap_styles/plugin.box_shadow.build';
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BoxShadow::build public function Overrides StylePluginBase::build
BoxShadow::buildConfigurationForm public function Overrides StylePluginBase::buildConfigurationForm
BoxShadow::buildStyleFormElements public function Overrides StylePluginBase::buildStyleFormElements
BoxShadow::submitConfigurationForm public function Overrides StylePluginBase::submitConfigurationForm
BoxShadow::submitStyleFormElements public function Overrides StylePluginBase::submitStyleFormElements
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 2
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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.
StylePluginBase::$configFactory protected property The config factory.
StylePluginBase::addClassesToBuild public function Helper function to add the classes to the build.
StylePluginBase::config public function
StylePluginBase::CONFIG constant Config settings.
StylePluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
StylePluginBase::getStyleOptionClassByIndex public function Helper function to get the class from the options list.
StylePluginBase::getStyleOptionIndexByClass public function Helper function to get the index of the class at options list.
StylePluginBase::getStyleOptions public function Helper function to get the options of given style name.
StylePluginBase::getStyleOptionsCount public function Helper function to get the options of given style name.
StylePluginBase::getSvgIconMarkup public function Helper function to get SVG Markup.
StylePluginBase::getTitle public function Return the name of the Styles Group form plugin. Overrides StylePluginInterface::getTitle
StylePluginBase::validateConfigurationForm public function
StylePluginBase::__construct public function Constructs a StylePluginBase object. Overrides PluginBase::__construct 1