Issue #3471956 by joshua1234511, richardgaunt, fionamorrison23: Enhanced Civictheme menu theming system (#1350)

Co-authored-by: Joshua Fernandes <“[email protected]”>
Co-authored-by: rgaunt <[email protected]>

Author: 3 people

web/themes/contrib/civictheme/civictheme.post_update.php

@@ -865,6 +865,27 @@ function civictheme_post_update_update_editor_allowed_field(): string {
   return (string) new TranslatableMarkup('Allowed tags setting not set, aborting update.');
 }
 
+/**
+ * Update civictheme_side_navigation to use civictheme_sidebar_navigation.
+ *
+ * @SuppressWarnings(PHPMD.StaticAccess)
+ */
+function civictheme_post_update_update_sidebar_navigation_suggestion(): string {
+  $config_factory = \Drupal::configFactory();
+  $editable = $config_factory->getEditable('block.block.civictheme_side_navigation');
+  if ($editable->isNew()) {
+    return 'Sidebar navigation block config does not exist.';
+  }
+  $settings = $editable->get('settings') ?? [];
+  if (empty($settings['suggestion']) || $settings['suggestion'] !== 'civictheme_sidebar_navigation') {
+    $settings['suggestion'] = 'civictheme_sidebar_navigation';
+    $editable->set('settings', $settings);
+    $editable->save();
+    return 'Updated civictheme_side_navigation block to use civictheme_sidebar_navigation suggestion.';
+  }
+  return 'No update needed for civictheme_side_navigation block.';
+}
+
 /**
  * Add civictheme_message paragraph type and enable it for civictheme page.
  *

web/themes/contrib/civictheme/civictheme.theme

@@ -45,6 +45,7 @@ require_once __DIR__ . '/includes/primary_navigation.inc';
 require_once __DIR__ . '/includes/promo.inc';
 require_once __DIR__ . '/includes/search.inc';
 require_once __DIR__ . '/includes/secondary_navigation.inc';
+require_once __DIR__ . '/includes/sidebar_navigation.inc';
 require_once __DIR__ . '/includes/system_main_block.inc';
 require_once __DIR__ . '/includes/site_section.inc';
 require_once __DIR__ . '/includes/skip_link.inc';
@@ -214,7 +215,6 @@ function civictheme_preprocess_block(array &$variables): void {
   _civictheme_preprocess_block__system_main_block($variables);
   _civictheme_preprocess_block__civictheme_banner($variables);
   _civictheme_preprocess_block__navigation($variables);
-  _civictheme_preprocess_block__civictheme_footer_menu($variables);
   _civictheme_preprocess_block__content($variables);
   _civictheme_preprocess_block__civictheme_mobile_navigation($variables);
   _civictheme_preprocess_block__civictheme_social_links($variables);

web/themes/contrib/civictheme/config/optional/block.block.civictheme_side_navigation.yml

@@ -27,7 +27,7 @@ settings:
   depth: 3
   expand_all_items: false
   parent: 'civictheme-primary-navigation:'
-  suggestion: civictheme_primary_navigation
+  suggestion: civictheme_sidebar_navigation
 visibility:
   request_path:
     id: request_path

web/themes/contrib/civictheme/includes/menu.inc

@@ -10,25 +10,6 @@ declare(strict_types=1);
 use Drupal\civictheme\CivicthemeConstants;
 use Drupal\Core\Url;
 
-/**
- * Preprocess for footer menu block.
- */
-function _civictheme_preprocess_block__civictheme_footer_menu(array &$variables): void {
-  if (isset($variables['elements']['#base_plugin_id']) && $variables['base_plugin_id'] != 'menu_block') {
-    return;
-  }
-
-  $menu_name = strtr($variables['elements']['#derivative_plugin_id'], '-', '_');
-  if ($menu_name === 'civictheme_footer') {
-    // Set menu theme as per footer theme.
-    $variables['theme'] = civictheme_get_theme_config_manager()->load('components.footer.theme', CivicthemeConstants::FOOTER_THEME_DEFAULT);
-    $variables['items'] = $variables['content']['#items'] ?? [];
-    $variables['title'] = $variables['configuration']['label_display'] ? $variables['configuration']['label'] : '';
-
-    _civictheme_preprocess_menu_items($variables['items']);
-  }
-}
-
 /**
  * Add required element for external link.
  *
@@ -54,6 +35,8 @@ function _civictheme_preprocess_menu_items(array &$items, bool $expand_all = FAL
 
 /**
  * Preprocess for primary navigation menu block.
+ *
+ * @SuppressWarnings(PHPMD.CyclomaticComplexity)
  */
 function _civictheme_preprocess_block__navigation(array &$variables): void {
   if (isset($variables['elements']['#base_plugin_id']) && $variables['base_plugin_id'] != 'menu_block') {
@@ -62,6 +45,17 @@ function _civictheme_preprocess_block__navigation(array &$variables): void {
 
   $menu_name = strtr($variables['elements']['#derivative_plugin_id'], '-', '_');
 
+  $menu_theme_list = [
+    'civictheme_primary_navigation',
+    'civictheme_secondary_navigation',
+    'civictheme_sidebar_navigation',
+    'civictheme_footer',
+  ];
+
+  if (!empty($variables['elements']['#configuration']['suggestion']) && in_array($variables['elements']['#configuration']['suggestion'], $menu_theme_list)) {
+    $menu_name = $variables['elements']['#configuration']['suggestion'];
+  }
+
   if ($menu_name === 'civictheme_primary_navigation' || $menu_name === 'civictheme_secondary_navigation') {
     $key = substr($menu_name, strlen('civictheme_'));
     // Set menu theme as per footer theme.
@@ -77,4 +71,13 @@ function _civictheme_preprocess_block__navigation(array &$variables): void {
     $expand_all_items = $variables['elements']['#configuration']['expand_all_items'] ?? FALSE;
     _civictheme_preprocess_menu_items($variables['items'], $expand_all_items);
   }
+
+  if ($menu_name === 'civictheme_footer') {
+    // Set menu theme as per footer theme.
+    $variables['theme'] = civictheme_get_theme_config_manager()->load('components.footer.theme', CivicthemeConstants::FOOTER_THEME_DEFAULT);
+    $variables['items'] = $variables['content']['#items'] ?? [];
+    $variables['title'] = $variables['configuration']['label_display'] ? $variables['configuration']['label'] : '';
+
+    _civictheme_preprocess_menu_items($variables['items']);
+  }
 }

web/themes/contrib/civictheme/includes/primary_navigation.inc

@@ -7,34 +7,17 @@
 
 declare(strict_types=1);
 
-use Drupal\block\Entity\Block;
 use Drupal\civictheme\CivicthemeConstants;
 
 /**
- * Implements template_preprocess_block__HOOK().
+ * Implements template_preprocess_block__HOOK() for header primary navigation.
  *
  * @SuppressWarnings(PHPMD.StaticAccess)
  */
 function civictheme_preprocess_block__menu_block__civictheme_primary_navigation(array &$variables): void {
   $variables['theme'] = civictheme_get_theme_config_manager()->load('components.header.theme', CivicthemeConstants::HEADER_THEME_DEFAULT);
   $variables['items'] = $variables['content']['#items'] ?? [];
   $variables['title'] = $variables['configuration']['label_display'] ? $variables['configuration']['label'] : '';
-
-  if (!empty($variables['elements']['#id'])) {
-    $block = Block::load($variables['elements']['#id']);
-    if ($block) {
-      $region = $block->getRegion();
-
-      if (str_starts_with($region, 'header')) {
-        civictheme_add_modifier_class($variables, 'ct-flex-justify-content-end');
-      }
-
-      if (str_starts_with($region, 'sidebar')) {
-        $variables['in_sidebar'] = TRUE;
-        $expand_all_items = $variables['configuration']['expand_all_items'] ?? FALSE;
-      }
-    }
-  }
-
-  _civictheme_preprocess_menu_items($variables['items'], $expand_all_items ?? FALSE);
+  civictheme_add_modifier_class($variables, 'ct-flex-justify-content-end');
+  _civictheme_preprocess_menu_items($variables['items'], FALSE);
 }

web/themes/contrib/civictheme/includes/secondary_navigation.inc

@@ -7,34 +7,17 @@
 
 declare(strict_types=1);
 
-use Drupal\block\Entity\Block;
 use Drupal\civictheme\CivicthemeConstants;
 
 /**
- * Implements template_preprocess_block__HOOK().
+ * Implements template_preprocess_block__HOOK() for header secondary navigation.
  *
  * @SuppressWarnings(PHPMD.StaticAccess)
  */
 function civictheme_preprocess_block__menu_block__civictheme_secondary_navigation(array &$variables): void {
   $variables['theme'] = civictheme_get_theme_config_manager()->load('components.header.theme', CivicthemeConstants::HEADER_THEME_DEFAULT);
   $variables['items'] = $variables['content']['#items'] ?? [];
   $variables['title'] = $variables['configuration']['label_display'] ? $variables['configuration']['label'] : '';
-
-  if (!empty($variables['elements']['#id'])) {
-    $block = Block::load($variables['elements']['#id']);
-    if ($block) {
-      $region = $block->getRegion();
-
-      if (str_starts_with($region, 'header')) {
-        civictheme_add_modifier_class($variables, 'ct-flex-justify-content-end');
-      }
-
-      if (str_starts_with($region, 'sidebar')) {
-        $variables['in_sidebar'] = TRUE;
-        $expand_all_items = $variables['configuration']['expand_all_items'] ?? FALSE;
-      }
-    }
-  }
-
-  _civictheme_preprocess_menu_items($variables['items'], $expand_all_items ?? FALSE);
+  civictheme_add_modifier_class($variables, 'ct-flex-justify-content-end');
+  _civictheme_preprocess_menu_items($variables['items'], FALSE);
 }

web/themes/contrib/civictheme/includes/sidebar_navigation.inc

@@ -0,0 +1,24 @@
+<?php
+
+/**
+ * @file
+ * Sidebar navigation block theme alterations.
+ */
+
+declare(strict_types=1);
+
+use Drupal\civictheme\CivicthemeConstants;
+
+/**
+ * Implements template_preprocess_block__HOOK() for sidebar navigation.
+ *
+ * @SuppressWarnings(PHPMD.StaticAccess)
+ */
+function civictheme_preprocess_block__menu_block__civictheme_sidebar_navigation(array &$variables): void {
+  $variables['theme'] = civictheme_get_theme_config_manager()->load('components.header.theme', CivicthemeConstants::HEADER_THEME_DEFAULT);
+  $variables['items'] = $variables['content']['#items'] ?? [];
+  $variables['title'] = $variables['configuration']['label_display'] ? $variables['configuration']['label'] : '';
+  $variables['in_sidebar'] = TRUE;
+  $expand_all_items = $variables['configuration']['expand_all_items'] ?? FALSE;
+  _civictheme_preprocess_menu_items($variables['items'], $expand_all_items);
+}

web/themes/contrib/civictheme/templates/block/block--menu-block--civictheme-primary-navigation.html.twig

@@ -2,28 +2,16 @@
 /**
  * @file
  * CivicTheme implementation to display a Primary Navigation menu block.
- *
- * Note that when primary navigation menu is shown as a side navigation
- * component, the theme is hardcoded to the theme of the page (light) rather
- * than the theme of the primary navigation.
  */
 #}
-{% if in_sidebar %}
-  {% include 'civictheme:side-navigation' with {
-    theme: 'light',
-    items,
-    modifier_class: 'ct-primary-navigation ' ~ modifier_class|default(''),
-  } only %}
-{% else %}
-  {% include 'civictheme:navigation' with {
-    theme,
-    items,
-    type: dropdown == 'none' ? 'inline' : dropdown,
-    dropdown_columns,
-    dropdown_columns_fill,
-    is_animated,
-    menu_id,
-    variant,
-    modifier_class: 'ct-primary-navigation ' ~ modifier_class|default(''),
-  } only %}
-{% endif %}
+{% include 'civictheme:navigation' with {
+  theme,
+  items,
+  type: dropdown == 'none' ? 'inline' : dropdown,
+  dropdown_columns,
+  dropdown_columns_fill,
+  is_animated,
+  menu_id,
+  variant,
+  modifier_class: 'ct-primary-navigation ' ~ modifier_class|default(''),
+} only %}

web/themes/contrib/civictheme/templates/block/block--menu-block--civictheme-secondary-navigation.html.twig

@@ -4,22 +4,14 @@
  * CivicTheme implementation to display a Secondary Navigation menu block.
  */
 #}
-{% if in_sidebar %}
-  {% include 'civictheme:side-navigation' with {
-    theme,
-    items,
-    modifier_class: 'ct-secondary-navigation ' ~ modifier_class|default(''),
-  } only %}
-{% else %}
-  {% include 'civictheme:navigation' with {
-    theme,
-    items,
-    type: dropdown == 'none' ? 'inline' : dropdown,
-    dropdown_columns,
-    dropdown_columns_fill,
-    is_animated,
-    menu_id,
-    variant,
-    modifier_class: 'ct-secondary-navigation ' ~ modifier_class|default(''),
-  } only %}
-{% endif %}
+{% include 'civictheme:navigation' with {
+  theme,
+  items,
+  type: dropdown == 'none' ? 'inline' : dropdown,
+  dropdown_columns,
+  dropdown_columns_fill,
+  is_animated,
+  menu_id,
+  variant,
+  modifier_class: 'ct-secondary-navigation ' ~ modifier_class|default(''),
+} only %}

web/themes/contrib/civictheme/templates/block/block--menu-block--civictheme-sidebar-navigation.html.twig

@@ -0,0 +1,11 @@
+{#
+/**
+ * @file
+ * CivicTheme implementation to display a Sidebar Navigation menu block.
+ */
+#}
+{% include 'civictheme:side-navigation' with {
+  theme,
+  items,
+  modifier_class: 'ct-sidebar-navigation ' ~ modifier_class|default(''),
+} only %}