Giter Club home page Giter Club logo

laravel-breadcrumbs's Introduction

Notice: In favor of using Filament, I have no need for this package anymore. As a result, I will no longer commit any more changes to it.

Breadcrumbs for Laravel

Latest Version on Packagist Tests Total Downloads PHP from Packagist License

social image

With Breadcrumbs for Laravel, you can easily add breadcrumbs to your Laravel applications. This package works very similar to the breadcrumbs package created by James Mills. I created my own version of the package because that one has been abandoned, and I want to continue to provide this kind of functionality in my own Laravel apps.

Here's a simple example of how you can define breadcrumbs, and then render them in a view:

// somewhere in a file defined in config/breadcrumbs.php. default = 'view' => base_path('routes/breadcrumbs.php')
Breadcrumbs::for('home', function (Generator $trail) {
    $trail->push('Home', route('home'));
});

// Home > About
Breadcrumbs::for('about', function (Generator $trail)  {
    $trail->parent('home')->push('About', route('about'));
});
<!-- will render a view with links for Home > About -->
<nav>{!! Breadcrumbs::render('about') !!}</nav>

Installation

You can install the package via composer:

composer require rawilk/laravel-breadcrumbs

You can publish the config file with:

php artisan vendor:publish --tag="breadcrumbs-config"

You can view the default configuration here: https://github.com/rawilk/laravel-breadcrumbs/blob/main/config/breadcrumbs.php

Documentation

For more documentation, please visit: https://randallwilk.dev/docs/laravel-breadcrumbs

Testing

On a fresh install, run the setup bin script first, otherwise certain DOM assertions won't work.

./bin/setup.sh

For convenience, a composer script is setup to run the pest test suite in parallel.

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

Disclaimer

This package is not affiliated with, maintained, authorized, endorsed or sponsored by Laravel or any of its affiliates.

License

The MIT License (MIT). Please see License File for more information.

laravel-breadcrumbs's People

Contributors

dependabot[bot] avatar github-actions[bot] avatar jbajou avatar rawilk avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

jordantsap

laravel-breadcrumbs's Issues

Render Function

Laravel Breadcrumbs Version

v3.0.1

Laravel Version

v9.19

Bug description

I am unable to use
Normal Render {{ Breadcrumbs::render('#') }}
It shows the text

I have to change the syntax to {!! Breadcrumbs::render('#') !!}
to get the UI output

Steps to reproduce

Followed the Documentation

Relevant log output

No response

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.