Add showActive parameter

ProfessionalWiki · Nov 17, 2023 · 4053f47 · 4053f47
1 parent 5a30a22
commit 4053f47
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 17 deletions.
diff --git a/docs/components.md b/docs/components.md
@@ -94,7 +94,7 @@ recommended.
 
   Use `fixedwidth` for a responsive fixed width layout. Use `fluid` for a full
   width layout, spanning the entire width of the viewport.
-  
+
   Use a breakpoint name for a responsive container (since Chameleon 4.1.0).
 
 * `id`:
@@ -265,7 +265,7 @@ assign a CSS id or class for styling purposes.
 -------------------------------------------------------------------------------
 ### Component `ContentBody`
 
-Allows to display the content body independently of the [MainContent](#component-maincontent). 
+Allows to display the content body independently of the [MainContent](#component-maincontent).
 
 Since Chameleon 4.2.0
 
@@ -783,6 +783,13 @@ Using the message _MediaWiki:Secondary-menu_:
   both attributes in the same `NavMenu` instance, but it can make sense to use
   them separately in complementary instances.
 
+* `showActive`:
+  * Allowed values: Boolean (`yes`|`no`)
+  * Default: `no`
+  * Optional.
+
+  If set a menu link will be highlighted if it is the current page.
+
 #### Allowed Parent Elements:
 * [Structure](#structure)
 * [Cell](#cell)

diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -1,10 +1,11 @@
 ## Release Notes
 
-### Chameleon 4.2.2
+### Chameleon 4.3.0
 
 Under development.
 
 * Fixed deprecated Hooks usage for MediaWiki 1.40 (thanks @malberts)
+* Added `showActive` parameter for highlighting the current page in the `NavMenu` component (thanks @malberts)
 
 ### Chameleon 4.2.1
 

diff --git a/layouts/clean.xml b/layouts/clean.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!--
-<?xml-model href="https://ProfessionalWiki.github.io/chameleon/schema/3.4/layout.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
+<?xml-model href="https://ProfessionalWiki.github.io/chameleon/schema/3.6/layout.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
 This file is part of the MediaWiki skin Chameleon.
 
 @copyright 2013 - 2021, Stephan Gambke
@@ -23,7 +23,7 @@ with this program. If not, see <http://www.gnu.org/licenses/>.
 @since 1.1
 @ingroup Skins
 -->
-<structure xmlns="https://ProfessionalWiki.github.io/chameleon/schema/3.5/layout.rng">
+<structure xmlns="https://ProfessionalWiki.github.io/chameleon/schema/3.6/layout.rng">
 
 	<component type="NavbarHorizontal" >
 		<modification type="ShowOnlyFor" permission="edit"/>

diff --git a/layouts/fixedhead.xml b/layouts/fixedhead.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!--
-<?xml-model href="https://ProfessionalWiki.github.io/chameleon/schema/3.4/layout.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
+<?xml-model href="https://ProfessionalWiki.github.io/chameleon/schema/3.6/layout.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
 This file is part of the MediaWiki skin Chameleon.
 
 @copyright 2013 - 2021, Stephan Gambke
@@ -23,7 +23,7 @@ with this program. If not, see <http://www.gnu.org/licenses/>.
 @since 1.0
 @ingroup Skins
 -->
-<structure xmlns="https://ProfessionalWiki.github.io/chameleon/schema/3.5/layout.rng">
+<structure xmlns="https://ProfessionalWiki.github.io/chameleon/schema/3.6/layout.rng">
 
 	<component type="NavbarHorizontal">
 		<modification type="Sticky"/>

diff --git a/layouts/layout.rng b/layouts/layout.rng
@@ -25,13 +25,13 @@ with this program. If not, see <http://www.gnu.org/licenses/>.
 <grammar
 		xmlns="http://relaxng.org/ns/structure/1.0"
 		xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0"
-		ns="https://ProfessionalWiki.github.io/chameleon/schema/3.5/layout.rng"
+		ns="https://ProfessionalWiki.github.io/chameleon/schema/3.6/layout.rng"
 		datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes"
 >
 
 	<a:documentation>
 		Schema for Chameleon layout files
-		Version 3.5
+		Version 3.6
 		Copyright 2013 - 2021, Stephan Gambke
 		GNU General Public License, version 3 (or any later version)
 	</a:documentation>
@@ -325,6 +325,13 @@ with this program. If not, see <http://www.gnu.org/licenses/>.
 				<data type="string"/>
 			</attribute>
 		</optional>
+
+		<optional>
+			<attribute name="showActive" a:defaultValue="no">
+				<ref name="BoolValues"/>
+			</attribute>
+		</optional>
+
 	</define>
 
 	<define name="Component" combine="choice">

diff --git a/layouts/navhead.xml b/layouts/navhead.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!--
-<?xml-model href="https://ProfessionalWiki.github.io/chameleon/schema/3.4/layout.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
+<?xml-model href="https://ProfessionalWiki.github.io/chameleon/schema/3.6/layout.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
 This file is part of the MediaWiki skin Chameleon.
 
 @copyright 2013 - 2021, Stephan Gambke
@@ -23,7 +23,7 @@ with this program. If not, see <http://www.gnu.org/licenses/>.
 @since 1.0
 @ingroup Skins
 -->
-<structure xmlns="https://ProfessionalWiki.github.io/chameleon/schema/3.5/layout.rng">
+<structure xmlns="https://ProfessionalWiki.github.io/chameleon/schema/3.6/layout.rng">
 	<component type="NavbarHorizontal">
 		<component type="Logo" position="head"/>
 		<component type="NavMenu" flatten="navigation" />

diff --git a/layouts/standard.xml b/layouts/standard.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!--
-<?xml-model href="https://ProfessionalWiki.github.io/chameleon/schema/3.4/layout.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
+<?xml-model href="https://ProfessionalWiki.github.io/chameleon/schema/3.6/layout.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
 This file is part of the MediaWiki skin Chameleon.
 
 @copyright 2013 - 2021, Stephan Gambke
@@ -23,7 +23,7 @@ with this program. If not, see <http://www.gnu.org/licenses/>.
 @since 1.0
 @ingroup Skins
 -->
-<structure xmlns="https://ProfessionalWiki.github.io/chameleon/schema/3.5/layout.rng">
+<structure xmlns="https://ProfessionalWiki.github.io/chameleon/schema/3.6/layout.rng">
 	<grid class="flex-fill">
 		<row>
 			<cell class="flex-grow-0">

diff --git a/layouts/stickyhead.xml b/layouts/stickyhead.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!--
-<?xml-model href="https://ProfessionalWiki.github.io/chameleon/schema/3.4/layout.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
+<?xml-model href="https://ProfessionalWiki.github.io/chameleon/schema/3.6/layout.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
 This file is part of the MediaWiki skin Chameleon.
 
 @copyright 2013 - 2021, Stephan Gambke
@@ -23,7 +23,7 @@ with this program. If not, see <http://www.gnu.org/licenses/>.
 @since 1.0
 @ingroup Skins
 -->
-<structure xmlns="https://ProfessionalWiki.github.io/chameleon/schema/3.5/layout.rng">
+<structure xmlns="https://ProfessionalWiki.github.io/chameleon/schema/3.6/layout.rng">
 
 	<component type="NavbarHorizontal" class="small bg-darker">
 		<component type="Menu" message="secondary-menu"/>

diff --git a/src/Components/NavMenu.php b/src/Components/NavMenu.php
@@ -143,8 +143,11 @@ protected function buildMenuItemsForDropdownMenu( $menuDescription, $indent = 0
 
 			foreach ( $menuDescription['content'] as $key => $item ) {
 				$id = $item['id'] ?? '';
-				$menuitems .= $this->indent() . $this->getSkinTemplate()->makeListItem( $key, $item,
-					[ 'tag' => 'div', 'class' => 'nav-item', 'link-class' => 'nav-link '. $id ] );
+				$menuitems .= $this->indent() . $this->getSkinTemplate()->makeListItem( $key, $item, [
+					'tag' => 'div',
+					'class' => 'nav-item',
+					'link-class' => 'nav-link '. $id . ( $this->isHrefActive( $item['href'] ) ? ' active' : '' )
+				] );
 			}
 
 			$this->indent( - $indent );
@@ -255,4 +258,9 @@ public function getMenusToBeFlattened() {
 		return $flatten;
 	}
 
+	private function isHrefActive( string $href ): bool {
+		return filter_var( $this->getDomElement()->getAttribute( 'showActive' ), FILTER_VALIDATE_BOOLEAN )
+			&& $href === $this->getSkin()->getTitle()->getLocalURL();
+	}
+
 }