Download the PHP package atstudio-tech/breadcrumbs without Composer
On this page you can find all versions of the php package atstudio-tech/breadcrumbs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download atstudio-tech/breadcrumbs
More information about atstudio-tech/breadcrumbs
Files in atstudio-tech/breadcrumbs
Package breadcrumbs
Short Description A simple breadcrumbs package for Laravel, with support for Blade and Inertia.js.
License MIT
FAQ
Example:
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 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.
Informations about the package breadcrumbs
Laravel Breadcrumbs
A simple breadcrumbs package for Laravel, with support for Blade and Inertia.js.
Installation
The service provider is auto-discovered. To publish the config and views:
Quick Start
Add breadcrumbs from your controller or routes file, then render them in your view.
Adding Breadcrumbs
From a controller:
From your routes file:
Rendering
In Blade, use the @crumbs directive or call render() directly:
For Inertia.js, the breadcrumbs are available as a JSON-serializable array via crumbs()->toArray() or crumbs()->toJson().
Usage
Notations
There are three interchangeable ways to interact with breadcrumbs:
Helper function (recommended):
Facade:
Dependency injection:
Options Array
Instead of separate arguments, you can pass an associative array:
Multi-Item Positions
A position in the trail can hold multiple items by passing a sequential array. This is useful for rendering a dropdown selector instead of a single link:
When iterating, a multi-item position is an array of Breadcrumb objects rather than a single one. Each item independently tracks its own active state.
Custom Views
Publish the views and edit them, or create your own. The default view (breadcrumbs::plain):
You can specify a different view globally in config/breadcrumbs.php or per-render:
API
Breadcrumbs::add(string|array $title, ?string $path = null, array $extra = [])
| Parameter | Type | Description |
|---|---|---|
$title |
string\|array |
The breadcrumb label, an options array, or a list of options arrays |
$path |
?string |
A URL string. null means no link. |
$extra |
array |
Arbitrary extra data attached to the breadcrumb. |
When $title is an associative array, it is treated as a single breadcrumb with keys title, path (optional), and extra (optional).
When $title is a sequential array, each element is an options array and the items are grouped at a single position in the trail.
crumbs(string|array|callable|null $title = null, ?string $path = null, array $extra = [])
Same as Breadcrumbs::add(), but also accepts a callable and returns the Breadcrumbs instance. Called without arguments, it simply returns the instance.
Breadcrumb Properties
| Property | Type | Description |
|---|---|---|
title |
string |
The breadcrumb label. |
path |
?string |
The URL, or null if none was provided. |
active |
bool |
true when path matches the current URL. |
extra |
array |
Arbitrary extra data. |
Changelog
See CHANGELOG for all changes.
Contributing
See CONTRIBUTING for details.
Credits
- Alex Torscho
- All Contributors
License
MIT. See LICENSE for details.
