Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonassiewertsen/statamic-livewire
A Laravel Livewire integration for Statamics antlers engine
https://github.com/jonassiewertsen/statamic-livewire
Last synced: 3 days ago
JSON representation
A Laravel Livewire integration for Statamics antlers engine
- Host: GitHub
- URL: https://github.com/jonassiewertsen/statamic-livewire
- Owner: jonassiewertsen
- Created: 2020-05-25T20:02:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-01T13:00:27.000Z (4 months ago)
- Last Synced: 2025-01-05T14:08:12.745Z (10 days ago)
- Language: PHP
- Homepage:
- Size: 120 KB
- Stars: 92
- Watchers: 4
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-livewire - Statamic Livewire
README
# Statamic Livewire
[](https://packagist.org/packages/jonassiewertsen/statamic-livewire)
## Wanna learn Statamic?
Visit my newest project Statamictutorials.com. Many tutorials are free.
[
](https://statamictutorials.com)
## Description
A third-party [Laravel Livewire](https://laravel-livewire.com/) integration for Statamic.
It's as easy as it gets to get started with Livewire if using Statamic.
## Installation
Pull in the Livewire package with composer
```bash
composer require jonassiewertsen/statamic-livewire
```
### Manually including Livewire's frontend assets
By default, Livewire injects the JavaScript and CSS assets it needs into each page that includes a Livewire component. If you want more control over this behavior, you can [manually include the assets](https://livewire.laravel.com/docs/installation#manually-including-livewires-frontend-assets) on a page using the following Antlers tags or Blade directives:
```html
{{ livewire:styles }}
@livewireStyles
...
{{ livewire:scripts }}
@livewireScripts
```
### Manually bundling Livewire and Alpine
If you need to include some custom Alpine plugins, you need to [manually bundle the Livewire and Alpine assets](https://livewire.laravel.com/docs/installation#manually-bundling-livewire-and-alpine) and disable the automatic injection by using the following Antlers tag or Blade directive. Do not forget to include the Livewire styles as well.
```html
{{ livewire:styles }}
@livewireStyles
...
{{ livewire:scriptConfig }}
@livewireScriptConfig
```
### Static caching
This addon adds an `AssetsReplacer` class to make Livewire compatible with half and full static caching. You may customize the replacers in the config of this addon:
```php
'replacers' => [
\Jonassiewertsen\Livewire\Replacers\AssetsReplacer::class,
],
```
If you are using full measure static caching and you're manually bundling Livewire and Alpine as per the instructions above, you need to make sure to only start Livewire once the CSRF token has been replaced.
```js
if (window.livewireScriptConfig?.csrf === 'STATAMIC_CSRF_TOKEN') {
document.addEventListener('statamic:nocache.replaced', () => Livewire.start());
} else {
Livewire.start();
}
```
## Upgrade
Make sure to read the Livewire upgrade guide, in case you're updating to `Statamic Livewire` 3, as there are breaking changes:
https://livewire.laravel.com/docs/upgrading
## General documentation
[Livewire Docs](https://livewire.laravel.com/docs/quickstart)
### Include components
You can create Livewire components as described in the [general documentation](https://livewire.laravel.com/docs/components).
To include your Livewire component:
```html
{{ livewire:your-component-name }}
```
if you want to include a component from a dynamic variable you can use the `livewire:component` tag:
```html
{{ livewire:component :name="variable" }}
```
### @script and @assets
Antlers versions of [@script](https://livewire.laravel.com/docs/javascript#executing-scripts) and [@assets](https://livewire.laravel.com/docs/javascript#loading-assets) are provided:
```html
{{ livewire:script }}
console.log('hello')
{{ /livewire:script }}
```
```html
{{ livewire:assets }}
{{ /livewire:assets }}
```
### Blade or Antlers? Both!
If creating a Livewire component, you need to render a template file
```php
namespace App\Http\Livewire;
use Livewire\Component;
class Counter extends Component
{
public function render()
{
return view('livewire.counter');
}
}
```
More Information: (https://livewire.laravel.com/docs/components)
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 whatever 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
```html
{{ livewire:your-component-name :contact="contact" }}
```
To intercept with those parameters, mount them and store the data as public properties.
```php
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](https://livewire.laravel.com/docs/components#rendering-components) provides more information.
### Keying Components
Livewire components are automatically keyed by default. If you want to manually key a component, you can use the `key` attribute.
```html
{{ contacts }}
{{ livewire:your-component-name :key="id" }}
{{ /contacts }}
@foreach ($contacts as $contact)
@endforeach
```
The [Official Livewire documentation](https://livewire.laravel.com/docs/components#adding-wirekey-to-foreach-loops) provides more information.
### Multi-Site
When using Livewire in a Multi-Site context, the current site gets lost between requests. There is a trait (`\Jonassiewertsen\Livewire\RestoreCurrentSite`) to solve that. Just include it in your component and use `Site::current()` as you normally do.
```php
class ShowArticles extends Component
{
use \Jonassiewertsen\Livewire\RestoreCurrentSite;
protected function entries()
{
return Entry::query()
->where('collection', 'articles')
->where('site', Site::current())
->get();
}
public function render()
{
return view('livewire.blog-entries', $this->entries());
}
}
```
### 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](https://livewire.laravel.com/docs/pagination#basic-usage).
### 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:
```html
{{ entries }}
...
{{ /entries }}
{{ links }}
```
```php
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());
}
}
```
### EXPERIMENTAL: Statamic Support
As a little experiment, support for an Entry or EntryCollection has been added, so you can make an entry or a entry collection simply a public property and it just works.
Supported types:
- Statamic\Entries\EntryCollection;
- Statamic\Entries\Entry;
```php
namespace App\Livewire;
use Livewire\Component;
use Statamic\Entries\EntryCollection;
use Statamic\Entries\Entry;
class Foo extends Component
{
public EntryCollection $entries;
public Entry $entry;
// normal livewire stuff
}
```
To make it work, you need to enable that feature first.
1. php artisan vendor:publish
2. Select statamic-livewire in the list
3. Enable synthesizers
### 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`. To be usable with Antlers, we do provide a dedicated tag:
```html
```
It's worth mentioning that, since Livewire v3 now builds on top of Alpine, the `@entangle` directive is not documented anymore. Instead, it's possible to entangle the data via [the `$wire` object](https://livewire.laravel.com/docs/javascript#the-wire-object).
```html
```
### This: Accessing the Livewire component
You can access and perform actions on the Livewire component like this:
```html
document.addEventListener('livewire:initialized', function () {
// With Antlers
{{ livewire:this set="('name', 'Jack')" }}
// With Blade
@this.set('name', 'Jack')
})
```
It's worth mentioning that, since Livewire v3 now builds on top of Alpine, the `@this` directive is not used widely anymore. Instead, it's possible to [access and manipulate the state directly via JavaScript](https://livewire.laravel.com/docs/properties#accessing-properties-from-javascript) / [the `$wire` object](https://livewire.laravel.com/docs/javascript#the-wire-object).
```html
document.addEventListener('livewire:initialized', function () {
// `{{ livewire:this }}` returns the instance of the current component
{{ livewire:this }}.set('name', 'Jack')
})
```
### Lazy Components
Livewire allows you to [lazy load components](https://livewire.laravel.com/docs/lazy) that would otherwise slow down the initial page load. For this you can simply pass `lazy="true"` as argument to your component tag.
```html
{{ livewire:your-component-name :contact="contact" lazy="true" }}
```
## Other Statamic Livewire Packages
If using Livewire, those packages might be interesting for you as well:
- [Statamic live search](https://github.com/jonassiewertsen/statamic-live-search)
- [Statamic Livewire Forms](https://github.com/aerni/statamic-livewire-forms)
- [Antlers Components](https://github.com/Stillat/antlers-components)
Did I miss a link? Let me know!
## Credits
Thanks to:
- [Marco Rieser](https://github.com/marcorieser) to help maintaining this package
- [Caleb](https://github.com/calebporzio) and the community for building [Livewire](https://laravel-livewire.com/)
- [Austenc](https://github.com/austenc) for the Statamic marketplace preview image
## Requirements
- PHP 8.1
- Laravel 10 or 11
- Statamic 4 or 5
# Support
I love to share with the community. Nevertheless, it does take a lot of work, time and effort.
[Sponsor me on GitHub](https://github.com/sponsors/jonassiewertsen/) 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.