Blade Templates

• Introduction
• Displaying Data
  • HTML Entity Encoding
  • Blade & JavaScript Frameworks
• Blade Directives
  • If Statements
  • Switch Statements
  • Loops
  • The Loop Variable
  • Conditional Classes
  • Including Subviews
  • The @once Directive
  • Raw PHP
  • Comments
• Components
  • Rendering Components
  • Passing Data To Components
  • Component Attributes
  • Reserved Keywords
  • Slots
  • Inline Component Views
  • Anonymous Components
  • Dynamic Components
  • Manually Registering Components
• Building Layouts
  • Layouts Using Components
  • Layouts Using Template Inheritance
• Forms
  • CSRF Field
  • Method Field
  • Validation Errors
• Stacks
• Service Injection
• Extending Blade
  • Custom Echo Handlers
  • Custom If Statements

Introduction

Blade is the simple, yet powerful templating engine that is included with Laravel. Unlike some PHP templating engines, Blade does not restrict you from using plain PHP code in your templates. In fact, all Blade templates are compiled into plain PHP code and cached until they are modified, meaning Blade adds essentially zero overhead to your application. Blade template files use the .blade.php file extension and are typically stored in the resources/views directory.

Blade views may be returned from routes or controller using the global view helper. Of course, as mentioned in the documentation on views, data may be passed to the Blade view using the view helper's second argument:

1Route::get('/', function () {
2    return view('greeting', ['name' => 'Finn']);
3});
1Route::get('/', function () {
2    return view('greeting', ['name' => 'Finn']);
3});

Displaying Data

You may display data that is passed to your Blade views by wrapping the variable in curly braces. For example, given the following route:

1Route::get('/', function () {
2    return view('welcome', ['name' => 'Samantha']);
3});
1Route::get('/', function () {
2    return view('welcome', ['name' => 'Samantha']);
3});

You may display the contents of the name variable like so:

1Hello, {{ $name }}.
1Hello, {{ $name }}.

You are not limited to displaying the contents of the variables passed to the view. You may also echo the results of any PHP function. In fact, you can put any PHP code you wish inside of a Blade echo statement:

1The current UNIX timestamp is {{ time() }}.
1The current UNIX timestamp is {{ time() }}.

HTML Entity Encoding

By default, Blade (and the Laravel e helper) will double encode HTML entities. If you would like to disable double encoding, call the Blade::withoutDoubleEncoding method from the boot method of your AppServiceProvider:

 1<?php
 2 
 3namespace App\Providers;
 4 
 5use Illuminate\Support\Facades\Blade;
 6use Illuminate\Support\ServiceProvider;
 7 
 8class AppServiceProvider extends ServiceProvider
 9{
10    /**
11     * Bootstrap any application services.
12     *
13     * @return void
14     */
15    public function boot()
16    {
17        Blade::withoutDoubleEncoding();
18    }
19}
 1<?php
 2 
 3namespace App\Providers;
 4 
 5use Illuminate\Support\Facades\Blade;
 6use Illuminate\Support\ServiceProvider;
 7 
 8class AppServiceProvider extends ServiceProvider
 9{
10    /**
11     * Bootstrap any application services.
12     *
13     * @return void
14     */
15    public function boot()
16    {
17        Blade::withoutDoubleEncoding();
18    }
19}

Displaying Unescaped Data

By default, Blade {{ }} statements are automatically sent through PHP's htmlspecialchars function to prevent XSS attacks. If you do not want your data to be escaped, you may use the following syntax:

1Hello, {!! $name !!}.
1Hello, {!! $name !!}.

Blade & JavaScript Frameworks

Since many JavaScript frameworks also use "curly" braces to indicate a given expression should be displayed in the browser, you may use the @ symbol to inform the Blade rendering engine an expression should remain untouched. For example:

1<h1>Laravel</h1>
2 
3Hello, @{{ name }}.
1<h1>Laravel</h1>
2 
3Hello, @{{ name }}.

In this example, the @ symbol will be removed by Blade; however, {{ name }} expression will remain untouched by the Blade engine, allowing it to be rendered by your JavaScript framework.

The @ symbol may also be used to escape Blade directives:

1{{-- Blade template --}}
2@@if()
3 
4<!-- HTML output -->
5@if()
1{{-- Blade template --}}
2@@if()
3 
4<!-- HTML output -->
5@if()

Rendering JSON

Sometimes you may pass an array to your view with the intention of rendering it as JSON in order to initialize a JavaScript variable. For example:

1<script>
2    var app = <?php echo json_encode($array); ?>;
3</script>
1<script>
2    var app = <?php echo json_encode($array); ?>;
3</script>

However, instead of manually calling json_encode, you may use the Illuminate\Support\Js::from method directive. The from method accepts the same arguments as PHP's json_encode function; however, it will ensure that the resulting JSON is properly escaped for inclusion within HTML quotes. The from method will return a string JSON.parse JavaScript statement that will convert the given object or array into a valid JavaScript object:

1<script>
2    var app = {{ Illuminate\Support\Js::from($array) }};
3</script>
1<script>
2    var app = {{ Illuminate\Support\Js::from($array) }};
3</script>

The latest versions of the Laravel application skeleton include a Js facade, which provides convenient access to this functionality within your Blade templates:

1<script>
2    var app = {{ Js::from($array) }};
3</script>
1<script>
2    var app = {{ Js::from($array) }};
3</script>

The @verbatim Directive

If you are displaying JavaScript variables in a large portion of your template, you may wrap the HTML in the @verbatim directive so that you do not have to prefix each Blade echo statement with an @ symbol:

1@verbatim
2    <div class="container">
3        Hello, {{ name }}.
4    </div>
5@endverbatim
1@verbatim
2    <div class="container">
3        Hello, {{ name }}.
4    </div>
5@endverbatim

Blade Directives

In addition to template inheritance and displaying data, Blade also provides convenient shortcuts for common PHP control structures, such as conditional statements and loops. These shortcuts provide a very clean, terse way of working with PHP control structures while also remaining familiar to their PHP counterparts.

If Statements

You may construct if statements using the @if, @elseif, @else, and @endif directives. These directives function identically to their PHP counterparts:

1@if (count($records) === 1)
2    I have one record!
3@elseif (count($records) > 1)
4    I have multiple records!
5@else
6    I don't have any records!
7@endif
1@if (count($records) === 1)
2    I have one record!
3@elseif (count($records) > 1)
4    I have multiple records!
5@else
6    I don't have any records!
7@endif

