Layout Paragraphs Restrictions

This provides a means of restricting Paragraph types that can be placed within Layout Paragraph instances by matching context variables. Restrictions may be placed on entire layouts or on regions within layouts. For example, you may wish to restrict the placement of a 'Hero' Paragraph type only to be allowed within a one-column layout or a full-page-width region within a two-column layout.

Part of the Mercury Editor™ ecosystem

Layout Paragraphs Restrictions supplements Layout Paragraphs, a key component of the Mercury Editor ecosystem. Mercury Editor empowers content editors to create custom layouts in seconds with an easy-to-use Drupal page builder.

Configuration

Visit /admin/config/content/layout-paragraphs/restrictions and enter the restriction definitions as yml. Restriction definitions are defined as named combinations of contexts and a list of components that should be allowed or prohibited in that context.

See example.layout_paragraphs_restrictions.yml for the correct syntax.

Contexts

Contexts are defined as a list of context variables that must be matched in order for the restriction to apply. Valid values include the following:

• parent_uuid: the UUID of the parent component
• parent_type: the bundle of the parent component
• sibling_uuid: the UUID of the sibling component
• sibling_type: the bundle of the sibling component
• region: the region name (_root if no region is set)
• layout: the layout plugin ID
• field_name: the Layout Paragraphs field name
• entity_type: the entity type the Paragraphs field is attached to
• entity_bundle: the entity bundle name
• placement: the placement of the component (before or after)

Components

Components are defined as a list of component machine names. Components are the Paragraph types that are allowed or prohibited in the context.

Examples

Restricting an entire layout component

my_restriction_rule:  # The name of the restriction rule.
  context:
    parent_type: section  # The parent Layout Paragraph type. In this case, a "section".
  components:  # The list of components that are allowed in the context.
    - rich_text
    - image
    - call_to_action

In this example, the parent_type context is set to a Layout Paragraph called section. The components rich_text, image, and call_to_action are allowed to be placed within a section Layout Paragraph.

Restricting specific regions within layouts

full_width_onecol:
  context:
    layout: onecol  # The machine name of the layout.
    region: content  # The machine name of the region within the layout.
  components:
    - hero
full_width_twocol:
  context:
    layout: twocol
    region: top
  components:
    - hero

In this example, a hero component is allowed to be placed within the content region of a one-column layout and the top region of a two-column layout.

Restricting by field name, entity type or bundle

Restrictions can be placed on specific fields, entity types or bundles. These restrictions may be used individually or in conjunction with others. In this example, the context is set to the field_paragraphs field only on nodes of type blog.

restrict_blog:
  context:
    entity_type: node
    entity_bundle: blog
    field_name: field_paragraphs

To restrict only the top level of a field, use the region _root:

restrict_field_top_level_only:
  context:
    field_name: field_paragraphs
    region: _root

Setting multiple contexts on a single rule

Rules may be applied to multiple contexts by passing them as an array:

last_column:
  context:
    -
      layout: twocol
      region: second
    -
      layout: threecol
      region: third

Setting maximum item limits in a rule

maximum_items_example:
  context:
    layout: layout_twocol
    region: first
  max_items:
    #Allows three items of any type in the first column of a two column layout.
    _total: 3
    #Allows one item of type 'heading' in the first column of a two column layout.
    heading: 1

Restricting Mercury Editor templates

If using the Mercury Editor module, templates may be placed in inclusion/exclusion lists by appending their ID to me_template_. Note that Layout Paragraphs Restrictions will not evaluate the Paragraph types within a template for inclusion/exclusion, so it may be possible to place forbidden types into a context via a Mercury Editor template.

components:
  - me_template_3
  - me_template_6

Excluding components instead of including

no_accordion:
  context:
    parent_type: section
  exclude_components:
    - accordion

In this example, the accordion component is not allowed to be placed within a section Layout Paragraph, but all other components are allowed.

Dependencies

• Layout Paragraphs