Breadcrumbs
인증된 제출자tabuna/breadcrumbs
Laravel 앱에 브레드크럼을 쉽게 추가하는 방법입니다.
브레드크럼
소개
브레드크럼(Breadcrumbs)은 전체 사이트 계층 구조에서 현재 페이지의 위치를 알려 주는 링크 목록입니다. 예를 들어 Home / Sample Post / Edit 같은 브레드크럼은 사용자가 "Sample Post"의 수정 페이지를 보고 있다는 뜻입니다. 사용자는 "Sample Post"를 클릭해 해당 페이지로 이동하거나, "Home"을 클릭해 홈페이지로 돌아갈 수 있습니다.
Home / Sample Post / Edit
이 Laravel 프레임워크용 패키지를 사용하면 애플리케이션에 브레드크럼을 손쉽게 구성할 수 있습니다.
설치
명령줄에서 다음 명령을 실행하세요.
composer require tabuna/breadcrumbs이 명령은 composer.json을 업데이트하고 패키지를 vendor/ 디렉터리에 설치합니다.
브레드크럼 정의하기
이제 라우트 파일 안에서 바로 브레드크럼을 정의할 수 있습니다.
use Tabuna\Breadcrumbs\Trail;
// Home
Route::get('/', fn () => view('home'))
->name('home')
->breadcrumbs(fn (Trail $trail) =>
$trail->push('Home', route('home'))
);
// Home > About
Route::get('/about', fn () => view('home'))
->name('about')
->breadcrumbs(fn (Trail $trail) =>
$trail->parent('home')->push('About', route('about'))
);요청에서 전달된 인자도 가져올 수 있습니다. 파라미터는 이름을 기준으로 해석됩니다.
Route::get('/category/{category}', function (Category $category) {
// 이 예제에서 $category는 Eloquent 모델 인스턴스입니다.
// ...
})
->name('category')
->breadcrumbs(fn (Trail $trail, Category $category) =>
$trail->push($category->title, route('category', $category->id))
);라우트 자동 감지
이 패키지는 작성해야 할 코드 줄 수를 줄이려고 합니다. 그래서 route() 메서드의 결과를 직접 넘기지 않아도 됩니다.
다음 두 선언은 서로 동일하게 동작합니다.
Route::get('/', fn () => view('home'))
->name('home')
->breadcrumbs(fn (Trail $trail) =>
$trail->push('Home', route('home'))
);
Route::get('/', fn () => view('home'))
->name('home')
->breadcrumbs(fn (Trail $trail) =>
$trail->push('Home', 'home')
);별도의 라우트 파일을 사용하고 싶다면
원하는 파일을 서비스 프로바이더에 추가하기만 하면 됩니다.
namespace App\Providers;
use Illuminate\Support\ServiceProvider;
class BreadcrumbsServiceProvider extends ServiceProvider
{
/**
* Bootstrap the application events.
*/
public function boot(): void
{
require base_path('routes/breadcrumbs.php');
}
}그런 다음 라우트 디렉터리에 전용 파일을 만들어 사용합니다.
// routes/breadcrumbs.php
// Photos
Breadcrumbs::for('photo.index', fn (Trail $trail) =>
$trail->parent('home')->push('Photos', route('photo.index'))
);리소스 라우트
리소스를 사용하면 라우트 묶음이 한꺼번에 선언되므로, 각 라우트의 값을 직접 지정해야 합니다.
// routes/web.php
Route::resource('photos', 'PhotoController');라우트 파일은 캐시될 수 있으므로, 이 설정은 서비스 프로바이더에 작성하는 편이 좋습니다.
namespace App\Providers;
use Illuminate\Support\ServiceProvider;
use Tabuna\Breadcrumbs\Breadcrumbs;
use Tabuna\Breadcrumbs\Trail;
class BreadcrumbsServiceProvider extends ServiceProvider
{
/**
* Bootstrap any application services.
*/
public function boot(): void
{
Breadcrumbs::for('photos.index', fn (Trail $trail) =>
$trail->push('Photos', route('home'))
);
Breadcrumbs::for('photos.create', fn (Trail $trail) =>
$trail
->parent('photos.index', route('photos.index'))
->push('Add new photo', route('home'))
);
}
}Blade 컴포넌트로 브레드크럼 출력하기
출력용 컴포넌트를 사용할 수 있습니다.
<ul>
<x-tabuna-breadcrumbs/>
</ul>목록 항목에 클래스를 지정하려면 다음과 같이 합니다.
<x-tabuna-breadcrumbs
class="item"
active="active"
/>파라미터를 직접 전달할 수도 있습니다.
<x-tabuna-breadcrumbs
:parameters="[
'foo' => 'Dashboard',
'baz' => 'Users',
'buzz' => 'Edit Profile'
]"
/>이름이 지정된 라우트를 명시적으로 호출할 수도 있습니다.
<x-tabuna-breadcrumbs
route="static"
/>Blade 뷰로 브레드크럼 출력하기
원하는 페이지에 브레드크럼을 표시하려면 다음과 같이 호출하면 됩니다.
@if(Breadcrumbs::has())
@foreach (Breadcrumbs::current() as $crumbs)
@if ($crumbs->url() && !$loop->last)
<li class="breadcrumb-item">
<a href="{{ $crumbs->url() }}">
{{ $crumbs->title() }}
</a>
</li>
@else
<li class="breadcrumb-item active">
{{ $crumbs->title() }}
</li>
@endif
@endforeach
@endif그러면 다음과 같은 결과가 출력됩니다.
Home / About
크레딧
저는 수년간 Dave James Miller의 패키지를 잘 사용해 왔지만, 그 패키지는 개발과 지원이 중단되었습니다. 대안을 오래 찾아본 끝에 Dwight Watson의 패키지가 마음에 들었지만, 브레드크럼 정의가 라우트 선언과 분리되어 있다는 점이 계속 마음에 걸렸습니다. 그래서 이 패키지를 만들었습니다. 이 패키지는 앞의 두 패키지의 코드를 활용합니다.
라이선스
MIT 라이선스(The MIT License, MIT)를 따릅니다. 자세한 내용은 License File을 참고하세요.