For convenience, Blade also provides an @unless directive:

1@unless (Auth::check())
2    You are not signed in.
3@endunless
1@unless (Auth::check())
2    You are not signed in.
3@endunless

In addition to the conditional directives already discussed, the @isset and @empty directives may be used as convenient shortcuts for their respective PHP functions:

1@isset($records)
2    // $records is defined and is not null...
3@endisset
4 
5@empty($records)
6    // $records is "empty"...
7@endempty
1@isset($records)
2    // $records is defined and is not null...
3@endisset
4 
5@empty($records)
6    // $records is "empty"...
7@endempty

Authentication Directives

The @auth and @guest directives may be used to quickly determine if the current user is authenticated or is a guest:

1@auth
2    // The user is authenticated...
3@endauth
4 
5@guest
6    // The user is not authenticated...
7@endguest
1@auth
2    // The user is authenticated...
3@endauth
4 
5@guest
6    // The user is not authenticated...
7@endguest

If needed, you may specify the authentication guard that should be checked when using the @auth and @guest directives:

1@auth('admin')
2    // The user is authenticated...
3@endauth
4 
5@guest('admin')
6    // The user is not authenticated...
7@endguest
1@auth('admin')
2    // The user is authenticated...
3@endauth
4 
5@guest('admin')
6    // The user is not authenticated...
7@endguest

Environment Directives

You may check if the application is running in the production environment using the @production directive:

1@production
2    // Production specific content...
3@endproduction
1@production
2    // Production specific content...
3@endproduction

Or, you may determine if the application is running in a specific environment using the @env directive:

1@env('staging')
2    // The application is running in "staging"...
3@endenv
4 
5@env(['staging', 'production'])
6    // The application is running in "staging" or "production"...
7@endenv
1@env('staging')
2    // The application is running in "staging"...
3@endenv
4 
5@env(['staging', 'production'])
6    // The application is running in "staging" or "production"...
7@endenv

Section Directives

You may determine if a template inheritance section has content using the @hasSection directive:

1@hasSection('navigation')
2    <div class="pull-right">
3        @yield('navigation')
4    </div>
5 
6    <div class="clearfix"></div>
7@endif
1@hasSection('navigation')
2    <div class="pull-right">
3        @yield('navigation')
4    </div>
5 
6    <div class="clearfix"></div>
7@endif

You may use the sectionMissing directive to determine if a section does not have content:

1@sectionMissing('navigation')
2    <div class="pull-right">
3        @include('default-navigation')
4    </div>
5@endif
1@sectionMissing('navigation')
2    <div class="pull-right">
3        @include('default-navigation')
4    </div>
5@endif

Switch Statements

Switch statements can be constructed using the @switch, @case, @break, @default and @endswitch directives:

 1@switch($i)
 2    @case(1)
 3        First case...
 4        @break
 5 
 6    @case(2)
 7        Second case...
 8        @break
 9 
10    @default
11        Default case...
12@endswitch
 1@switch($i)
 2    @case(1)
 3        First case...
 4        @break
 5 
 6    @case(2)
 7        Second case...
 8        @break
 9 
10    @default
11        Default case...
12@endswitch

Loops

In addition to conditional statements, Blade provides simple directives for working with PHP's loop structures. Again, each of these directives functions identically to their PHP counterparts:

 1@for ($i = 0; $i < 10; $i++)
 2    The current value is {{ $i }}
 3@endfor
 4 
 5@foreach ($users as $user)
 6    <p>This is user {{ $user->id }}</p>
 7@endforeach
 8 
 9@forelse ($users as $user)
10    <li>{{ $user->name }}</li>
11@empty
12    <p>No users</p>
13@endforelse
14 
15@while (true)
16    <p>I'm looping forever.</p>
17@endwhile
 1@for ($i = 0; $i < 10; $i++)
 2    The current value is {{ $i }}
 3@endfor
 4 
 5@foreach ($users as $user)
 6    <p>This is user {{ $user->id }}</p>
 7@endforeach
 8 
 9@forelse ($users as $user)
10    <li>{{ $user->name }}</li>
11@empty
12    <p>No users</p>
13@endforelse
14 
15@while (true)
16    <p>I'm looping forever.</p>
17@endwhile

When using loops you may also end the loop or skip the current iteration using the @continue and @break directives:

 1@foreach ($users as $user)
 2    @if ($user->type == 1)
 3        @continue
 4    @endif
 5 
 6    <li>{{ $user->name }}</li>
 7 
 8    @if ($user->number == 5)
 9        @break
10    @endif
11@endforeach
 1@foreach ($users as $user)
 2    @if ($user->type == 1)
 3        @continue
 4    @endif
 5 
 6    <li>{{ $user->name }}</li>
 7 
 8    @if ($user->number == 5)
 9        @break
10    @endif
11@endforeach

You may also include the continuation or break condition within the directive declaration:

1@foreach ($users as $user)
2    @continue($user->type == 1)
3 
4    <li>{{ $user->name }}</li>
5 
6    @break($user->number == 5)
7@endforeach
1@foreach ($users as $user)
2    @continue($user->type == 1)
3 
4    <li>{{ $user->name }}</li>
5 
6    @break($user->number == 5)
7@endforeach

The Loop Variable

While iterating through a foreach loop, a $loop variable will be available inside of your loop. This variable provides access to some useful bits of information such as the current loop index and whether this is the first or last iteration through the loop:

 1@foreach ($users as $user)
 2    @if ($loop->first)
 3        This is the first iteration.
 4    @endif
 5 
 6    @if ($loop->last)
 7        This is the last iteration.
 8    @endif
 9 
10    <p>This is user {{ $user->id }}</p>
11@endforeach
 1@foreach ($users as $user)
 2    @if ($loop->first)
 3        This is the first iteration.
 4    @endif
 5 
 6    @if ($loop->last)
 7        This is the last iteration.
 8    @endif
 9 
10    <p>This is user {{ $user->id }}</p>
11@endforeach

If you are in a nested loop, you may access the parent loop's $loop variable via the parent property:

