A class for rendering navigation from an array of items and highlighting the active page.
This is intended to be backward-compatible with the original source JV-Software/SimpleNavigation.
In your composer.json file, require the library:
"require": {
"jvs/simplenavigation": "dev-master"
}
And run composer install or composer update if you already installed some
packages.
- Download the zip file
- Extract to your project folder
- Make sure to require the main class
require_once 'lib/JVS/SimpleNavigation.php';
SimpleNavigation provides a simple make function that expects an array with the menu items you want to render. It can be a simple array:
$simpleNav = new JVS\SimpleNavigation;
$navItems = array('Home', 'About Us', 'Blog');
echo $simpleNav->make($navItems);Which outputs:
<ul>
<li><a href="#">Home</a></li>
<li><a href="#">About Us</a></li>
<li><a href="#">Blog</a></li>
</ul>An array with key/value pairs representing the link's name and url:
$simpleNav = new JVS\SimpleNavigation;
$navItems = array(
'Home' => 'http://www.example.com/',
'About Us' => 'http://www.example.com/about.php',
'Blog' => 'http://www.example.com/blog.php',
);
echo $simpleNav->make($navItems);Which outputs:
<ul>
<li><a href="http://www.example.com/">Home</a></li>
<li><a href="http://www.example.com/about.php">About Us</a></li>
<li><a href="http://www.example.com/blog.php">Blog</a></li>
</ul>Or a fully nested multi-level array of navigation items:
$simpleNav = new JVS\SimpleNavigation;
$navItems = array(
'Home' => 'http://www.example.com/',
'About Us' => array(
'Our Company' => 'http://www.example.com/about/company.php',
'Our Team' => 'http://www.example.com/about/team.php',
),
'Blog' => 'http://www.example.com/blog.php',
);
echo $simpleNav->make($navItems);Which outputs:
<ul>
<li><a href="http://www.example.com/">Home</a></li>
<li>
<a href="http://www.example.com/about.php">About Us</a>
<ul>
<li><a href="http://www.example.com/about/company.php"></a></li>
<li><a href="http://www.example.com/about/team.php"></a></li>
</ul>
</li>
<li><a href="http://www.example.com/blog.php">Blog</a></li>
</ul>An optional URL argument to the make function allows it to find and decorate both the active link and the enclosing item with class="active":
$simpleNav = new JVS\SimpleNavigation;
$navItems = array(
'Home' => 'index.html',
'About' => array(
'Page 1' => 'page1.html',
'Page 2' => 'page2.html',
'Page 3' => 'page3.html',
),
'Contact' => 'contact.html',
);
echo $simpleNav->make($navItems, 'page2.html');Which outputs:
<ul>
<li><a href="index.html">Home</a></li>
<li>
<a class="active" href="#">About</a>
<ul>
<li><a href="page1.html">Page 1</a></li>
<li><a class="active" href="page2.html">Page 2</a></li>
<li><a href="page3.html">Page 3</a></li>
</ul>
</li>
<li><a href="blog.html">Blog</a></li>
</ul>You can pretty-print the html output with an optional argument for indentation. For example, set this to two spaces or four spaces or a \t tab character according to your own coding style. If the third argument is not specified, by default the html output is run together on a single line.
echo $simpleNav->make($navItems, 'page2.html', ' ');Bootstrap 4 is the world's most popular framework for building responsive websites. You can generate HTML containing Bootstrap tags with the derived class BootstrapNavigation.
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css"
integrity="sha384-KyZXEAg3QhqLMpG8r+8fhAXLRk2vvoC2f3B09zVXn8CA5QIVfZOJ3BCsw2P0p/We" crossorigin="anonymous">
</head>
<body>
<div class="container-md">
<nav class="navbar navbar-expand-md navbar-light"><!-- 35 -->
<?php require_once('php/sitenav.php'); writeNavbar(); ?>
</nav>
</div>
$bootstrapNav = new JVS\BootstrapNavigation;
</body>Which will result in:
Forked from https://github.com/JV-Software/SimpleNavigation
Feel free to submit bugs or pull requests, just make sure to include unit tests if relevant.