Livewire 2.x リファレンス

すでにLivewireに精通しており、長いドキュメントは不要ですか？では、Livewireで利用可能なすべてを網羅した巨大なリストをご覧ください。

テンプレートディレクティブ

これらは、Livewireコンポーネントテンプレート内の要素に追加されるディレクティブです。

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

Alpineコンポーネントオブジェクト($wire)

これらは、Livewireテンプレート内のAlpineコンポーネントに提供される$wireオブジェクトで使用可能なメソッドとプロパティです。完全なドキュメントを参照してください。

<div x-data>
    <span x-show="$wire.showMessage">...</span>

    <button x-on:click="$wire.toggleShowMessage()">...</button>
</div>

グローバルなLivewire JavaScriptオブジェクト

以下はフロントエンドのwindow.Livewireオブジェクトで使用可能なメソッドです。これらは、Livewireと深く相互に関わり、カスタマイズするためのものです。

JavaScriptフック

以下はJavaScriptでリッスンできる「フック」です。これらを使用すると、LivewireコンポーネントのJavaScriptライフサイクルの特定の部分にフックして、サードパーティのパッケージや詳細なカスタマイズを行うことができます。ここでもたらされる能力は計り知れません。Livewireコアの重要な部分は、これらのフックを使用して機能を提供しています。

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

コンポーネントクラスのライフサイクルフック

これらは、バックエンドのライフサイクルの特定の時点で、コードを実行するためにLivewireコンポーネントクラスで宣言できるメソッドです。完全なドキュメントを読む

class ShowPost extends Component
{
    public function mount()
    {
        //
    }
}

コンポーネントクラスのprotectedプロパティ

Livewireは、コンポーネントのクラスでprotectedなプロパティを通じてコア機能を提供しています。これらのほとんどは、プロパティとして宣言するのではなく、メソッドで値を返すのを好む場合にそなえ、同じ名前の対応するメソッドがあります。

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

コンポーネントクラスのトレイト

以下は、Livewireコンポーネントの追加機能を解除するトレイトです。通常、「オプトイン」として最適と思われる機能です。

class ShowPost extends Component
{
    use WithPagination;
}

クラスメソッド

class PostForm extends Component
{
    public function save()
    {
        ...

        $this->emit('post-saved');
    }
}

PHPテストメソッド

以下はLivewireのテストヘルパーで利用できるメソッドです。 完全なドキュメントを読む

public function test()
{
    Livewire::test(ShowPost::class)
        ->assertDontSee('bar')
        ->set('foo', 'bar')
        ->assertSee('bar');
}

また、特定のページでコンポーネントの存在をチェックする、Laravelのレスポンステストヘルパーも使用できます。

Artisanコマンド

コンポーネントの作成などの頻繁なタスクを簡単にするためにLivewireで利用できる"Artisan"コマンドです。

PHPライフサイクルのフック

以下は、（コンポーネントレベルではなく）グローバルレベルでライフサイクルの発生をPHPの中でリッスンするためにLivewireが提供するフックです。これらは、Livewireのコア機能の重要な部分を提供するために内部的に使用されており、皆さんがLivewireを拡張するためにServiceProvidersで使用できます。

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