1@foreach ($users as $user)
2    @foreach ($user->posts as $post)
3        @if ($loop->parent->first)
4            This is the first iteration of the parent loop.
5        @endif
6    @endforeach
7@endforeach
1@foreach ($users as $user)
2    @foreach ($user->posts as $post)
3        @if ($loop->parent->first)
4            This is the first iteration of the parent loop.
5        @endif
6    @endforeach
7@endforeach

The $loop variable also contains a variety of other useful properties:

Conditional Classes

The @class directive conditionally compiles a CSS class string. The directive accepts an array of classes where the array key contains the class or classes you wish to add, while the value is a boolean expression. If the array element has a numeric key, it will always be included in the rendered class list:

 1@php
 2    $isActive = false;
 3    $hasError = true;
 4@endphp
 5 
 6<span @class([
 7    'p-4',
 8    'font-bold' => $isActive,
 9    'text-gray-500' => ! $isActive,
10    'bg-red' => $hasError,
11])></span>
12 
13<span class="p-4 text-gray-500 bg-red"></span>
 1@php
 2    $isActive = false;
 3    $hasError = true;
 4@endphp
 5 
 6<span @class([
 7    'p-4',
 8    'font-bold' => $isActive,
 9    'text-gray-500' => ! $isActive,
10    'bg-red' => $hasError,
11])></span>
12 
13<span class="p-4 text-gray-500 bg-red"></span>

Including Subviews

Blade's @include directive allows you to include a Blade view from within another view. All variables that are available to the parent view will be made available to the included view:

1<div>
2    @include('shared.errors')
3 
4    <form>
5        <!-- Form Contents -->
6    </form>
7</div>
1<div>
2    @include('shared.errors')
3 
4    <form>
5        <!-- Form Contents -->
6    </form>
7</div>

Even though the included view will inherit all data available in the parent view, you may also pass an array of additional data that should be made available to the included view:

1@include('view.name', ['status' => 'complete'])
1@include('view.name', ['status' => 'complete'])

If you attempt to @include a view which does not exist, Laravel will throw an error. If you would like to include a view that may or may not be present, you should use the @includeIf directive:

1@includeIf('view.name', ['status' => 'complete'])
1@includeIf('view.name', ['status' => 'complete'])

If you would like to @include a view if a given boolean expression evaluates to true or false, you may use the @includeWhen and @includeUnless directives:

1@includeWhen($boolean, 'view.name', ['status' => 'complete'])
2 
3@includeUnless($boolean, 'view.name', ['status' => 'complete'])
1@includeWhen($boolean, 'view.name', ['status' => 'complete'])
2 
3@includeUnless($boolean, 'view.name', ['status' => 'complete'])

To include the first view that exists from a given array of views, you may use the includeFirst directive:

1@includeFirst(['custom.admin', 'admin'], ['status' => 'complete'])
1@includeFirst(['custom.admin', 'admin'], ['status' => 'complete'])

Rendering Views For Collections

You may combine loops and includes into one line with Blade's @each directive:

1@each('view.name', $jobs, 'job')
1@each('view.name', $jobs, 'job')

The @each directive's first argument is the view to render for each element in the array or collection. The second argument is the array or collection you wish to iterate over, while the third argument is the variable name that will be assigned to the current iteration within the view. So, for example, if you are iterating over an array of jobs, typically you will want to access each job as a job variable within the view. The array key for the current iteration will be available as the key variable within the view.

You may also pass a fourth argument to the @each directive. This argument determines the view that will be rendered if the given array is empty.

1@each('view.name', $jobs, 'job', 'view.empty')
1@each('view.name', $jobs, 'job', 'view.empty')

The @once Directive

The @once directive allows you to define a portion of the template that will only be evaluated once per rendering cycle. This may be useful for pushing a given piece of JavaScript into the page's header using stacks. For example, if you are rendering a given component within a loop, you may wish to only push the JavaScript to the header the first time the component is rendered:

1@once
2    @push('scripts')
3        <script>
4            // Your custom JavaScript...
5        </script>
6    @endpush
7@endonce
1@once
2    @push('scripts')
3        <script>
4            // Your custom JavaScript...
5        </script>
6    @endpush
7@endonce

Raw PHP

In some situations, it's useful to embed PHP code into your views. You can use the Blade @php directive to execute a block of plain PHP within your template:

1@php
2    $counter = 1;
3@endphp
1@php
2    $counter = 1;
3@endphp

Comments

Blade also allows you to define comments in your views. However, unlike HTML comments, Blade comments are not included in the HTML returned by your application:

1{{-- This comment will not be present in the rendered HTML --}}
1{{-- This comment will not be present in the rendered HTML --}}

Components

Components and slots provide similar benefits to sections, layouts, and includes; however, some may find the mental model of components and slots easier to understand. There are two approaches to writing components: class based components and anonymous components.

To create a class based component, you may use the make:component Artisan command. To illustrate how to use components, we will create a simple Alert component. The make:component command will place the component in the app/View/Components directory:

1php artisan make:component Alert
1php artisan make:component Alert

The make:component command will also create a view template for the component. The view will be placed in the resources/views/components directory. When writing components for your own application, components are automatically discovered within the app/View/Components directory and resources/views/components directory, so no further component registration is typically required.

You may also create components within subdirectories:

1php artisan make:component Forms/Input
1php artisan make:component Forms/Input

The command above will create an Input component in the app/View/Components/Forms directory and the view will be placed in the resources/views/components/forms directory.

Manually Registering Package Components

When writing components for your own application, components are automatically discovered within the app/View/Components directory and resources/views/components directory.

However, if you are building a package that utilizes Blade components, you will need to manually register your component class and its HTML tag alias. You should typically register your components in the boot method of your package's service provider:

1use Illuminate\Support\Facades\Blade;
2 
3/**
4 * Bootstrap your package's services.
5 */
6public function boot()
7{
8    Blade::component('package-alert', Alert::class);
9}
1use Illuminate\Support\Facades\Blade;
2 
3/**
4 * Bootstrap your package's services.
5 */
6public function boot()
7{
8    Blade::component('package-alert', Alert::class);
9}

Once your component has been registered, it may be rendered using its tag alias:

1<x-package-alert/>
1<x-package-alert/>

