Comment on page
Directives
HTML directives to make your app come alive.
CBWIRE's powerful directives allow you to listen for client side events, invoke actions, bind to data properties, and more.
The following directives can be added to your components and instruct CBWIRE how and when to update and render the component.
<div wire:key="foo"></div>
Define a key name foo for the element. This provides a reference point for the CBWIRE DOM diffing system. Useful for adding/removing elements and keeping track of lists.
If you are working with nested components and the DOM is not updating as expected, adding wire:key with a unique identifier for each child component can often resolve the issue.
<button wire:click="foo">...</button>
<a href="" wire:click.prevent="foo">Click here</a>
Listens for a click event and invokes the foo action.
<button wire:click.prefetch="foo">...</button>
Listens for a mouseEnter event and then prefetches the result of the foo action. If the element is then clicked, it will swap in the prefetched result without any extra request. If it's not clicked, the cached results will be thrown away.
<form wire:submit.prevent="someAction">
<button type="submit">Submit Form</button>
</form>
Listeners for a submit event on a form.
<input wire:keydown="foo" type="text">
Listens for a keyDown event and invokes the foo action.
<input wire:keydown.enter="foo" type="text">
Listens for a keyDown event when the user hits enter and invokes the foo action.
<select wire:foo="bar"></select>
Listens for a foo event and invokes the bar action.
You can listen to any JS event, not just those defined by CBWIRE.
<input wire:model="foo" type="text">
Provided you have data.foo defined in your data properties, this creates a one-to-one model binding. Any time the element is updated, the value is synchronized.
<input wire:model.debounce.1s="foo" type="text">
<input wire:model.debounce.500ms="foo" type="text">
The same as wire:model="foo" except that all input events to the element will be debounced for the specified duration. Defaults to 150 milliseconds. Useful for reducing XHR background requests during user input. You can set the milliseconds value to any numeric value.
<input wire:model.defer="foo" type="text">
Creates a one-to-one model binding with data.foo in your data properties but defers any XHR updates until an action is performed. Useful for reducing XHR requests.
<input wire:model.lazy="foo" type="text">
Creates a one-to-one model binding with data.foo in your data properties but will not perform XHR updates until an onBlur event is emitted. Urecommendseful for reducing XHR requests.
If your input field does not require immediate updating ( such as for instant form validation), we highly recommend you use the .lazy modifier to reduce the number of XHR requests.
<div wire:poll></div>
<div wire:poll.5s></div>
<div wire:poll.5000ms></div>
<div wire:poll.5s="fooMethod"></div>
Performs an XHR request to re-render the elements based on a set interval. An interval can be specified in both seconds or milliseconds. You can also specify an action that you want to invoke. See Polling
<div wire:init="foo"></div>
Invokes the foo action on your component immediately after it's rendered on the page.
<span wire:loading><img src="spinner.gif"></span>
Hides the HTML element by default and makes it visible when XHR requests are performed.
<div wire:loading.class="highlight"></div>
Adds the foo class to the HTML element while XHR requests are in transit.
<div wire:loading.class.remove="highlight" class="highlight"></div>
Removes the foo class from the HTML element while XHR requests are in transit.
<button wire:loading.attr="disabled">...</button>
Adds the disabled="true" attribute while XHR requests are in transit.
Hides the HTML element by default and makes it visible when the element's state has changed since the latest XHR request.
<div wire:dirty="foo">...</div>
<div wire:dirty.class="highlight">...</div>
Adds the foo class to the HTML element when the element's state has changed since the latest XHR request.
<div wire:dirty.class.remove="highlight" class="highlight">...</div>
Removes the foo class from the HTML element when the element's state has changed since the latest XHR request.
<button wire:dirty.attr="disabled">...</div>
Adds the disabled="true" attribute when the element's state has changed since the latest XHR request. Used in addition to wire:target.
<button wire:dirty.attr="disabled" wire:target="foo">...</div>
Provides scoping for wire:loading and wire:dirty references, scoped to a specific action.
<div wire:ignore></div>
Instructs CBWIRE not to update the element or child elements when updating the DOM. Useful when using third-party JavaScript libraries.
<div wire:ignore.self></div>
Instructs CBWIRE to not update the element but DOES allow updates to any child elements when updating the DOM.
CBWIRE Directives sometimes offer "modifiers" to add extra functionality to an event. Here are the available modifiers that can be used with any event.
Modifier | Text |
|---|---|
stop | Equivalent of event.stopPropagation() |
prevent | Equivalent of event.preventDefault() |
self | Only triggers an action if the event was triggered on itself. This prevents outer elements from catching events that were triggered from a child element. (Like often in the case of registering a listener on a modal backdrop) |
debounce.300ms | Adds an Xms debounce to the handling of the action. |
<a href="" wire:click.prevent="someAction">Click here</a>
To listen for specific keys on keydown events, you can provide the name of the key as a modifier. You can use any valid key names exposed via KeyboardEvent.key as modifiers by converting them to kebab-case.
Here is a quick list of some common ones you may need:
Native Browser Event | Livewire Modifier |
|---|---|
Backspace | backspace |
Escape | escape |
Shift | shift |
Tab | tab |
ArrowRight | arrow-right |
<input wire:keydown.page-down="foo">
In the above example, the foo action will only be called if event.key is equal to 'PageDown'.
Last modified 1mo ago