Download the PHP package lcharette/uf_breadcrumb without Composer

On this page you can find all versions of the php package lcharette/uf_breadcrumb. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of lcharette/uf_breadcrumb

Informations about the package uf_breadcrumb

Breadcrumb Sprinkle for UserFrosting 4

Donate Latest Version UserFrosting Version Build Codecov StyleCI

This Sprinkle provides an helper service and Twig template to manage simple page breadcrumb for UserFrosting 4.

Help and Contributing

If you need help using this sprinkle or found any bug, feels free to open an issue or submit a pull request. You can also find me on the UserFrosting Chat most of the time for direct support.

Installation

Edit UserFrosting app/sprinkles.json file and add the following to the require list : "lcharette/uf_breadcrumb": "^3.0.0". Also add Breadcrumb to the base list. For example:

Run composer update then php bakery bake to install the sprinkle.

Usage

Adding crumbs

Breadcrumbs hierarchy needs to be manually defined in each controllers. To dynamically add breadcrumbs to the UI, simply use the add method of the breadcrumb service:

You can also chain multiple methods :

The crumbs can also be created using the Crumb object :

The item name can also be switched for a translation key :

Path is actually optional if you don't want to provide a link with your crumb. Alternatively, a route name / route pattern placeholders can also be used :

Prepend crumbs

You can also use the prepend method to add a new item to the beginning of the list:

Note that the site index is automatically added to the beginning of the list, whether you use prepend or not.

If you don't add any custom breadcrumbs, it will fallback to the default UserFrosting behaviour.

Custom style

The default UserFrosting layouts and themes will pick up the breadcrumbs automatically. If your UserFrosting theme doesn't include breadcrumbs automatically, simply add this line to your twig files:

If you want to edit the style of the breadcrumbs, simply copy the templates/navigation/breadcrumb.html.twig file in your own sprinkle and edit according to your styling. No custom assets are included with this sprinkle.

Licence

By Louis Charette. Copyright (c) 2020, free to use in personal and commercial software as per the MIT license.

All versions of uf_breadcrumb with dependencies

PHP Build Version
Package Version
Requires php Version >=7.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package lcharette/uf_breadcrumb contains the following files

Loading the files please wait ....