Alternatively, you may use the componentNamespace method to autoload component classes by convention. For example, a Nightshade package might have Calendar and ColorPicker components that reside within the Package\Views\Components namespace:

 1use Illuminate\Support\Facades\Blade;
 2 
 3/**
 4 * Bootstrap your package's services.
 5 *
 6 * @return void
 7 */
 8public function boot()
 9{
10    Blade::componentNamespace('Nightshade\\Views\\Components', 'nightshade');
11}
 1use Illuminate\Support\Facades\Blade;
 2 
 3/**
 4 * Bootstrap your package's services.
 5 *
 6 * @return void
 7 */
 8public function boot()
 9{
10    Blade::componentNamespace('Nightshade\\Views\\Components', 'nightshade');
11}

This will allow the usage of package components by their vendor namespace using the package-name:: syntax:

1<x-nightshade::calendar />
2<x-nightshade::color-picker />
1<x-nightshade::calendar />
2<x-nightshade::color-picker />

Blade will automatically detect the class that's linked to this component by pascal-casing the component name. Subdirectories are also supported using "dot" notation.

Rendering Components

To display a component, you may use a Blade component tag within one of your Blade templates. Blade component tags start with the string x- followed by the kebab case name of the component class:

1<x-alert/>
2 
3<x-user-profile/>
1<x-alert/>
2 
3<x-user-profile/>

If the component class is nested deeper within the app/View/Components directory, you may use the . character to indicate directory nesting. For example, if we assume a component is located at app/View/Components/Inputs/Button.php, we may render it like so:

1<x-inputs.button/>
1<x-inputs.button/>

Passing Data To Components

You may pass data to Blade components using HTML attributes. Hard-coded, primitive values may be passed to the component using simple HTML attribute strings. PHP expressions and variables should be passed to the component via attributes that use the : character as a prefix:

1<x-alert type="error" :message="$message"/>
1<x-alert type="error" :message="$message"/>

You should define the component's required data in its class constructor. All public properties on a component will automatically be made available to the component's view. It is not necessary to pass the data to the view from the component's render method:

 1<?php
 2 
 3namespace App\View\Components;
 4 
 5use Illuminate\View\Component;
 6 
 7class Alert extends Component
 8{
 9    /**
10     * The alert type.
11     *
12     * @var string
13     */
14    public $type;
15 
16    /**
17     * The alert message.
18     *
19     * @var string
20     */
21    public $message;
22 
23    /**
24     * Create the component instance.
25     *
26     * @param  string  $type
27     * @param  string  $message
28     * @return void
29     */
30    public function __construct($type, $message)
31    {
32        $this->type = $type;
33        $this->message = $message;
34    }
35 
36    /**
37     * Get the view / contents that represent the component.
38     *
39     * @return \Illuminate\View\View|\Closure|string
40     */
41    public function render()
42    {
43        return view('components.alert');
44    }
45}
 1<?php
 2 
 3namespace App\View\Components;
 4 
 5use Illuminate\View\Component;
 6 
 7class Alert extends Component
 8{
 9    /**
10     * The alert type.
11     *
12     * @var string
13     */
14    public $type;
15 
16    /**
17     * The alert message.
18     *
19     * @var string
20     */
21    public $message;
22 
23    /**
24     * Create the component instance.
25     *
26     * @param  string  $type
27     * @param  string  $message
28     * @return void
29     */
30    public function __construct($type, $message)
31    {
32        $this->type = $type;
33        $this->message = $message;
34    }
35 
36    /**
37     * Get the view / contents that represent the component.
38     *
39     * @return \Illuminate\View\View|\Closure|string
40     */
41    public function render()
42    {
43        return view('components.alert');
44    }
45}

When your component is rendered, you may display the contents of your component's public variables by echoing the variables by name:

1<div class="alert alert-{{ $type }}">
2    {{ $message }}
3</div>
1<div class="alert alert-{{ $type }}">
2    {{ $message }}
3</div>

Casing

Component constructor arguments should be specified using camelCase, while kebab-case should be used when referencing the argument names in your HTML attributes. For example, given the following component constructor:

 1/**
 2 * Create the component instance.
 3 *
 4 * @param  string  $alertType
 5 * @return void
 6 */
 7public function __construct($alertType)
 8{
 9    $this->alertType = $alertType;
10}
 1/**
 2 * Create the component instance.
 3 *
 4 * @param  string  $alertType
 5 * @return void
 6 */
 7public function __construct($alertType)
 8{
 9    $this->alertType = $alertType;
10}

The $alertType argument may be provided to the component like so:

1<x-alert alert-type="danger" />
1<x-alert alert-type="danger" />

Escaping Attribute Rendering

Since some JavaScript frameworks such as Alpine.js also use colon-prefixed attributes, you may use a double colon (::) prefix to inform Blade that the attribute is not a PHP expression. For example, given the following component:

1<x-button ::class="{ danger: isDeleting }">
2    Submit
3</x-button>
1<x-button ::class="{ danger: isDeleting }">
2    Submit
3</x-button>

The following HTML will be rendered by Blade:

1<button :class="{ danger: isDeleting }">
2    Submit
3</button>
1<button :class="{ danger: isDeleting }">
2    Submit
3</button>

Component Methods

In addition to public variables being available to your component template, any public methods on the component may be invoked. For example, imagine a component that has an isSelected method:

 1/**
 2 * Determine if the given option is the currently selected option.
 3 *
 4 * @param  string  $option
 5 * @return bool
 6 */
 7public function isSelected($option)
 8{
 9    return $option === $this->selected;
10}
 1/**
 2 * Determine if the given option is the currently selected option.
 3 *
 4 * @param  string  $option
 5 * @return bool
 6 */
 7public function isSelected($option)
 8{
 9    return $option === $this->selected;
10}

You may execute this method from your component template by invoking the variable matching the name of the method:

1<option {{ $isSelected($value) ? 'selected="selected"' : '' }} value="{{ $value }}">
2    {{ $label }}
3</option>
1<option {{ $isSelected($value) ? 'selected="selected"' : '' }} value="{{ $value }}">
2    {{ $label }}
3</option>

Accessing Attributes & Slots Within Component Classes

Blade components also allow you to access the component name, attributes, and slot inside the class's render method. However, in order to access this data, you should return a closure from your component's render method. The closure will receive a $data array as its only argument. This array will contain several elements that provide information about the component:

 1/**
 2 * Get the view / contents that represent the component.
 3 *
 4 * @return \Illuminate\View\View|\Closure|string
 5 */
 6public function render()
 7{
 8    return function (array $data) {
 9        // $data['componentName'];
10        // $data['attributes'];
11        // $data['slot'];
12 
13        return '<div>Components content</div>';
14    };
15}
 1/**
 2 * Get the view / contents that represent the component.
 3 *
 4 * @return \Illuminate\View\View|\Closure|string
 5 */
 6public function render()
 7{
 8    return function (array $data) {
 9        // $data['componentName'];
10        // $data['attributes'];
11        // $data['slot'];
12 
13        return '<div>Components content</div>';
14    };
15}

The componentName is equal to the name used in the HTML tag after the x- prefix. So <x-alert />'s componentName will be alert. The attributes element will contain all of the attributes that were present on the HTML tag. The slot element is an Illuminate\Support\HtmlString instance with the contents of the component's slot.

The closure should return a string. If the returned string corresponds to an existing view, that view will be rendered; otherwise, the returned string will be evaluated as an inline Blade view.

Additional Dependencies

If your component requires dependencies from Laravel's service container, you may list them before any of the component's data attributes and they will automatically be injected by the container:

 1use App\Services\AlertCreator
 2 
 3/**
 4 * Create the component instance.
 5 *
 6 * @param  \App\Services\AlertCreator  $creator
 7 * @param  string  $type
 8 * @param  string  $message
 9 * @return void
10 */
11public function __construct(AlertCreator $creator, $type, $message)
12{
13    $this->creator = $creator;
14    $this->type = $type;
15    $this->message = $message;
16}
 1use App\Services\AlertCreator
 2 
 3/**
 4 * Create the component instance.
 5 *
 6 * @param  \App\Services\AlertCreator  $creator
 7 * @param  string  $type
 8 * @param  string  $message
 9 * @return void
10 */
11public function __construct(AlertCreator $creator, $type, $message)
12{
13    $this->creator = $creator;
14    $this->type = $type;
15    $this->message = $message;
16}

Hiding Attributes / Methods

If you would like to prevent some public methods or properties from being exposed as variables to your component template, you may add them to an $except array property on your component:

 1<?php
 2 
 3namespace App\View\Components;
 4 
 5use Illuminate\View\Component;
 6 
 7class Alert extends Component
 8{
 9    /**
10     * The alert type.
11     *
12     * @var string
13     */
14    public $type;
15 
16    /**
17     * The properties / methods that should not be exposed to the component template.
18     *
19     * @var array
20     */
21    protected $except = ['type'];
22}
 1<?php
 2 
 3namespace App\View\Components;
 4 
 5use Illuminate\View\Component;
 6 
 7class Alert extends Component
 8{
 9    /**
10     * The alert type.
11     *
12     * @var string
13     */
14    public $type;
15 
16    /**
17     * The properties / methods that should not be exposed to the component template.
18     *
19     * @var array
20     */
21    protected $except = ['type'];
22}

Component Attributes

We've already examined how to pass data attributes to a component; however, sometimes you may need to specify additional HTML attributes, such as class, that are not part of the data required for a component to function. Typically, you want to pass these additional attributes down to the root element of the component template. For example, imagine we want to render an alert component like so:

1<x-alert type="error" :message="$message" class="mt-4"/>
1<x-alert type="error" :message="$message" class="mt-4"/>

All of the attributes that are not part of the component's constructor will automatically be added to the component's "attribute bag". This attribute bag is automatically made available to the component via the $attributes variable. All of the attributes may be rendered within the component by echoing this variable:

1<div {{ $attributes }}>
2    <!-- Component content -->
3</div>
1<div {{ $attributes }}>
2    <!-- Component content -->
3</div>

Default / Merged Attributes

Sometimes you may need to specify default values for attributes or merge additional values into some of the component's attributes. To accomplish this, you may use the attribute bag's merge method. This method is particularly useful for defining a set of default CSS classes that should always be applied to a component:

1<div {{ $attributes->merge(['class' => 'alert alert-'.$type]) }}>
2    {{ $message }}
3</div>
1<div {{ $attributes->merge(['class' => 'alert alert-'.$type]) }}>
2    {{ $message }}
3</div>

If we assume this component is utilized like so:

1<x-alert type="error" :message="$message" class="mb-4"/>
1<x-alert type="error" :message="$message" class="mb-4"/>

The final, rendered HTML of the component will appear like the following:

1<div class="alert alert-error mb-4">
2    <!-- Contents of the $message variable -->
3</div>
1<div class="alert alert-error mb-4">
2    <!-- Contents of the $message variable -->
3</div>

Conditionally Merge Classes

Sometimes you may wish to merge classes if a given condition is true. You can accomplish this via the class method, which accepts an array of classes where the array key contains the class or classes you wish to add, while the value is a boolean expression. If the array element has a numeric key, it will always be included in the rendered class list:

1<div {{ $attributes->class(['p-4', 'bg-red' => $hasError]) }}>
2    {{ $message }}
3</div>
1<div {{ $attributes->class(['p-4', 'bg-red' => $hasError]) }}>
2    {{ $message }}
3</div>

If you need to merge other attributes onto your component, you can chain the merge method onto the class method:

1<button {{ $attributes->class(['p-4'])->merge(['type' => 'button']) }}>
2    {{ $slot }}
3</button>
1<button {{ $attributes->class(['p-4'])->merge(['type' => 'button']) }}>
2    {{ $slot }}
3</button>

Non-Class Attribute Merging

When merging attributes that are not class attributes, the values provided to the merge method will be considered the "default" values of the attribute. However, unlike the class attribute, these attributes will not be merged with injected attribute values. Instead, they will be overwritten. For example, a button component's implementation may look like the following:

1<button {{ $attributes->merge(['type' => 'button']) }}>
2    {{ $slot }}
3</button>
1<button {{ $attributes->merge(['type' => 'button']) }}>
2    {{ $slot }}
3</button>

To render the button component with a custom type, it may be specified when consuming the component. If no type is specified, the button type will be used:

1<x-button type="submit">
2    Submit
3</x-button>
1<x-button type="submit">
2    Submit
3</x-button>

The rendered HTML of the button component in this example would be:

1<button type="submit">
2    Submit
3</button>
1<button type="submit">
2    Submit
3</button>

If you would like an attribute other than class to have its default value and injected values joined together, you may use the prepends method. In this example, the data-controller attribute will always begin with profile-controller and any additional injected data-controller values will be placed after this default value:

1<div {{ $attributes->merge(['data-controller' => $attributes->prepends('profile-controller')]) }}>
2    {{ $slot }}
3</div>
1<div {{ $attributes->merge(['data-controller' => $attributes->prepends('profile-controller')]) }}>
2    {{ $slot }}
3</div>

Retrieving & Filtering Attributes

You may filter attributes using the filter method. This method accepts a closure which should return true if you wish to retain the attribute in the attribute bag:

1{{ $attributes->filter(fn ($value, $key) => $key == 'foo') }}
1{{ $attributes->filter(fn ($value, $key) => $key == 'foo') }}

For convenience, you may use the whereStartsWith method to retrieve all attributes whose keys begin with a given string:

1{{ $attributes->whereStartsWith('wire:model') }}
1{{ $attributes->whereStartsWith('wire:model') }}

Conversely, the whereDoesntStartWith method may be used to exclude all attributes whose keys begin with a given string:

1{{ $attributes->whereDoesntStartWith('wire:model') }}
1{{ $attributes->whereDoesntStartWith('wire:model') }}

Using the first method, you may render the first attribute in a given attribute bag:

1{{ $attributes->whereStartsWith('wire:model')->first() }}
1{{ $attributes->whereStartsWith('wire:model')->first() }}

If you would like to check if an attribute is present on the component, you may use the has method. This method accepts the attribute name as its only argument and returns a boolean indicating whether or not the attribute is present:

1@if ($attributes->has('class'))
2    <div>Class attribute is present</div>
3@endif
1@if ($attributes->has('class'))
2    <div>Class attribute is present</div>
3@endif

You may retrieve a specific attribute's value using the get method:

1{{ $attributes->get('class') }}
1{{ $attributes->get('class') }}

Reserved Keywords

By default, some keywords are reserved for Blade's internal use in order to render components. The following keywords cannot be defined as public properties or method names within your components:

Slots

You will often need to pass additional content to your component via "slots". Component slots are rendered by echoing the $slot variable. To explore this concept, let's imagine that an alert component has the following markup:

1<!-- /resources/views/components/alert.blade.php -->
2 
3<div class="alert alert-danger">
4    {{ $slot }}
5</div>
1<!-- /resources/views/components/alert.blade.php -->
2 
3<div class="alert alert-danger">
4    {{ $slot }}
5</div>

We may pass content to the slot by injecting content into the component:

1<x-alert>
2    <strong>Whoops!</strong> Something went wrong!
3</x-alert>
1<x-alert>
2    <strong>Whoops!</strong> Something went wrong!
3</x-alert>

Sometimes a component may need to render multiple different slots in different locations within the component. Let's modify our alert component to allow for the injection of a "title" slot:

1<!-- /resources/views/components/alert.blade.php -->
2 
3<span class="alert-title">{{ $title }}</span>
4 
5<div class="alert alert-danger">
6    {{ $slot }}
7</div>
1<!-- /resources/views/components/alert.blade.php -->
2 
3<span class="alert-title">{{ $title }}</span>
4 
5<div class="alert alert-danger">
6    {{ $slot }}
7</div>

You may define the content of the named slot using the x-slot tag. Any content not within an explicit x-slot tag will be passed to the component in the $slot variable:

1<x-alert>
2    <x-slot name="title">
3        Server Error
4    </x-slot>
5 
6    <strong>Whoops!</strong> Something went wrong!
7</x-alert>
1<x-alert>
2    <x-slot name="title">
3        Server Error
4    </x-slot>
5 
6    <strong>Whoops!</strong> Something went wrong!
7</x-alert>

Scoped Slots

If you have used a JavaScript framework such as Vue, you may be familiar with "scoped slots", which allow you to access data or methods from the component within your slot. You may achieve similar behavior in Laravel by defining public methods or properties on your component and accessing the component within your slot via the $component variable. In this example, we will assume that the x-alert component has a public formatAlert method defined on its component class:

1<x-alert>
2    <x-slot name="title">
3        {{ $component->formatAlert('Server Error') }}
4    </x-slot>
5 
6    <strong>Whoops!</strong> Something went wrong!
7</x-alert>
1<x-alert>
2    <x-slot name="title">
3        {{ $component->formatAlert('Server Error') }}
4    </x-slot>
5 
6    <strong>Whoops!</strong> Something went wrong!
7</x-alert>

Slot Attributes

Like Blade components, you may assign additional attributes to slots such as CSS class names:

 1<x-card class="shadow-sm">
 2    <x-slot name="heading" class="font-bold">
 3        Heading
 4    </x-slot>
 5 
 6    Content
 7 
 8    <x-slot name="footer" class="text-sm">
 9        Footer
10    </x-slot>
11</x-card>
 1<x-card class="shadow-sm">
 2    <x-slot name="heading" class="font-bold">
 3        Heading
 4    </x-slot>
 5 
 6    Content
 7 
 8    <x-slot name="footer" class="text-sm">
 9        Footer
10    </x-slot>
11</x-card>

To interact with slot attributes, you may access the attributes property of the slot's variable. For more information on how to interact with attributes, please consult the documentation on component attributes:

 1@props([
 2    'heading',
 3    'footer',
 4])
 5 
 6<div {{ $attributes->class(['border']) }}>
 7    <h1 {{ $heading->attributes->class(['text-lg']) }}>
 8        {{ $heading }}
 9    </h1>
10 
11    {{ $slot }}
12 
13    <footer {{ $footer->attributes->class(['text-gray-700']) }}>
14        {{ $footer }}
15    </footer>
16</div>
 1@props([
 2    'heading',
 3    'footer',
 4])
 5 
 6<div {{ $attributes->class(['border']) }}>
 7    <h1 {{ $heading->attributes->class(['text-lg']) }}>
 8        {{ $heading }}
 9    </h1>
10 
11    {{ $slot }}
12 
13    <footer {{ $footer->attributes->class(['text-gray-700']) }}>
14        {{ $footer }}
15    </footer>
16</div>

Inline Component Views

For very small components, it may feel cumbersome to manage both the component class and the component's view template. For this reason, you may return the component's markup directly from the render method:

 1/**
 2 * Get the view / contents that represent the component.
 3 *
 4 * @return \Illuminate\View\View|\Closure|string
 5 */
 6public function render()
 7{
 8    return <<<'blade'
 9        <div class="alert alert-danger">
10            {{ $slot }}
11        </div>
12    blade;
13}
 1/**
 2 * Get the view / contents that represent the component.
 3 *
 4 * @return \Illuminate\View\View|\Closure|string
 5 */
 6public function render()
 7{
 8    return <<<'blade'
 9        <div class="alert alert-danger">
10            {{ $slot }}
11        </div>
12    blade;
13}

Generating Inline View Components

To create a component that renders an inline view, you may use the inline option when executing the make:component command:

1php artisan make:component Alert --inline
1php artisan make:component Alert --inline

Anonymous Components

Similar to inline components, anonymous components provide a mechanism for managing a component via a single file. However, anonymous components utilize a single view file and have no associated class. To define an anonymous component, you only need to place a Blade template within your resources/views/components directory. For example, assuming you have defined a component at resources/views/components/alert.blade.php, you may simply render it like so:

1<x-alert/>
1<x-alert/>

You may use the . character to indicate if a component is nested deeper inside the components directory. For example, assuming the component is defined at resources/views/components/inputs/button.blade.php, you may render it like so:

1<x-inputs.button/>
1<x-inputs.button/>

Anonymous Index Components

Sometimes, when a component is made up of many Blade templates, you may wish to group the given component's templates within a single directory. For example, imagine an "accordion" component with the following directory structure:

1/resources/views/components/accordion.blade.php
2/resources/views/components/accordion/item.blade.php
1/resources/views/components/accordion.blade.php
2/resources/views/components/accordion/item.blade.php

This directory structure allows you to render the accordion component and its item like so:

1<x-accordion>
2    <x-accordion.item>
3        ...
4    </x-accordion.item>
5</x-accordion>
1<x-accordion>
2    <x-accordion.item>
3        ...
4    </x-accordion.item>
5</x-accordion>

However, in order to render the accordion component via x-accordion, we were forced to place the "index" accordion component template in the resources/views/components directory instead of nesting it within the accordion directory with the other accordion related templates.

Thankfully, Blade allows you to place an index.blade.php file within a component's template directory. When an index.blade.php template exists for the component, it will be rendered as the "root" node of the component. So, we can continue to use the same Blade syntax given in the example above; however, we will adjust our directory structure like so:

1/resources/views/components/accordion/index.blade.php
2/resources/views/components/accordion/item.blade.php
1/resources/views/components/accordion/index.blade.php
2/resources/views/components/accordion/item.blade.php

Data Properties / Attributes

Since anonymous components do not have any associated class, you may wonder how you may differentiate which data should be passed to the component as variables and which attributes should be placed in the component's attribute bag.

You may specify which attributes should be considered data variables using the @props directive at the top of your component's Blade template. All other attributes on the component will be available via the component's attribute bag. If you wish to give a data variable a default value, you may specify the variable's name as the array key and the default value as the array value:

1<!-- /resources/views/components/alert.blade.php -->
2 
3@props(['type' => 'info', 'message'])
4 
5<div {{ $attributes->merge(['class' => 'alert alert-'.$type]) }}>
6    {{ $message }}
7</div>
1<!-- /resources/views/components/alert.blade.php -->
2 
3@props(['type' => 'info', 'message'])
4 
5<div {{ $attributes->merge(['class' => 'alert alert-'.$type]) }}>
6    {{ $message }}
7</div>

Given the component definition above, we may render the component like so:

1<x-alert type="error" :message="$message" class="mb-4"/>
1<x-alert type="error" :message="$message" class="mb-4"/>

Accessing Parent Data

Sometimes you may want to access data from a parent component inside a child component. In these cases, you may use the @aware directive. For example, imagine we are building a complex menu component consisting of a parent <x-menu> and child <x-menu.item>:

1<x-menu color="purple">
2    <x-menu.item>...</x-menu.item>
3    <x-menu.item>...</x-menu.item>
4</x-menu>
1<x-menu color="purple">
2    <x-menu.item>...</x-menu.item>
3    <x-menu.item>...</x-menu.item>
4</x-menu>

The <x-menu> component may have an implementation like the following:

1<!-- /resources/views/components/menu/index.blade.php -->
2 
3@props(['color' => 'gray'])
4 
5<ul {{ $attributes->merge(['class' => 'bg-'.$color.'-200']) }}>
6    {{ $slot }}
7</ul>
1<!-- /resources/views/components/menu/index.blade.php -->
2 
3@props(['color' => 'gray'])
4 
5<ul {{ $attributes->merge(['class' => 'bg-'.$color.'-200']) }}>
6    {{ $slot }}
7</ul>

Because the color prop was only passed into the parent (<x-menu>), it won't be available inside <x-menu.item>. However, if we use the @aware directive, we can make it available inside <x-menu.item> as well:

1<!-- /resources/views/components/menu/item.blade.php -->
2 
3@aware(['color' => 'gray'])
4 
5<li {{ $attributes->merge(['class' => 'text-'.$color.'-800']) }}>
6    {{ $slot }}
7</li>
1<!-- /resources/views/components/menu/item.blade.php -->
2 
3@aware(['color' => 'gray'])
4 
5<li {{ $attributes->merge(['class' => 'text-'.$color.'-800']) }}>
6    {{ $slot }}
7</li>

Dynamic Components

Sometimes you may need to render a component but not know which component should be rendered until runtime. In this situation, you may use Laravel's built-in dynamic-component component to render the component based on a runtime value or variable:

1<x-dynamic-component :component="$componentName" class="mt-4" />
1<x-dynamic-component :component="$componentName" class="mt-4" />

Manually Registering Components

When writing components for your own application, components are automatically discovered within the app/View/Components directory and resources/views/components directory.

However, if you are building a package that utilizes Blade components or placing components in non-conventional directories, you will need to manually register your component class and its HTML tag alias so that Laravel knows where to find the component. You should typically register your components in the boot method of your package's service provider:

 1use Illuminate\Support\Facades\Blade;
 2use VendorPackage\View\Components\AlertComponent;
 3 
 4/**
 5 * Bootstrap your package's services.
 6 *
 7 * @return void
 8 */
 9public function boot()
10{
11    Blade::component('package-alert', AlertComponent::class);
12}
 1use Illuminate\Support\Facades\Blade;
 2use VendorPackage\View\Components\AlertComponent;
 3 
 4/**
 5 * Bootstrap your package's services.
 6 *
 7 * @return void
 8 */
 9public function boot()
