Livewire Development
Documentation
Use search-docs for detailed Livewire 4 patterns and documentation.
Basic Usage
Creating Components
# Single-file component (default in v4)
php artisan make:livewire create-post
# Multi-file component
php artisan make:livewire create-post --mfc
# Class-based component (v3 style)
php artisan make:livewire create-post --class
# With namespace
php artisan make:livewire Posts/CreatePost
Converting Between Formats
Use php artisan livewire:convert create-post to convert between single-file, multi-file, and class-based formats.
Choosing a Component Format
Before creating a component, check config/livewire.php for directory overrides, which change where files are stored. Then, look at existing files in those directories (defaulting to app/Livewire/ and resources/views/livewire/) to match the established convention.
Component Format Reference
| Format |
Flag |
Class Path |
View Path |
| Single-file (SFC) |
default |
— |
resources/views/livewire/create-post.blade.php (PHP + Blade in one file) |
| Multi-file (MFC) |
--mfc |
app/Livewire/CreatePost.php |
resources/views/livewire/create-post.blade.php |
| Class-based |
--class |
app/Livewire/CreatePost.php |
resources/views/livewire/create-post.blade.php |
| View-based |
⚡ prefix |
— |
resources/views/livewire/create-post.blade.php (Blade-only with functional state) |
Namespaced components map to subdirectories: make:livewire Posts/CreatePost creates files at app/Livewire/Posts/CreatePost.php and resources/views/livewire/posts/create-post.blade.php.
Single-File Component Example
<?php
use Livewire\Component;
new class extends Component {
public int $count = 0;
public function increment(): void
{
$this->count++;
}
}
?>
<div>
<button wire:click="increment">Count: @{{ $count }}</button>
</div>
Livewire 4 Specifics
Key Changes From Livewire 3
These things changed in Livewire 4, but may not have been updated in this application. Verify this application's setup to ensure you follow existing conventions.
- Use
Route::livewire() for full-page components (e.g., Route::livewire('/posts/create', CreatePost::class)); config keys renamed: layout → component_layout, lazy_placeholder → component_placeholder.
wire:model now ignores child events by default (use wire:model.deep for old behavior); wire:scroll renamed to wire:navigate:scroll.
- Component tags must be properly closed;
wire:transition now uses View Transitions API (modifiers removed).
- JavaScript:
$wire.$js('name', fn) → $wire.$js.name = fn; commit/request hooks → interceptMessage()/interceptRequest().
New Features
- Component formats: single-file (SFC), multi-file (MFC), view-based components.
- Islands (
@island) for isolated updates; async actions (wire:click.async, #[Async]) for parallel execution.
- Deferred/bundled loading:
defer, lazy.bundle for optimized component loading.
| Feature |
Usage |
Purpose |
| Islands |
@island(name: 'stats') |
Isolated update regions |
| Async |
wire:click.async or #[Async] |
Non-blocking actions |
| Deferred |
defer attribute |
Load after page render |
| Bundled |
lazy.bundle |
Load multiple together |
New Directives
wire:sort, wire:intersect, wire:ref, .renderless, .preserve-scroll are available for use.
data-loading attribute automatically added to elements triggering network requests.
| Directive |
Purpose |
wire:sort |
Drag-and-drop sorting |
wire:intersect |
Viewport intersection detection |
wire:ref |
Element references for JS |
.renderless |
Component without rendering |
.preserve-scroll |
Preserve scroll position |
Best Practices
- Always use
wire:key in loops
- Use
wire:loading for loading states
- Use
wire:model.live for instant updates (default is debounced)
- Validate and authorize in actions (treat like HTTP requests)
Configuration
smart_wire_keys defaults to true; new configs: component_locations, component_namespaces, make_command, csp_safe.
Alpine & JavaScript
wire:transition uses browser View Transitions API; $errors and $intercept magic properties available.
- Non-blocking
wire:poll and parallel wire:model.live updates improve performance.
For interceptors and hooks, see reference/javascript-hooks.md.
Testing
Livewire::test(Counter::class)
->assertSet('count', 0)
->call('increment')
->assertSet('count', 1);
Verification
- Browser console: Check for JS errors
- Network tab: Verify Livewire requests return 200
- Ensure
wire:key on all @foreach loops
Common Pitfalls
- Missing
wire:key in loops → unexpected re-rendering
- Expecting
wire:model real-time → use wire:model.live
- Unclosed component tags → syntax errors in v4
- Using deprecated config keys or JS hooks
- Including Alpine.js separately (already bundled in Livewire 4)
1---2name: livewire-development3description: Use for any task or question involving Livewire. Activate if user mentions Livewire, wire: directives, or Livewire-specific concepts like wire:model, wire:click, wire:sort, or islands, invoke this skill. Covers building new components, debugging reactivity issues, real-time form validation, drag-and-drop, loading states, migrating from Livewire 3 to 4, converting component formats (SFC/MFC/class-based), and performance optimization. Do not use for non-Livewire reactive UI (React, Vue, Alpine-only, Inertia.js) or standard Laravel forms without Livewire.4license: MIT5---67# Livewire Development89## Documentation1011Use `search-docs` for detailed Livewire 4 patterns and documentation.1213## Basic Usage1415### Creating Components1617```bash1819# Single-file component (default in v4)2021php artisan make:livewire create-post2223# Multi-file component2425php artisan make:livewire create-post --mfc2627# Class-based component (v3 style)2829php artisan make:livewire create-post --class3031# With namespace3233php artisan make:livewire Posts/CreatePost34```3536### Converting Between Formats3738Use `php artisan livewire:convert create-post` to convert between single-file, multi-file, and class-based formats.3940### Choosing a Component Format4142Before creating a component, check `config/livewire.php` for directory overrides, which change where files are stored. Then, look at existing files in those directories (defaulting to `app/Livewire/` and `resources/views/livewire/`) to match the established convention.4344### Component Format Reference4546| Format | Flag | Class Path | View Path |47|--------|------|------------|-----------|48| Single-file (SFC) | default | — | `resources/views/livewire/create-post.blade.php` (PHP + Blade in one file) |49| Multi-file (MFC) | `--mfc` | `app/Livewire/CreatePost.php` | `resources/views/livewire/create-post.blade.php` |50| Class-based | `--class` | `app/Livewire/CreatePost.php` | `resources/views/livewire/create-post.blade.php` |51| View-based | ⚡ prefix | — | `resources/views/livewire/create-post.blade.php` (Blade-only with functional state) |5253Namespaced components map to subdirectories: `make:livewire Posts/CreatePost` creates files at `app/Livewire/Posts/CreatePost.php` and `resources/views/livewire/posts/create-post.blade.php`.5455### Single-File Component Example5657<!-- Single-File Component Example -->58```php59<?php60use Livewire\Component;6162new class extends Component {63 public int $count = 0;6465 public function increment(): void66 {67 $this->count++;68 }69}70?>7172<div>73 <button wire:click="increment">Count: @{{ $count }}</button>74</div>75```7677## Livewire 4 Specifics7879### Key Changes From Livewire 38081These things changed in Livewire 4, but may not have been updated in this application. Verify this application's setup to ensure you follow existing conventions.8283- Use `Route::livewire()` for full-page components (e.g., `Route::livewire('/posts/create', CreatePost::class)`); config keys renamed: `layout` → `component_layout`, `lazy_placeholder` → `component_placeholder`.84- `wire:model` now ignores child events by default (use `wire:model.deep` for old behavior); `wire:scroll` renamed to `wire:navigate:scroll`.85- Component tags must be properly closed; `wire:transition` now uses View Transitions API (modifiers removed).86- JavaScript: `$wire.$js('name', fn)` → `$wire.$js.name = fn`; `commit`/`request` hooks → `interceptMessage()`/`interceptRequest()`.8788### New Features8990- Component formats: single-file (SFC), multi-file (MFC), view-based components.91- Islands (`@island`) for isolated updates; async actions (`wire:click.async`, `#[Async]`) for parallel execution.92- Deferred/bundled loading: `defer`, `lazy.bundle` for optimized component loading.9394| Feature | Usage | Purpose |95|---------|-------|---------|96| Islands | `@island(name: 'stats')` | Isolated update regions |97| Async | `wire:click.async` or `#[Async]` | Non-blocking actions |98| Deferred | `defer` attribute | Load after page render |99| Bundled | `lazy.bundle` | Load multiple together |100101### New Directives102103- `wire:sort`, `wire:intersect`, `wire:ref`, `.renderless`, `.preserve-scroll` are available for use.104- `data-loading` attribute automatically added to elements triggering network requests.105106| Directive | Purpose |107|-----------|---------|108| `wire:sort` | Drag-and-drop sorting |109| `wire:intersect` | Viewport intersection detection |110| `wire:ref` | Element references for JS |111| `.renderless` | Component without rendering |112| `.preserve-scroll` | Preserve scroll position |113114## Best Practices115116- Always use `wire:key` in loops117- Use `wire:loading` for loading states118- Use `wire:model.live` for instant updates (default is debounced)119- Validate and authorize in actions (treat like HTTP requests)120121## Configuration122123- `smart_wire_keys` defaults to `true`; new configs: `component_locations`, `component_namespaces`, `make_command`, `csp_safe`.124125## Alpine & JavaScript126127- `wire:transition` uses browser View Transitions API; `$errors` and `$intercept` magic properties available.128- Non-blocking `wire:poll` and parallel `wire:model.live` updates improve performance.129130For interceptors and hooks, see [reference/javascript-hooks.md](reference/javascript-hooks.md).131132## Testing133134<!-- Testing Example -->135```php136Livewire::test(Counter::class)137 ->assertSet('count', 0)138 ->call('increment')139 ->assertSet('count', 1);140```141142## Verification1431441. Browser console: Check for JS errors1452. Network tab: Verify Livewire requests return 2001463. Ensure `wire:key` on all `@foreach` loops147148## Common Pitfalls149150- Missing `wire:key` in loops → unexpected re-rendering151- Expecting `wire:model` real-time → use `wire:model.live`152- Unclosed component tags → syntax errors in v4153- Using deprecated config keys or JS hooks154- Including Alpine.js separately (already bundled in Livewire 4)