Ver Fonte

docs(watchers)

Ryan Chandler há 5 anos atrás
pai
commit
357438f4d1
1 ficheiros alterados com 15 adições e 0 exclusões
  1. 15 0
      README.md

+ 15 - 0
README.md

@@ -127,6 +127,21 @@ This will trigger Alpine to re-evaluate your subscribed components and re-render
 
 You can register watchers in a similar fashion to Alpine. All you need is the full dot-notation representation of your piece of state and a callback.
 
+```html
+<script>
+    Spruce.store('form', {
+        name: 'Ryan',
+        email: 'support@ryangjchandler.co.uk'
+    })
+
+    Spruce.watch('form.email', (old, next) => {
+        // do something with the values here
+    })
+<script>
+```
+
+In the above snippet, when we change the value of `form.email` either from a component or externally in a separate JavaScript file, our callback will be invoked and will receive the old value, as well as the new value. This can be useful for running automatic inline validation when a property changes, or triggering an action elsewhere in another component without the need for dispatching events.
+
 ### Removing the need for `x-subscribe`
 
 Alpine offers a Config API. Using this API, you can enable an experimental global `$store` variable that is declared on the `window` object. This means your components do not need to manually "subscribe" to state changes: