Reference

• Template Directives
• Alpine Component Object ($wire)
• Global Livewire JavaScript Object
• JavaScript Hooks
• Component Class Lifecycle Hooks
• Component Class Protected Properties
• Component Class Traits
• Class Methods
• PHP Testing Methods
• Artisan Commands
• PHP Lifecycle Hooks

Already familiar with Livewire and want to skip the long-form documentation? Here's a giant list of everything available in Livewire.

Template Directives

These are directives added to elements within Livewire component templates.

        
1<button wire:click="save">...</button>    

Alpine Component Object ($wire)

These are methods and properties available on the $wire object provided to Alpine components within a Livewire template. Read Full Documentation

        
1<div x-data>
2    <span x-show="$wire.showMessage">...</span>
3 
4    <button x-on:click="$wire.toggleShowMessage()">...</button>
5</div>    

Global Livewire JavaScript Object

These are methods available on the window.Livewire object in the frontend. These are for deeper Livewire interaction and customization.

JavaScript Hooks

These are "hooks" you can listen for in JavaScript. These allow you to hook into very specific parts of a Livewire component's JavaScript lifecycle for third-party packages or deep customizations. The abilities unlocked here are immense. A significant portion of Livewire's core uses these hooks to provide functionality.

        
1Livewire.hook('component.initialized', component => {
2    //
3})    

Component Class Lifecycle Hooks

These are methods you can declare in your Livewire component classes to run code at specific times in the backend's lifecycle. Read Full Documentation

        
1class ShowPost extends Component
2{
3    public function mount()
4    {
5        //
6    }
7}    

Component Class Protected Properties

Livewire provides core functionality through protected properties on a component's class. Most of these have corresponding methods by the same name if you prefer to return values in a method, rather than declare them as properties.

        
1class ShowPost extends Component
2{
3    protected $rules = ['foo' => 'required|min:6'];
4}    

Component Class Traits

These are traits that unlock additional functionality in a Livewire component. Usually for features that are considered best as "opt-in".

        
1class ShowPost extends Component
2{
3    use WithPagination;
4}    

Class Methods

        
1class PostForm extends Component
2{
3    public function save()
4    {
5        ...
6 
7        $this->emit('post-saved');
8    }
9}    

PHP Testing Methods

These are methods available on Livewire's testing helpers. Read Full Documentation

        
1public function test()
2{
3    Livewire::test(ShowPost::class)
4        ->assertDontSee('bar')
5        ->set('foo', 'bar')
6        ->assertSee('bar');
7}    

There are also Laravel testing response helpers available to check the presence of a component on a given page.

Artisan Commands

These are the artisan commands Livewire makes available to make frequent tasks like creating a component easier.

PHP Lifecycle Hooks

These are hooks provided by Livewire in PHP for listening to lifecycle occurences at a global level (not at a component level). These are used internally to provide a significant portion of Livewire's core functionality, and can be used in ServiceProviders to further extend Livewire yourself.

        
1Livewire::listen('component.hydrate', function ($component, $request) {
2    //
3});