Spaces:
Running
Running
File size: 6,523 Bytes
7da13d6 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
x-data
======
Everything in Alpine starts with the `x-data` directive.
`x-data` defines a chunk of HTML as an Alpine component and provides the reactive data for that component to reference.
Here's an example of a contrived dropdown component:
<div x-data="{ open: false }"> <button @click="open = ! open">Toggle Content</button> <div x-show="open"> Content... </div></div>
<div x-data="{ open: false }">
<button @click="open = ! open">Toggle Content</button>
<div x-show="open">
Content...
</div>
</div>
Don't worry about the other directives in this example (`@click` and `x-show`), we'll get to those in a bit. For now, let's focus on `x-data`.
[Scope](#scope)
---------------
Properties defined in an `x-data` directive are available to all element children. Even ones inside other, nested `x-data` components.
For example:
<div x-data="{ foo: 'bar' }"> <span x-text="foo"><!-- Will output: "bar" --></span> <div x-data="{ bar: 'baz' }"> <span x-text="foo"><!-- Will output: "bar" --></span> <div x-data="{ foo: 'bob' }"> <span x-text="foo"><!-- Will output: "bob" --></span> </div> </div></div>
<div x-data="{ foo: 'bar' }">
<span x-text="foo"><!-- Will output: "bar" --></span>
<div x-data="{ bar: 'baz' }">
<span x-text="foo"><!-- Will output: "bar" --></span>
<div x-data="{ foo: 'bob' }">
<span x-text="foo"><!-- Will output: "bob" --></span>
</div>
</div>
</div>
[Methods](#methods)
-------------------
Because `x-data` is evaluated as a normal JavaScript object, in addition to state, you can store methods and even getters.
For example, let's extract the "Toggle Content" behavior into a method on `x-data`.
<div x-data="{ open: false, toggle() { this.open = ! this.open } }"> <button @click="toggle()">Toggle Content</button> <div x-show="open"> Content... </div></div>
<div x-data="{ open: false, toggle() { this.open = ! this.open } }">
<button @click="toggle()">Toggle Content</button>
<div x-show="open">
Content...
</div>
</div>
Notice the added `toggle() { this.open = ! this.open }` method on `x-data`. This method can now be called from anywhere inside the component.
You'll also notice the usage of `this.` to access state on the object itself. This is because Alpine evaluates this data object like any standard JavaScript object with a `this` context.
If you prefer, you can leave the calling parenthesis off of the `toggle` method completely. For example:
<!-- Before --><button @click="toggle()">...</button> <!-- After --><button @click="toggle">...</button>
<!-- Before -->
<button @click="toggle()">...</button>
<!-- After -->
<button @click="toggle">...</button>
[Getters](#getters)
-------------------
JavaScript [getters](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/get) are handy when the sole purpose of a method is to return data based on other state.
Think of them like "computed properties" (although, they are not cached like Vue's computed properties).
Let's refactor our component to use a getter called `isOpen` instead of accessing `open` directly.
<div x-data="{ open: false, get isOpen() { return this.open }, toggle() { this.open = ! this.open },}"> <button @click="toggle()">Toggle Content</button> <div x-show="isOpen"> Content... </div></div>
<div x-data="{
open: false,
get isOpen() { return this.open },
toggle() { this.open = ! this.open },
}">
<button @click="toggle()">Toggle Content</button>
<div x-show="isOpen">
Content...
</div>
</div>
Notice the "Content" now depends on the `isOpen` getter instead of the `open` property directly.
In this case there is no tangible benefit. But in some cases, getters are helpful for providing a more expressive syntax in your components.
[Data-less components](#data-less-components)
---------------------------------------------
Occasionally, you want to create an Alpine component, but you don't need any data.
In these cases, you can always pass in an empty object.
<div x-data="{}">
<div x-data="{}">
However, if you wish, you can also eliminate the attribute value entirely if it looks better to you.
<div x-data>
<div x-data>
[Single-element components](#single-element-components)
-------------------------------------------------------
Sometimes you may only have a single element inside your Alpine component, like the following:
<div x-data="{ open: true }"> <button @click="open = false" x-show="open">Hide Me</button></div>
<div x-data="{ open: true }">
<button @click="open = false" x-show="open">Hide Me</button>
</div>
In these cases, you can declare `x-data` directly on that single element:
<button x-data="{ open: true }" @click="open = false" x-show="open"> Hide Me</button>
<button x-data="{ open: true }" @click="open = false" x-show="open">
Hide Me
</button>
[Re-usable Data](#re-usable-data)
---------------------------------
If you find yourself duplicating the contents of `x-data`, or you find the inline syntax verbose, you can extract the `x-data` object out to a dedicated component using `Alpine.data`.
Here's a quick example:
<div x-data="dropdown"> <button @click="toggle">Toggle Content</button> <div x-show="open"> Content... </div></div> <script> document.addEventListener('alpine:init', () => { Alpine.data('dropdown', () => ({ open: false, toggle() { this.open = ! this.open }, })) })</script>
<div x-data="dropdown">
<button @click="toggle">Toggle Content</button>
<div x-show="open">
Content...
</div>
</div>
<script>
document.addEventListener('alpine:init', () => {
Alpine.data('dropdown', () => ({
open: false,
toggle() {
this.open = ! this.open
},
}))
})
</script>
[→ Read more about `Alpine.data(...)`](/globals/alpine-data)
[← Lifecycle](/essentials/lifecycle)
[x-init →](/directives/init)
Code highlighting provided by [Torchlight](https://torchlight.dev) |