Nette component for creating menus, breadcrumbs and sitemaps.
- PHP >=7.1
- Nette ^2.4
Install package with composer:
$ composer require carrooi/nette-menu
Register as nette extension:
extensions:
menu: Carrooi\Menu\DI\MenuExtension
menu:
You can write menu links as associated multi dimensional arrays. Because of this you are able to create any structure of menus and submenus you may need.
menu:
front:
items:
Home:
action: :Front:Home:
Books:
link: '#'
items:
All:
action: :Front:Books:all
Featured:
action: :Front:Books:featured
admin:
items:
Users:
action: :Admin:Users:
Books:
action: :Admin:Books:
<?php
namespace App;
use Carrooi\Menu\UI\IMenuComponentFactory;
use Carrooi\Menu\UI\MenuComponent;
use Nette\Application\UI\Presenter;
final class BasePresenter extends Presenter
{
private $menuFactory;
public function injectBasePresenter(IMenuComponentFactory $menuFactory)
{
$this->menuFactory = $menuFactory;
}
protected function createComponentMenu(): MenuComponent
{
return $this->menuFactory->create('front');
}
}
{control menu} <!-- display menu -->
{control menu:breadcrumbs} <!-- display breadcrumbs -->
{control menu:sitemap} <!-- display sitemap -->
That structure in neon config will generate two menus:
front:
- Home (action:
:Front:Home:
) - Books (link:
#
)- All (action:
:Front:Books:all
) - Featured (action:
:Front:Books:featured
)
- All (action:
admin:
- Users (action:
:Admin:Users:
) - Books (action:
:Admin:Books:
)
This package includes 3 default templates (menu, breadcrumbs, sitemap). However only the default sitemap template should be used in real project. The other two templates should only help you in the beginning with building your own templates which will fit your's website look.
Changing templates can be done in your menu configuration:
menu:
front:
templates:
menu: %appDir%/path/to/custom/menu.latte
breadcrumbs: %appDir%/path/to/custom/breadcrumbs.latte
sitemap: %appDir%/path/to/custom/sitemap.latte
As you can see, each menu can have different templates.
It may be useful to hide some links in specific situations. For that we have the visibility
option on items where
you can tell on which template the link should be visible.
menu:
front:
items:
Home:
action: :Front:Home:
visibility:
menu: true
breadcrumbs: false
sitemap: true
When displaying title of link in some template, we always work with translated titles.
You have three options for translator:
- Do nothing: Original
ReturnTranslator
class will be used. This translator just returns the given text. - Set translator manually: Provide your own implementation of
Nette\Localization\ITranslator
. - Set translator to
true
: Menu extension will try to find your translator in DI container automatically.
services:
- App\MyOwnFrontTranslator
menu:
front:
translator: @App\MyOwnFrontTranslator
admin:
translator: true
Every link can contain additional data which can be later used eg. in your custom latte templates.
menu:
admin:
items:
Adminer:
link: http://localhost:20000
data:
icon: fa fa-database
attrs:
target: _blank
<a href="{$item->getRealLink()" n:attr="(expand) $link->getData('attrs')">
<i class="{$item->getData('icon')"></i> {$link->getRealTitle()}
</a>
Sometimes you may want to hide some links based on custom rules, that includes for example authorization from nette.
This menu package uses custom IAuthorizator
interface which you can use to write your own authorizators.
<?php
namespace App;
use Carrooi\Menu\IMenuItem;
use Carrooi\Menu\Security\IAuthorizator;
final class FrontAuthorizator implements IAuthorizator
{
public function isMenuItemAllowed(IMenuItem $item): bool
{
return isItemAllowed($item);
}
}
services:
- App\FrontAuthorizator
menu:
front:
authorizator: @App\FrontAuthorizator
When you want to display a link in your template it uses the ILinkGenerator
interface to generate it from the data
in your menu config. If you want to change the default logic (which uses link
method from nette) you can just implement
your custom link generator.
<?php
namespace App;
use Carrooi\Menu\IMenuItem;
use Carrooi\Menu\LinkGenerator\ILinkGenerator;
final class FrontLinkGenerator implements ILinkGenerator
{
public function link(IMenuItem $item): string
{
return generateLink($item);
}
}
services:
- App\FrontLinkGenerator
menu:
front:
linkGenerator: @App\FrontLinkGenerator
You can also override link generator later for some subtree of links:
menu:
front:
items:
Home:
action: :Front:Home:
Books:
link: '#'
linkGenerator: @App\BooksLinkGenerator
If you want to build your menu maybe from database instead of neon config, you can do that by creating IMenuLoader
class.
See the default ArrayMenuLoader how it works.
-
2.1.0
-
2.0.0
- Refactoring - complete rewrite
-
1.1.1
- Move under Carrooi organization
-
1.1.0
- Support for ACL permissions (thanks whipsterCZ)
- Support for generating sitemap (thanks whipsterCZ)
-
1.0.4
- Added
hasIcon
andhasCounter
methods - Support for "absolute" targets #6
- Added
-
1.0.3
- Added shortcut methods for working with item's data #5
-
1.0.2
- Support for "dynamic" modules in includes option #4
-
1.0.1
-
1.0.0
- First version