class PopoverAnimation

The "popover_animation" theme setting.

Plugin annotation

@BootstrapSetting(
  id = "popover_animation",
  type = "checkbox",
  title = @Translation("animation"),
  description = @Translation("Apply a CSS fade transition to the popover."),
  defaultValue = 1,
  groups = {
    "javascript" = @Translation("JavaScript"),
    "popovers" = @Translation("Popovers"),
    "options" = @Translation("Options"),
  },
)

Hierarchy

Expanded class hierarchy of PopoverAnimation

Related topics

Namespace

Drupal\bootstrap\Plugin\Setting\JavaScript\Popovers
Source
class PopoverAnimation extends SettingBase {

  /**
   * {@inheritdoc}
   */
  public function alterFormElement(Element $form, FormStateInterface $form_state, $form_id = NULL) {
    parent::alterFormElement($form, $form_state, $form_id);

    $group = $this->getGroupElement($form, $form_state);
    $group->setProperty('description', t('These are global options. Each popover can independently override desired settings by appending the option name to <code>data-</code>. Example: <code>data-animation="false"</code>.'));
    $group->setProperty('states', [
      'visible' => [
        ':input[name="popover_enabled"]' => ['checked' => TRUE],
      ],
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function drupalSettings() {
    return !!$this->theme->getSetting('popover_enabled');
  }

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
PluginBase::$theme protected property The currently set theme object.
PluginBase::__construct public function
PopoverAnimation::alterFormElement public function The alter method to store the code. Overrides SettingBase::alterFormElement
PopoverAnimation::drupalSettings public function Determines whether a theme setting should added to drupalSettings. Overrides SettingBase::drupalSettings
SettingBase::alterForm public function The alter method to store the code. Overrides FormInterface::alterForm
SettingBase::getCacheTags public function The cache tags associated with this object. Overrides SettingInterface::getCacheTags
SettingBase::getDefaultValue public function Retrieves the setting's default value. Overrides SettingInterface::getDefaultValue
SettingBase::getElement Deprecated public function Overrides SettingInterface::getElement
SettingBase::getElementProperties public function Retrieves all the form properties from the setting definition.
SettingBase::getGroup Deprecated public function Overrides SettingInterface::getGroup
SettingBase::getGroupElement public function Retrieves the group form element the setting belongs to. Overrides SettingInterface::getGroupElement
SettingBase::getGroups public function Retrieves the setting's groups. Overrides SettingInterface::getGroups
SettingBase::getOptions public function Retrieves the settings options, if set. Overrides SettingInterface::getOptions
SettingBase::getSettingElement public function Retrieves the form element for the setting. Overrides SettingInterface::getSettingElement
SettingBase::getTitle public function Retrieves the setting's human-readable title. Overrides SettingInterface::getTitle
SettingBase::submitForm public static function Form submission handler. Overrides FormInterface::submitForm
SettingBase::submitFormElement public static function Form submission handler. Overrides FormInterface::submitFormElement
SettingBase::validateForm public static function Form validation handler. Overrides FormInterface::validateForm
SettingBase::validateFormElement public static function Form validation handler. Overrides FormInterface::validateFormElement