README

Create an HTML menu easily!

A Few Examples

Creating a New Menu

<?php

$factory = new Menu\Factory;

$menu = $factory->get('header');

$menu->add('Home', '/');
$menu->add('Blog', '/blog');

$menu->add('Menu', '/menu', function($menu)
{
	$menu->add('Item 1', '/menu/item-1');
	$menu->add('Item 2', '/menu/item-2');
});

echo $menu;

Adding Attributes to Menus

<?php

$menu->add('First Link', '/', function($item)
{
	$item->link->id = 'a-id';
	$item->link->class = 'a-class';

	$item->label->id = 'li-id';
	$item->label->class = 'li-class';
});

$menu->add('Second Link', function($item)
{
	$item->url = '/uri';

	$item->list->id = 'ul-id';
	$item->list->class = 'ul-class';

	$menu->add('Sub Link', '/sub/link');
});

Filtering Menu Items

Filters can be used to either remove an item from a menu, or to add more attributes to an item.

<?php

// Filter all the menus.
$factory->addFilter(function($item)
{
	// Remove any items that have the name 'Admin'
	if($item->name == 'Admin')
	{
		$item->remove();
	}
});

// Filter a specific menu.
$menu->addFilter(function($item)
{
	// Modify the li elements.
	$item->label->class = 'prettify';
});