Statamic Livewire

A third-party Laravel Livewire integration for Statamic.

It's as easy as it get's to get stared with Livewire if using Statamic 3.

Installation

Pull in your package with composer

composer require jonassiewertsen/statamic-livewire

General documentation

Laravel Livewire Docs

How to be used with the Antlers template engine

Include the JavaScript (on every page that will be using Livewire).

...
    {{ livewire:styles }}
</head>
<body>

    ...
    {{ livewire:scripts }}
</body>
</html>

Include components with Antlers

You can create Livewire components as described in the general documentation. To include your Livewire component:

<html>
<head>
    ...
    {{ livewire:styles }}
</head>
<body>
    {{ livewire:your-component-name }}

    ...

    {{ livewire:scripts }}
</body>
</html>

Blade or Antlers? Both!

If creating a Livewire component, you need to render a template file

namespace App\Http\Livewire;

use Livewire\Component;

class Counter extends Component
{
    public function render()
    {
        return view('livewire.counter');
    }
}

More Information: (https://laravel-livewire.com/docs/quickstart#create-a-component)

Normally your template file would be a blade file, named counter.blade.php. Great, but what about Antlers? Rename your template to counter.antlers.html, use Antlers syntax and do wathever you like. No need to change anything inside your component Controller. How cool is that?

Passing Initial Parameters

You can pass data into a component by passing additional parameters

{{ livewire:your-component-name contact="contact" }}

To intercept with those parameters, mount them and store the data as public properties.

use Livewire\Component;

class ShowContact extends Component
{
    public $name;
    public $email;

    public function mount($contact)
    {
        $this->name = $contact->name;
        $this->email = $contact->email;
    }

    ...
}

The Official Livewire documentation

Paginating Data

You can paginate results by using the WithPagination trait.

Blade

To use pagination with Blade, please use the Livewire\WithPagination namespace for your trait as described in the Livewire docs.

Antlers

Pagination with Antlers does work similar. Make sure to use the Jonassiewertsen\Livewire\WithPagination namespace for your trait if working with Antlers.

In your Livewire component view:

{{ entries }}
    ...
{{ /entries }}

{{ links }}

use Jonassiewertsen\Livewire\WithPagination;

class ShowArticles extends Component
{
    use WithPagination;

    protected function entries()
    {
        $entries = Entry::query()
            ->where('collection', 'articles')
            ->paginate(3);

        return $this->withPagination('entries', $entries);
    }

    public function render()
    {
        return view('livewire.blog-entries', $this->entries());
    }
}

Entangle: Sharing State Between Livewire And Alpine

In case you want to share state between Livewire and Alpine, there is a Blade directive called @entangle: Livewire docs

To be usable with Antlers, we do provide an dedicated Tag:

<!-- With Antlers -->
<div x-data="{ open: {{ livewire:entangle property='showDropdown' }} }">
        
<!-- With Blade -->
<div x-data="{ open: @entangle('showDropdown').defer }">

Credits

Thanks to:

Caleb and the community for building Livewire
Austenc for the Statamic marketplace preview image

Requirements

PHP 7.4 or 8.0
Laravel 7 or 8
Statamic 3

Support

I love to share with the community. Nevertheless, it does take a lot of work, time and effort.

Sponsor me on GitHub to support my work and the support for this addon.

License

This plugin is published under the MIT license. Feel free to use it and remember to spread love.

leganz/statamic-livewire