Laravel Tutorials

How to Use Blade Component and Include Aliases

Published
How to Use Blade Component and Include Aliases image

In the Laravel 5.6.0 release Sebastian De Deyne contributed Blade component aliases and then in Laravel 5.6.4, he added a similar feature for Blade include aliases. Let’s go over how you can use both in your Laravel 5.6 projects!

Component Aliases

You define a component alias with a string to the template path as you would a typical @component, and the second argument is the name of the alias:

Blade::component('app.components.alert', 'alert');

Given the alias, usage in a template looks something like this:

@alert(['type' => 'danger'])
    @slot('title')
        Forbidden
    @endslot

    You are not allowed to access this resource!
@endalert

{{-- Instead of --}}
@component('app.components.alert');
 ...
@endcomponent

The first noticeable improvement of using component aliases is that your templates don’t need to change everywhere if you decide to relocate the component file:

The second thing I like about Blade component aliases is that you don’t have to remember the location of the file when using them in your templates. On the other hand, you must find which aliases are defined (which isn’t hard, just use your AppServiceProvider::boot() method) to know what component aliases are available in a project.

Component aliases are convenient to avoid typing the full path to the component file and allows your components to look more expressive as directives.

Include Aliases

Blade include aliases are available as of Laravel 5.6.5. It’s the same thing as component aliases, but for @includes. It comes in handy for HTML that doesn’t have a slot:

@input(['type' => 'email'])

Given the above template usage, here’s how the include might look:

<input type="{{ $type ?? 'text' }}">

You register include aliases with the following:

Blade::include('includes.input');

You can optionally pass a second argument for the alias if you want to be more verbose about defining the alias:

{{-- What happens by default --}}
Blade::include('includes.input', 'input');

{{-- A custom include name --}}
Blade::include('includes.input', 'textinput');

You can learn more about Blade component aliases in the Components and Slots section of the documentation.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Sponsored

laravelcloud logo
Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Cloud

The latest

View all →
Laravel AI SDK 1.4 Lets Agents Recover From Tool Failures image

Laravel AI SDK 1.4 Lets Agents Recover From Tool Failures

Read article
Laravel Read Replicas: Check if a Replica Has Caught Up image

Laravel Read Replicas: Check if a Replica Has Caught Up

Read article
UUID Request Input and Migration Failure Events in Laravel 13.42 image

UUID Request Input and Migration Failure Events in Laravel 13.42

Read article
Replay Missed Laravel Scheduled Tasks With Schedule Catchup image

Replay Missed Laravel Scheduled Tasks With Schedule Catchup

Read article
Search Polymorphic Relations and Filament Tables With Laravel Searchable image

Search Polymorphic Relations and Filament Tables With Laravel Searchable

Read article
Laravel Rest Api 3.0: Typed Fields, Metrics, and OpenAPI Docs image

Laravel Rest Api 3.0: Typed Fields, Metrics, and OpenAPI Docs

Read article