Reactivity
Declare state
Update state
Computed state
Templating
Minimal template
Styling
<h1 class="title">I am red</h1>
<button style="font-size: 10rem">I am a button</button>
<style>
.title {
color: red;
}
</style>
Loop
Event click
<div x-data="{ count: 0 }">
<p>Counter: <span x-text="count"></span></p>
<button x-on:click="count++">+1</button>
</div>
Dom ref
Conditional
<div
x-data="{
TRAFFIC_LIGHTS: ['red', 'orange', 'green'],
lightIndex: 0,
get light() { return this.TRAFFIC_LIGHTS[this.lightIndex] },
nextLight() {
this.lightIndex = (this.lightIndex + 1) % this.TRAFFIC_LIGHTS.length;
}
}"
>
<button x-on:click="nextLight">Next light</button>
<p>Light is: <span x-text="light"></span></p>
<p>
You must
<span x-show="light === 'red'">STOP</span>
<span x-show="light === 'orange'">SLOW DOWN</span>
<span x-show="light === 'green'">GO</span>
</p>
</div>
import { track } from "ripple";
const TRAFFIC_LIGHTS = ["red", "orange", "green"];
export default function TrafficLight() {
let &[lightIndex] = track(0);
let &[light] = track(() => TRAFFIC_LIGHTS[lightIndex]);
function nextLight() {
lightIndex = (lightIndex + 1) % TRAFFIC_LIGHTS.length;
}
return <>
<button onClick={nextLight}>"Next light"</button>
<p>"Light is "{light}</p>
<p>
"You must "
if (light === "red") {
<span>"STOP"</span>
} else if (light === "orange") {
<span>"SLOW DOWN"</span>
} else if (light === "green") {
<span>"GO"</span>
}
</p>
</>;
}
Lifecycle
On mount
<p
x-data="{ pageTitle: '' }"
x-init="$nextTick(() => { pageTitle = document.title })"
>
Page title: <span x-text="pageTitle"></span>
</p>
On unmount
<p
x-data="{
time: new Date().toLocaleTimeString(),
timer: null,
init() { this.timer = setInterval(() => (this.time = new Date().toLocaleTimeString()), 1000) },
destroy() { clearInterval(this.timer) }
}"
>
Current time: <span x-text="time"></span>
</p>
import { effect, track } from "ripple";
export default function Time() {
let &[time] = track(new Date().toLocaleTimeString());
effect(() => {
const timer = setInterval(() => {
time = new Date().toLocaleTimeString();
}, 1000);
return () => clearInterval(timer);
});
return <h1>"Current time: "{time}</h1>;
}
Component composition
Props
<!--Alpine JS suggests using a server-side templating engine or another frontend framework in conjunction with Alpine to do this-->
<div
x-data="{
name: 'John',
age: 20,
favouriteColors: ['green', 'blue', 'red'],
isAvailable: true
}"
>
<p>My name is <span x-text="John"></span></p>
<p>My age is <span x-text="age"></span></p>
<p>
My favourite colors are <span x-text="favouriteColors.join(', ')"></span>
</p>
<p>I am <span x-text="isAvailable ? 'available' : 'not available'"></span></p>
</div>
Emit to parent
<div
x-data="{ isHappy: true }"
x-on:yes="isHappy = true"
x-on:no="isHappy = false"
>
<p>Are you happy?</p>
<div>
<button x-on:click="$dispatch('yes')">YES</button>
<button x-on:click="$dispatch('no')">NO</button>
</div>
<p style="font-size: 50px" x-text="isHappy ? '😀' : '😥'"></p>
</div>
import { track } from "ripple";
import { AnswerButton } from "./AnswerButton.tsrx";
export function App() {
let &[isHappy] = track(true);
function onAnswerNo() {
isHappy = false;
}
function onAnswerYes() {
isHappy = true;
}
return <>
<p>"Are you happy?"</p>
<AnswerButton onYes={onAnswerYes} onNo={onAnswerNo} />
<p style={{ fontSize: "50px" }}>{isHappy ? "😀" : "😥"}</p>
</>;
}
Slot
<!--Alpine JS suggests using a server-side templating engine or another frontend framework in conjunction with Alpine to do this-->
<button
x-data
x-text="'Click me!'"
style="
background: rgba(0, 0, 0, 0.4);
color: #fff;
padding: 10px 20px;
font-size: 30px;
border: 2px solid #fff;
margin: 8px;
transform: scale(0.9);
box-shadow: 4px 4px rgba(0, 0, 0, 0.4);
transition: transform 0.2s cubic-bezier(0.34, 1.65, 0.88, 0.925) 0s;
outline: 0;
"
>
<span>No content found</span>
</button>
Slot fallback
<!--Alpine JS suggests using a server-side templating engine or another frontend framework in conjunction with Alpine to do this-->
<button
x-data
style="
background: rgba(0, 0, 0, 0.4);
color: #fff;
padding: 10px 20px;
font-size: 30px;
border: 2px solid #fff;
margin: 8px;
transform: scale(0.9);
box-shadow: 4px 4px rgba(0, 0, 0, 0.4);
transition: transform 0.2s cubic-bezier(0.34, 1.65, 0.88, 0.925) 0s;
outline: 0;
"
>
<span>No content found</span>
</button>
<button
x-data
x-text="'I got content!'"
style="
background: rgba(0, 0, 0, 0.4);
color: #fff;
padding: 10px 20px;
font-size: 30px;
border: 2px solid #fff;
margin: 8px;
transform: scale(0.9);
box-shadow: 4px 4px rgba(0, 0, 0, 0.4);
transition: transform 0.2s cubic-bezier(0.34, 1.65, 0.88, 0.925) 0s;
outline: 0;
"
>
<span>No content found</span>
</button>
Context
Alpine
Missing snippet Help us to improve Component Party 
import { RippleObject } from "ripple";
import { UserContext } from "./UserContext.tsrx";
import { UserProfile } from "./UserProfile.tsrx";
export function App() {
const user = new RippleObject({
id: 1,
username: "unicorn42",
email: "[email protected]",
});
UserContext.set(user);
return <>
<h1>"Welcome back, "{user.username}</h1>
<UserProfile />
</>;
}
Form input
Input text
Checkbox
<div x-data="{ isAvailable: true }">
<input id="is-available" x-model="isAvailable" type="checkbox" />
<label for="is-available">Is available</label>
</div>
Radio
<div x-data="{ picked: 'red' }">
<div>Picked: <span x-text="picked"></span></div>
<input id="blue-pill" x-model="picked" type="radio" value="blue" />
<label for="blue-pill">Blue pill</label>
<input id="red-pill" x-model="picked" type="radio" value="red" />
<label for="red-pill">Red pill</label>
</div>
import { bindGroup, track } from "ripple";
export default function PickPill() {
let &[picked, pickedTracked] = track("red");
return <>
<div>"Picked: "{picked}</div>
<input
id="blue-pill"
type="radio"
value="blue"
ref={bindGroup(pickedTracked)}
/>
<label for="blue-pill">"Blue pill"</label>
<input
id="red-pill"
type="radio"
value="red"
ref={bindGroup(pickedTracked)}
/>
<label for="red-pill">"Red pill"</label>
</>;
}
Select
<div
x-data="{
selectedColorId: 2,
colors: [
{ id: 1, text: 'red' },
{ id: 2, text: 'blue' },
{ id: 3, text: 'green' },
{ id: 4, text: 'gray', isDisabled: true }
]
}"
>
<select x-model.number="selectedColorId">
<template x-for="color in colors" x-bind:key="color.id">
<option
x-text="color.text"
x-bind:value="color.id"
x-bind:disabled="!!color.isDisabled"
x-bind:selected="color.id === selectedColorId"
></option>
</template>
</select>
</div>
import { bindValue, track } from "ripple";
const colors = [
{ id: 1, text: "red" },
{ id: 2, text: "blue" },
{ id: 3, text: "green" },
{ id: 4, text: "gray", isDisabled: true },
];
export default function ColorSelect() {
let &[selectedColorId, selectedColorIdTracked] = track(2);
return <select ref={bindValue(selectedColorIdTracked)}>
for (const color of colors; key color.id) {
<option value={color.id} disabled={color.isDisabled}>
{color.text}
</option>
}
</select>;
}
Webapp features
Render app
Fetch data
<div
x-data="
function fetchUsers() {
return {
users: null,
isLoading: false,
error: null,
async init() {
this.isLoading = true;
try {
this.users = (await (await fetch('https://randomuser.me/api/?results=3')).json()).results;
} catch (err) {
this.users = [];
this.error = err
}
this.isLoading = false;
},
};
}
"
>
<template x-if="isLoading">
<p>Loading...</p>
</template>
<template x-if="error">
<p>Error fetching users</p>
</template>
<template x-if="!error">
<ul>
<template x-for="user in users">
<li>
<img
:src="user.picture.thumbnail"
:alt="`picture of ${user.name.first} ${user.name.last}`"
/>
<p x-text="`${user.name.first} ${user.name.last}`"></p>
</li>
</template>
</ul>
</template>
</div>
import { useFetchUsers } from "./useFetchUsers.tsrx";
export function App() {
const data = useFetchUsers();
return <>
if (data.isLoading) {
<p>"Fetching users..."</p>
} else if (data.error) {
<p>"An error occurred while fetching users"</p>
} else if (data.users) {
<ul>
for (const user of data.users; key user.login.uuid) {
<li>
<img src={user.picture.thumbnail} alt="user" />
<p>{user.name.first}" "{user.name.last}</p>
</li>
}
</ul>
}
</>;
}