10{
11    Blade::component('package-alert', AlertComponent::class);
12}

Once your component has been registered, it may be rendered using its tag alias:

1<x-package-alert/>
1<x-package-alert/>

Autoloading Package Components

Alternatively, you may use the componentNamespace method to autoload component classes by convention. For example, a Nightshade package might have Calendar and ColorPicker components that reside within the Package\Views\Components namespace:

 1use Illuminate\Support\Facades\Blade;
 2 
 3/**
 4 * Bootstrap your package's services.
 5 *
 6 * @return void
 7 */
 8public function boot()
 9{
10    Blade::componentNamespace('Nightshade\\Views\\Components', 'nightshade');
11}
 1use Illuminate\Support\Facades\Blade;
 2 
 3/**
 4 * Bootstrap your package's services.
 5 *
 6 * @return void
 7 */
 8public function boot()
 9{
10    Blade::componentNamespace('Nightshade\\Views\\Components', 'nightshade');
11}

This will allow the usage of package components by their vendor namespace using the package-name:: syntax:

1<x-nightshade::calendar />
2<x-nightshade::color-picker />
1<x-nightshade::calendar />
2<x-nightshade::color-picker />

Blade will automatically detect the class that's linked to this component by pascal-casing the component name. Subdirectories are also supported using "dot" notation.

Building Layouts

Layouts Using Components

Most web applications maintain the same general layout across various pages. It would be incredibly cumbersome and hard to maintain our application if we had to repeat the entire layout HTML in every view we create. Thankfully, it's convenient to define this layout as a single Blade component and then use it throughout our application.

Defining The Layout Component

For example, imagine we are building a "todo" list application. We might define a layout component that looks like the following:

 1<!-- resources/views/components/layout.blade.php -->
 2 
 3<html>
 4    <head>
 5        <title>{{ $title ?? 'Todo Manager' }}</title>
 6    </head>
 7    <body>
 8        <h1>Todos</h1>
 9        <hr/>
10        {{ $slot }}
11    </body>
12</html>
 1<!-- resources/views/components/layout.blade.php -->
 2 
 3<html>
 4    <head>
 5        <title>{{ $title ?? 'Todo Manager' }}</title>
 6    </head>
 7    <body>
 8        <h1>Todos</h1>
 9        <hr/>
10        {{ $slot }}
11    </body>
12</html>

Applying The Layout Component

Once the layout component has been defined, we may create a Blade view that utilizes the component. In this example, we will define a simple view that displays our task list:

1<!-- resources/views/tasks.blade.php -->
2 
3<x-layout>
4    @foreach ($tasks as $task)
5        {{ $task }}
6    @endforeach
7</x-layout>
1<!-- resources/views/tasks.blade.php -->
2 
3<x-layout>
4    @foreach ($tasks as $task)
5        {{ $task }}
6    @endforeach
7</x-layout>

Remember, content that is injected into a component will be supplied to the default $slot variable within our layout component. As you may have noticed, our layout also respects a $title slot if one is provided; otherwise, a default title is shown. We may inject a custom title from our task list view using the standard slot syntax discussed in the component documentation:

 1<!-- resources/views/tasks.blade.php -->
 2 
 3<x-layout>
 4    <x-slot name="title">
 5        Custom Title
 6    </x-slot>
 7 
 8    @foreach ($tasks as $task)
 9        {{ $task }}
10    @endforeach
11</x-layout>
 1<!-- resources/views/tasks.blade.php -->
 2 
 3<x-layout>
 4    <x-slot name="title">
 5        Custom Title
 6    </x-slot>
 7 
 8    @foreach ($tasks as $task)
 9        {{ $task }}
10    @endforeach
11</x-layout>

Now that we have defined our layout and task list views, we just need to return the task view from a route:

1use App\Models\Task;
2 
3Route::get('/tasks', function () {
4    return view('tasks', ['tasks' => Task::all()]);
5});
1use App\Models\Task;
2 
3Route::get('/tasks', function () {
4    return view('tasks', ['tasks' => Task::all()]);
5});

Layouts Using Template Inheritance

Defining A Layout

Layouts may also be created via "template inheritance". This was the primary way of building applications prior to the introduction of components.

To get started, let's take a look at a simple example. First, we will examine a page layout. Since most web applications maintain the same general layout across various pages, it's convenient to define this layout as a single Blade view:

 1<!-- resources/views/layouts/app.blade.php -->
 2 
 3<html>
 4    <head>
 5        <title>App Name - @yield('title')</title>
 6    </head>
 7    <body>
 8        @section('sidebar')
 9            This is the master sidebar.
10        @show
11 
12        <div class="container">
13            @yield('content')
14        </div>
15    </body>
16</html>
 1<!-- resources/views/layouts/app.blade.php -->
 2 
 3<html>
 4    <head>
 5        <title>App Name - @yield('title')</title>
 6    </head>
 7    <body>
 8        @section('sidebar')
 9            This is the master sidebar.
10        @show
11 
12        <div class="container">
13            @yield('content')
14        </div>
15    </body>
16</html>

As you can see, this file contains typical HTML mark-up. However, take note of the @section and @yield directives. The @section directive, as the name implies, defines a section of content, while the @yield directive is used to display the contents of a given section.

Now that we have defined a layout for our application, let's define a child page that inherits the layout.

Extending A Layout

When defining a child view, use the @extends Blade directive to specify which layout the child view should "inherit". Views which extend a Blade layout may inject content into the layout's sections using @section directives. Remember, as seen in the example above, the contents of these sections will be displayed in the layout using @yield:

 1<!-- resources/views/child.blade.php -->
 2 
 3@extends('layouts.app')
 4 
 5@section('title', 'Page Title')
 6 
 7@section('sidebar')
 8    @parent
 9 
10    <p>This is appended to the master sidebar.</p>
11@endsection
12 
13@section('content')
14    <p>This is my body content.</p>
15@endsection
 1<!-- resources/views/child.blade.php -->
 2 
 3@extends('layouts.app')
 4 
 5@section('title', 'Page Title')
 6 
 7@section('sidebar')
 8    @parent
 9 
10    <p>This is appended to the master sidebar.</p>
11@endsection
12 
13@section('content')
14    <p>This is my body content.</p>
15@endsection