cihispano / breadcrumbs
Simple breadcrumb library for PHP 8.1 and above
v0.0.1
2022-09-26 18:18 UTC
Requires
- php: >=8.1
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.11
- phpstan/phpstan: ^1.8
- phpunit/php-code-coverage: ^9.2
- phpunit/phpunit: ^9.5
README
Table of Contents
About The Project
Simple breadcrumb library for PHP 8.1 and above.
Getting started
Prerequisites
- PHP 8.1 or above
Installation
Usage
The simplest way for the library is
- Create an object
- Add the paths
- Render.
$breadcrumbs = new Breadcrumbs(); $breadcrumbs->addBreadcrumb('Admin','https://localhost/admin'); $breadcrumbs->addBreadcrumb('Users','https://localhost/admin/users'); $breadcrumbs->addBreadcrumb('Roles','https://localhost/admin/users/roles'); $html = $breadcrumbs->render();
You can use a custom configuration passing a BreadcrumbConfig objet to the constructor
$navTag = '<nav class="test" aria-label="breadcrumb">'; $olTag = '<ol class="breadcrumb" type="1">'; $liTag = '<li class="breadcrumb-item" value="2">'; $separator = '-'; $config = new BreadcrumbConfig( !BreadcrumbConfig::DEFAULT_GENERATE_LINKS, $separator, $navTag, $olTag, $liTag );
If you want more examples, watch test/BreadcrumbTest.php
.
License
See LICENSE.