Alpine.js

On this page

  1. Example Component
  2. Tracking Data Stores

The third-party Alpine.js package for Ray uses the package for NodeJS for most core functionality. See the NodeJS reference for a full list of available methods.

Once the plugin is installed, you may access the helper function as $ray() from within your Alpine components.

<div x-data="onClickData()">
    <div x-show="show">Hi There Ray!</div>
    <button x-on:click="toggle()">Show/Hide (Ray)</button>
    <button @click="$ray('hello from alpine')">Send to Ray</button>
</div>

<script>        
function onClickData() {
    return {
        init() {
            this.$ray().html('<strong>init on-click-ray data</strong>');
        },
        toggle() {
            this.show = !this.show;
            this.$ray('toggled show value to ' + (this.show ? 'true' : 'false'));
        },
        show: false,
    };
}
</script>

You may automatically send Alpine stores to Ray whenever the store data is updated. Consider the following:

window.Alpine.store('mydata', {
    showing: false,
});
 
setInterval( () => {
    window.Alpine.store('mydata').showing = !window.Alpine.store('mydata').showing;
}, 3000);

To watch the store and display changes in Ray, use the $ray().watchStore('name') method:

<div x-data="componentData()">
    <div x-show="$store.mydata.showing">Hi There Ray!</div>
    <button x-on:click="toggle()">Show/Hide (Ray)</button>
</div>

<script>      
window.Alpine.store('mydata', {
    showing: false,
});
  
function componentData() {
    return {
        init() {
            this.$ray().watchStore('mydata');
        },
        toggle() {
            this.$store.mydata.showing = !this.$store.mydata.showing;
        },
    };
}
</script>