You are here

class ParagraphsActions in Paragraphs 8

Provides a render element for a paragraphs actions.

Paragraphs actions can have two type of actions

  • actions - this are default actions that are always visible.
  • dropdown_actions - actions that are in dropdown sub component.

Usage example:

$form['actions'] = [
  '#type' => 'paragraphs_actions',
  'actions' => $actions,
  'dropdown_actions' => $dropdown_actions,
];
$dropdown_actions['button'] = array(
  '#type' => 'submit',
);

Plugin annotation

@FormElement("paragraphs_actions");

Hierarchy

Expanded class hierarchy of ParagraphsActions

1 #type use of ParagraphsActions
ParagraphsWidget::formElement in src/Plugin/Field/FieldWidget/ParagraphsWidget.php
Uses a similar approach to populate a new translation.

File

src/Element/ParagraphsActions.php, line 30

Namespace

Drupal\paragraphs\Element
View source
class ParagraphsActions extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#pre_render' => [
        [
          $class,
          'preRenderParagraphsActions',
        ],
      ],
      '#theme' => 'paragraphs_actions',
    ];
  }

  /**
   * Pre render callback for #type 'paragraphs_actions'.
   *
   * @param array $element
   *   Element arrar of a #type 'paragraphs_actions'.
   *
   * @return array
   *   The processed element.
   */
  public static function preRenderParagraphsActions(array $element) {
    $element['#attached']['library'][] = 'paragraphs/drupal.paragraphs.actions';
    if (!empty($element['dropdown_actions'])) {
      foreach (Element::children($element['dropdown_actions']) as $key) {
        $dropdown_action =& $element['dropdown_actions'][$key];
        if (isset($dropdown_action['#ajax'])) {
          $dropdown_action = RenderElement::preRenderAjaxForm($dropdown_action);
        }
        if (empty($dropdown_action['#attributes'])) {
          $dropdown_action['#attributes'] = [
            'class' => [
              'paragraphs-dropdown-action',
            ],
          ];
        }
        else {
          $dropdown_action['#attributes']['class'][] = 'paragraphs-dropdown-action';
        }
      }
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
ParagraphsActions::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
ParagraphsActions::preRenderParagraphsActions public static function Pre render callback for #type 'paragraphs_actions'.
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
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
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.