State actions
HTML elements can configure any number of attributes in response to state
actions
by prepending their names with x-
.
Multiple elements can handle the same action and configure their attributes differently.
Attributes
if:loading
specified on an element that launches a request, contains a space separated list of state actions to turn ON immediately before starting a request and to turn OFF immediately after a request completesif:error
specified on an element that launches a request, contains a space separated list of state actions to turn OFF immediately before starting a request and to turn ON immediately after a request failsif:invalid
specified on a form or a form field, contains a space separated list of state actions to turn ON when the element becomes invalid and to turn OFF when the element becomes valid (invalid forms and fields do not trigger server requests)if
specified on any element, including the same one that launched the request, and subscribes to a single state action
Loading State Example
- the first div is initially visible and the second div is initially hidden
- clicking the button
- initiates the
loadData
action - turns ON the
isLoadingData
state action, thus the first div becomes invisible and the second visible - sends a "GET" request to "/data"
- after completion of the request turns OFF the
isLoadingData
state action, thus the first div becomes visible and the second invisible again
<button on:click="loadData"
on="loadData"
get="/data"
if:loading="isLoadingData"
>
click me
</button>
<div if="isLoadingData"
x-style="display: none"
>
not loading
</div>
<div if="isLoadingData"
style="display: none"
x-style
>
loading
</div>
Error State Example
- the first div is initially visible and the second div is initially hidden
- clicking the button
- initiates the
loadWrong
action - turns OFF the
isError
state action, which does not change the visibility of the divs - sends a "GET" request to "/non-existent"
- after completion of the request turns ON the
isError
state action, because the request has failed, thus the first div becomes invisible and the second visible
<button on:click="loadWrong"
on="loadWrong"
get="/non-existent"
if:error="isError"
>
click me
</button>
<div if="isError"
x-style="display: none"
>
no error
</div>
<div if="isError"
style="display: none"
x-style
>
error
</div>
Invalid State Example
- the first div will be visible initially as well as when the inputs' value becomes a valid email
- the second div will be visible only when the inputs' value becomes an invalid email
<input if:invalid="invalidEmail"
type="email"
>
<div if="invalidEmail"
x-style="display: none"
>
valid
</div>
<div if="invalidEmail"
style="display: none"
x-style
>
invalid
</div>