This bundle provides a breacrumb trail service also known as breadcrumbs or Fil d'Ariane.
Breadcrumbs can be defined with annotations or/and PHP.
Compatibility: The bundle is compatible with Symfony 2.0 upwards.
Please follow the steps given here to install this bundle.
Add breadcumbs to the trail with annotations in your controller.
You can add annotations on the controller and the action.
...
use APY\BreadcrumbTrailBundle\Annotation\Breadcrumb;
/**
* @Breadcrumb("Level 1", route="level_1")
* @Breadcrumb("Level 2", route="level_2")
*/
class MyController extends Controller
{
/**
* @Breadcrumb("Level 3a", route="level_3a")
* @Breadcrumb("Level 4a", route="level_4a")
*/
public function aAction()
{
/*
This action will show the following breacrumb trail:
Level 1 > Level 2 > Level 3a > Level 4a
*/
}
/**
* With route parameters
* @Breadcrumb("Level 3b")
* @Breadcrumb("Level 4b", route={"name"="level_4b", "parameters"={"var1"=1,"var2"=2}})
*/
public function bAction()
{
/*
This action will show the following breacrumb trail:
Level 1 > Level 2 > Level 3b > Level 4b
*/
}
/**
* With position (position=0 will put the breacrumb to the end of the trail)
* @Breadcrumb("Level 3c", route="level_3c")
* @Breadcrumb("Level 4c", position=2)
*/
public function cAction()
{
/*
This action will show the following breacrumb trail:
Level 1 > Level 4c > Level 2 > Level 3c
*/
}
/**
* With negative position
* @Breadcrumb("Level 3d", route="level_3d")
* @Breadcrumb("Level 4d", position=-1)
*/
public function dAction()
{
/*
This action will show the following breacrumb trail:
Level 1 > Level 2 > Level 4d > Level 3d
*/
}
/**
* Reset the trail
* @Breadcrumb("Level 3d", route="level_3d")
* @Breadcrumb()
* @Breadcrumb("Level 1e", route="level_1e")
* @Breadcrumb("Level 2e", route="level_2e")
*/
public function dAction()
{
/*
This action will show the following breacrumb trail:
Level 1e > Level 2e
*/
}
/**
* Add extra attributes for the breadcrumb
* @Breadcrumb("Level 2e", route="level_2e", attributes={"class" : "yellow", "title" : "Hello world !"})
*/
public function dAction()
{
/*
This action will show the following breacrumb trail:
Level 1e > Level 2e
Level 2e will have additional attributes in the template
*/
}
}
Add breadcumbs to the trail with PHP in your controller.
...
use APY\BreadcrumbTrailBundle\Annotation\Breadcrumb;
/**
* @Breadcrumb("Level 1", route="level_1")
* @Breadcrumb("Level 2")
*/
class MyController extends Controller
{
/**
* @Breadcrumb("Level 3a", route="level_3a")
*/
public function aAction()
{
$this->get("apy_breadcrumb_trail")->add('Level 4a', 'level_4a');
/*
This action will show the following breacrumb trail:
Level 1 > Level 2 > Level 3a > Level 4a
*/
}
/**
* With route parameters
* @Breadcrumb("Level 3b")
*/
public function bAction()
{
$this->get("apy_breadcrumb_trail")->add('Level 4b', 'level_4b', array("var1" => 1,"var2" => 2));
/*
This action will show the following breacrumb trail:
Level 1 > Level 2 > Level 3b > Level 4b
*/
}
/**
* With position (position=0 will put the breacrumb to the end of the trail)
* @Breadcrumb("Level 3c", route="level_3c")
*/
public function cAction()
{
$this->get("apy_breadcrumb_trail")->add('Level 4c', 'level_4c', array(), false, 2);
// The fourth argument is the absolute option of a route
/*
This action will show the following breacrumb trail:
Level 1 > Level 4c > Level 2 > Level 3c
*/
}
/**
* With negative position
* @Breadcrumb("Level 3d", route="level_3d")
*/
public function dAction()
{
$this->get("apy_breadcrumb_trail")->add('Level 4d', 'level_4d', array(), false, -1);
// The fourth argument is the absolute option of a route
/*
This action will show the following breacrumb trail:
Level 1 > Level 2 > Level 4d > Level 3d
*/
}
/**
* Reset the trail
* @Breadcrumb("Level 3d", route="level_3d")
*/
public function dAction()
{
$this->get("apy_breadcrumb_trail")
->reset()
->add('Level 1e', 'level_1e')
->add('Level 2e', 'level_2e')
/*
This action will show the following breacrumb trail:
Level 1e > Level 2e
*/
}
}
{{ apy_breadcrumb_trail_render() }}
The action a will render the following breadcrumb trail:
<ul id="breadcrumbtrail">
<li class="home">Home</li>
<li><a href="/level_1">Level 1</a></li>
<li>Level 2b</li>
<li><a href="/level_3a">Level 3a</a></li>
<li class="current"><a href="/level_4a">Level 4a</a></li>
</ul>
Notes:
- No link is displayed if no route is defined for the breadcrumb or if it's the last breadcrumb of the trail.
- The first breadcrumb will have the
homeclass and the last breadcrumb will have thecurrentclass.
You can override the default template in many ways.
- You can put your new template in the app folder:
app/Resources/APYBreadcrumbTrailBundle/views/breadcrumbtrail.html.twig
- You can define the template in your config.yml file:
apy_breadcrumb_trail:
template: APYBreadcrumbTrailBundle::breadcrumbtrail.html.twig
- You can define the template in a breadcrumb annotation:
@Breadcrumb("My breadcrumb", route="my_route")
@Breadcrumb(template="APYBreadcrumbTrailBundle::breadcrumbtrail.html.twig")
OR
@Breadcrumb("My breadcrumb", route="my_route", template="APYBreadcrumbTrailBundle::breadcrumbtrail.html.twig")
- You can define the template in PHP:
$this->get("apy_breadcrumb_trail")->setTemplate('APYBreadcrumbTrailBundle::breadcrumbtrail.html.twig');
- You can define the template when you render the breadcrumb trail in your twig file:
{{ apy_breadcrumb_trail_render('APYBreadcrumbTrailBundle::breadcrumbtrail.html.twig') }}
These expressions generate the same breadcrumb.
@Breadcrumb("Level 4b", route={"name"="level_4b", "parameters"={"var1"=1,"var2"=2}, "absolute"=true})
@Breadcrumb("Level 4b", routeName="level_4b", routeParameters={"var1"=1,"var2"=2}, routeAbsolute=true)
And these too.
@Breadcrumb("Level 4b", route="level_4b")
@Breadcrumb("Level 4b", route={"name"="level_4b"})
@Breadcrumb("Level 4b", routeName="level_4b")
- Issue #2
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent