Partage d'État

Lors de la construction d’un site web Astro avec l’architecture isolée / hydratation partielle, vous avez peut-être rencontré ce problème : Je veux partager l’état entre mes composants.

Les frameworks d’interface utilisateur tels que React ou Vue peuvent encourager l’utilisation de fournisseurs de “contexte” pour que d’autres composants puissent les consommer. Mais lorsque vous hydratez partiellement des composants dans Astro ou Markdown, vous ne pouvez pas utiliser ces enveloppes contextuelles.

Astro recommande une solution différente pour le stockage partagé côté client : les Nano Stores.

Méthode associée : Partage d'état entre composants Astro

Pourquoi Nano Stores ?

Titre de la section Pourquoi Nano Stores ?

La bibliothèque Nano Stores vous permet de créer des stores avec lesquels n’importe quel composant peut interagir. Nous recommandons Nano Stores pour les raisons suivantes :

• Ils sont légers. Nano Stores contient le strict minimum de JS dont vous aurez besoin (moins de 1 Ko) sans aucune dépendance.
• Ils sont agnostiques. Cela signifie que le partage d’état entre les frameworks sera fera de manière transparent ! Astro est basé sur la flexibilité, c’est pourquoi nous aimons les solutions qui offrent une expérience de développement similaire, quelle que soit votre préférence.

Il existe néanmoins un certain nombre d’alternatives que vous pouvez explorer. En voici quelques-unes :

• Les Stores intégrés de Svelte
• Les signaux de SolidJS en dehors du contexte d’un composant
• API de réactivité de Vue
• L’envoi d’événements de navigateur personnalisés entre les composants

FAQ

🙋 Puis-je utiliser Nano Stores dans des fichiers .astro ou d’autres composants côté serveur ?

Nano Stores peut être importé, écrit et lu dans les composants côté serveur, mais nous ne le recommandons pas ! Ceci est dû à quelques restrictions :

• L’écriture d’un store à partir d’un fichier .astro ou composant non hydraté n’affectera pas la valeur reçue par les composants côté client.
• Vous ne pouvez pas transmettre un Nano Store en tant que prop aux composants côté client.
• Vous ne pouvez pas vous abonner aux mises à jour du store à partir d’un fichier .astro, puisque les composants Astro ne se rafraîchissent pas.

Si vous comprenez ces restrictions et que vous trouvez toujours un cas d’utilisation, vous pouvez essayer Nano Stores ! N’oubliez pas que les Nano Stores sont conçus pour être réactifs aux changements sur le client spécifiquement.

🙋 En quoi les Stores de Svelte sont-ils différents de Nano Stores ?

Nano Stores et les Svelte Stores sont très similaires ! En effet, Nano Stores vous permettent d’utiliser le même raccourci $ pour les abonnements que vous pourriez utiliser avec Svelte stores.

Si vous voulez éviter les bibliothèques tierces, les Svelte Stores constituent à eux seuls un excellent outil de communication inter-îles. Néanmoins, vous pouvez préférerer Nano Stores si :

1. Vous aimez leurs modules complémentaires pour les objets et l’état asynchrone.
2. Ou si vous souhaitez communiquer entre Svelte et d’autres frameworks d’interface utilisateur comme Preact ou Vue.

🙋 Comment Solid signals est-il différent de Nano Stores ?

Si vous utilisez Solid depuis un certain temps, vous avez peut-être essayé de déplacer les “signals” ou stores en dehors de vos composants. C’est un excellent moyen de partager l’état entre les îles de composants Solid ! Essayez d’exporter des “signals” à partir d’un fichier partagé :

sharedStore.js

import { createSignal } from 'solid-js';

export const sharedCount = createSignal(0);

…et tous les composants important sharedCount partageront le même état. Bien que cela fonctionne bien, vous préférerez peut-être Nano Stores si a) vous aimez leurs modules complémentaires pour “objects” et async state, ou b) vous souhaitez communiquer entre Solid et d’autres frameworks d’interface utilisateur comme Preact ou Vue.

Installer Nano Stores

Titre de la section Installer Nano Stores

Pour commencer, installez Nano Stores avec son package d’assistance pour votre framework d’interface utilisateur préféré :

Preact

npm install nanostores @nanostores/preact

React

npm install nanostores @nanostores/react

Solid

npm install nanostores @nanostores/solid

Svelte

npm install nanostores

Note

Pas de package d’assistance ici ! Nano Stores peuvent être utilisés comme Svelte stores standard

Vue

npm install nanostores @nanostores/vue

Vous pouvez aller directement dans le guide d’utilisation de Nano Stores à partir d’ici, ou suivez notre exemple ci-dessous !

Exemple d’utilisation - Menu déroulant pour un panier de e-commerce

Titre de la section Exemple d’utilisation - Menu déroulant pour un panier de e-commerce

Disons que nous construisons une interface de e-commerce simple avec trois éléments interactifs :

• Un formulaire de soumission “ajouter au panier”
• Un menu déroulant du panier pour afficher les articles ajoutés
• Une bascule de chariot

Essayez l’exemple complété sur votre machine ou en ligne via StackBlitz.

Votre fichier Astro de base peut ressembler à ceci :

src/pages/index.astro

---
import CartFlyoutToggle from '../components/CartFlyoutToggle';
import CartFlyout from '../components/CartFlyout';
import AddToCartForm from '../components/AddToCartForm';
---

<!DOCTYPE html>
<html lang="en">
<head>...</head>
<body>
  <header>
    <nav>
      <a href="/">Vitrine Astro</a>
      <CartFlyoutToggle client:load />
    </nav>
  </header>
  <main>
    <AddToCartForm client:load>
    <!-- ... -->
    </AddToCartForm>
  </main>
  <CartFlyout client:load />
</body>
</html>

Utilisation des “atoms”

Titre de la section Utilisation des “atoms”

Commençons par ouvrir notre CartFlyout chaque fois que CartFlyoutToggle est cliqué.

Tout d’abord, créez un nouveau fichier JS ou TS pour contenir notre store. Nous utiliserons un “atom” pour cela :

src/cartStore.js

import { atom } from 'nanostores';

export const isCartOpen = atom(false);

Maintenant, nous pouvons importer ce store dans n’importe quel fichier qui doit le lire ou y écrire. Nous allons commencer par câbler notre CartFlyoutToggle :

Preact

src/components/CartFlyoutToggle.jsx

import { useStore } from '@nanostores/preact';
import { isCartOpen } from '../cartStore';

export default function CartButton() {
  // lire la valeur du store avec le hook `useStore`
  const $isCartOpen = useStore(isCartOpen);
  // write to the imported store using `.set`
  return (
    <button onClick={() => isCartOpen.set(!$isCartOpen)}>Cart</button>
  )
}

React

src/components/CartFlyoutToggle.jsx

import { useStore } from '@nanostores/react';
import { isCartOpen } from '../cartStore';

export default function CartButton() {
  // read the store value with the `useStore` hook
  const $isCartOpen = useStore(isCartOpen);
  // write to the imported store using `.set`
  return (
    <button onClick={() => isCartOpen.set(!$isCartOpen)}>Cart</button>
  )
}

Solid

src/components/CartFlyoutToggle.jsx

import { useStore } from '@nanostores/solid';
import { isCartOpen } from '../cartStore';

export default function CartButton() {
  // read the store value with the `useStore` hook
  const $isCartOpen = useStore(isCartOpen);
  // write to the imported store using `.set`
  return (
    <button onClick={() => isCartOpen.set(!$isCartOpen())}>Cart</button>
  )
}

Svelte

src/components/CartFlyoutToggle.svelte

<script>
  import { isCartOpen } from '../cartStore';
</script>

<!--use "$" to read the store value-->
<button on:click={() => isCartOpen.set(!$isCartOpen)}>Cart</button>

Vue

src/components/CartFlyoutToggle.vue

<template>
  <!--write to the imported store using `.set`-->
  <button @click="isCartOpen.set(!$isCartOpen)">Cart</button>
</template>

<script setup>
  import { isCartOpen } from '../cartStore';
  import { useStore } from '@nanostores/vue';

  // read the store value with the `useStore` hook
  const $isCartOpen = useStore(isCartOpen);
</script>

Lit

src/components/CartFlyoutToggle.ts

import { LitElement, html } from 'lit';
import { isCartOpen } from '../cartStore';

export class CartFlyoutToggle extends LitElement {
  handleClick() {
    isCartOpen.set(!isCartOpen.get());
  }

  render() {
    return html`
      <button @click="${this.handleClick}">Cart</button>
    `;
  }
}

customElements.define('cart-flyout-toggle', CartFlyoutToggle);

Ensuite, nous pouvons lire isCartOpen à partir de notre composant CartFlyout :

Preact

src/components/CartFlyout.jsx

import { useStore } from '@nanostores/preact';
import { isCartOpen } from '../cartStore';

export default function CartFlyout() {
  const $isCartOpen = useStore(isCartOpen);

  return $isCartOpen ? <aside>...</aside> : null;
}

React

src/components/CartFlyout.jsx

import { useStore } from '@nanostores/react';
import { isCartOpen } from '../cartStore';

export default function CartFlyout() {
  const $isCartOpen = useStore(isCartOpen);

  return $isCartOpen ? <aside>...</aside> : null;
}

Solid

src/components/CartFlyout.jsx

import { useStore } from '@nanostores/solid';
import { isCartOpen } from '../cartStore';

export default function CartFlyout() {
  const $isCartOpen = useStore(isCartOpen);

  return $isCartOpen() ? <aside>...</aside> : null;
}

Svelte

src/components/CartFlyout.svelte

<script>
  import { isCartOpen } from '../cartStore';
</script>

{#if $isCartOpen}
<aside>...</aside>
{/if}

Vue

src/components/CartFlyout.vue

<template>
  <aside v-if="$isCartOpen">...</aside>
</template>

<script setup>
  import { isCartOpen } from '../cartStore';
  import { useStore } from '@nanostores/vue';

  const $isCartOpen = useStore(isCartOpen);
</script>

Lit

src/components/CartFlyout.ts

import { isCartOpen } from '../cartStore';
import { LitElement, html } from 'lit';
import { StoreController } from '@nanostores/lit';

export class CartFlyout extends LitElement {
  private cartOpen = new StoreController(this, isCartOpen);

  render() {
    return this.cartOpen.value ? html`<aside>...</aside>` : null;
  }
}

customElements.define('cart-flyout', CartFlyout);

Utilisation des “maps”

Titre de la section Utilisation des “maps”

Astuce

Maps sont un excellent choix pour les objets sur lesquels vous écrivez régulièrement ! En plus des aides standard get() et set() fournies par atom, vous aurez également une fonction .setKey() pour mettre à jour efficacement clés d’objet individuelles.

Maintenant, gardons une trace des articles dans votre panier. Pour éviter les doublons et garder une trace de la “quantité”, nous pouvons stocker votre panier en tant qu’objet avec l’ID de l’article comme clé. Nous utiliserons une Map pour ça.

Ajoutons un magasin cartItem à notre cartStore.js de plus tôt. Vous pouvez également passer à un fichier TypeScript pour définir la forme si vous le souhaitez.

JavaScript

src/cartStore.js

import { atom, map } from 'nanostores';

export const isCartOpen = atom(false);

/**
 * @typedef {Object} CartItem
 * @property {string} id
 * @property {string} name
 * @property {string} imageSrc
 * @property {number} quantity
 */

/** @type {import('nanostores').MapStore<Record<string, CartItem>>} */
export const cartItems = map({});

TypeScript

src/cartStore.ts

import { atom, map } from 'nanostores';

export const isCartOpen = atom(false);

export type CartItem = {
  id: string;
  name: string;
  imageSrc: string;
  quantity: number;
}

export const cartItems = map<Record<string, CartItem>>({});

Maintenant, exportons un assistant addCartItem pour que nos composants l’utilisent.

• Si cet article n’existe pas dans votre panier, ajoutez l’article avec une quantité de départ de 1.
• Si cet article existe déjà, augmentez la quantité de 1.

JavaScript

src/cartStore.js

...
export function addCartItem({ id, name, imageSrc }) {
  const existingEntry = cartItems.get()[id];
  if (existingEntry) {
    cartItems.setKey(id, {
      ...existingEntry,
      quantity: existingEntry.quantity + 1,
    })
  } else {
    cartItems.setKey(
      id,
      { id, name, imageSrc, quantity: 1 }
    );
  }
}

TypeScript

src/cartStore.ts

...
type ItemDisplayInfo = Pick<CartItem, 'id' | 'name' | 'imageSrc'>;
export function addCartItem({ id, name, imageSrc }: ItemDisplayInfo) {
  const existingEntry = cartItems.get()[id];
  if (existingEntry) {
    cartItems.setKey(id, {
      ...existingEntry,
      quantity: existingEntry.quantity + 1,
    });
  } else {
    cartItems.setKey(
      id,
      { id, name, imageSrc, quantity: 1 }
    );
  }
}

Note

🙋 Pourquoi utiliser .get() ici au lieu d’un assistant useStore ?

Vous avez peut-être remarqué que nous appelons cartItems.get() ici, au lieu de récupérer cet assistant useStore de nos exemples React / Preact / Solid / Vue. En effet, useStore est destiné à déclencher de nouveaux rendus de composants. En d’autres termes, useStore doit être utilisé chaque fois que la valeur du store est restituée à l’interface utilisateur. Puisque nous lisons la valeur lorsqu’un événement est déclenché (addToCart dans ce cas), et que nous n’essayons pas d’effectuer un rendu de cette valeur, nous n’avons pas besoin de useStore ici.

Avec notre store en place, nous pouvons appeler cette fonction dans notre AddToCartForm chaque fois que ce formulaire est soumis. Nous ouvrirons également le menu déroulant du panier afin que vous puissiez voir un résumé complet du panier.

Preact

src/components/AddToCartForm.jsx

import { addCartItem, isCartOpen } from '../cartStore';

export default function AddToCartForm({ children }) {
  // we'll hardcode the item info for simplicity!
  const hardcodedItemInfo = {
    id: 'astronaut-figurine',
    name: 'Astronaut Figurine',
    imageSrc: '/images/astronaut-figurine.png',
  }

  function addToCart(e) {
    e.preventDefault();
    isCartOpen.set(true);
    addCartItem(hardcodedItemInfo);
  }

  return (
    <form onSubmit={addToCart}>
      {children}
    </form>
  )
}

React

src/components/AddToCartForm.jsx

import { addCartItem, isCartOpen } from '../cartStore';

export default function AddToCartForm({ children }) {
  // we'll hardcode the item info for simplicity!
  const hardcodedItemInfo = {
    id: 'astronaut-figurine',
    name: 'Astronaut Figurine',
    imageSrc: '/images/astronaut-figurine.png',
  }

  function addToCart(e) {
    e.preventDefault();
    isCartOpen.set(true);
    addCartItem(hardcodedItemInfo);
  }

  return (
    <form onSubmit={addToCart}>
      {children}
    </form>
  )
}

Solid

src/components/AddToCartForm.jsx

import { addCartItem, isCartOpen } from '../cartStore';

export default function AddToCartForm({ children }) {
  // we'll hardcode the item info for simplicity!
  const hardcodedItemInfo = {
    id: 'astronaut-figurine',
    name: 'Astronaut Figurine',
    imageSrc: '/images/astronaut-figurine.png',
  }

  function addToCart(e) {
    e.preventDefault();
    isCartOpen.set(true);
    addCartItem(hardcodedItemInfo);
  }

  return (
    <form onSubmit={addToCart}>
      {children}
    </form>
  )
}

Svelte

src/components/AddToCartForm.svelte

<form on:submit|preventDefault={addToCart}>
  <slot></slot>
</form>

<script>
  import { addCartItem, isCartOpen } from '../cartStore';

  // we'll hardcode the item info for simplicity!
  const hardcodedItemInfo = {
    id: 'astronaut-figurine',
    name: 'Astronaut Figurine',
    imageSrc: '/images/astronaut-figurine.png',
  }

  function addToCart() {
    isCartOpen.set(true);
    addCartItem(hardcodedItemInfo);
  }
</script>

Vue

src/components/AddToCartForm.vue

<template>
  <form @submit="addToCart">
    <slot></slot>
  </form>
</template>

<script setup>
  import { addCartItem, isCartOpen } from '../cartStore';

  // we'll hardcode the item info for simplicity!
  const hardcodedItemInfo = {
    id: 'astronaut-figurine',
    name: 'Astronaut Figurine',
    imageSrc: '/images/astronaut-figurine.png',
  }

  function addToCart(e) {
    e.preventDefault();
    isCartOpen.set(true);
    addCartItem(hardcodedItemInfo);
  }
</script>

Lit

src/components/AddToCartForm.ts

import { LitElement, html } from 'lit';
import { isCartOpen, addCartItem } from '../cartStore';

export class AddToCartForm extends LitElement {
  static get properties() {
    return {
      item: { type: Object },
    };
  }

  constructor() {
    super();
    this.item = {};
  }

  addToCart(e) {
    e.preventDefault();
    isCartOpen.set(true);
    addCartItem(this.item);
  }

  render() {
    return html`
      <form @submit="${this.addToCart}">
        <slot></slot>
      </form>
    `;
  }
}
customElements.define('add-to-cart-form', AddToCartForm);

Enfin, nous afficherons ces éléments de panier dans notre CartFlyout :

Preact

src/components/CartFlyout.jsx

import { useStore } from '@nanostores/preact';
import { isCartOpen, cartItems } from '../cartStore';

export default function CartFlyout() {
  const $isCartOpen = useStore(isCartOpen);
  const $cartItems = useStore(cartItems);

  return $isCartOpen ? (
    <aside>
      {Object.values($cartItems).length ? (
        <ul>
          {Object.values($cartItems).map(cartItem => (
            <li>
              <img src={cartItem.imageSrc} alt={cartItem.name} />
              <h3>{cartItem.name}</h3>
              <p>Quantity: {cartItem.quantity}</p>
            </li>
          ))}
        </ul>
      ) : <p>Your cart is empty!</p>}
    </aside>
  ) : null;
}

React

src/components/CartFlyout.jsx

import { useStore } from '@nanostores/react';
import { isCartOpen, cartItems } from '../cartStore';

export default function CartFlyout() {
  const $isCartOpen = useStore(isCartOpen);
  const $cartItems = useStore(cartItems);

  return $isCartOpen ? (
    <aside>
      {Object.values($cartItems).length ? (
        <ul>
          {Object.values($cartItems).map(cartItem => (
            <li>
              <img src={cartItem.imageSrc} alt={cartItem.name} />
              <h3>{cartItem.name}</h3>
              <p>Quantity: {cartItem.quantity}</p>
            </li>
          ))}
        </ul>
      ) : <p>Your cart is empty!</p>}
    </aside>
  ) : null;
}

Solid

src/components/CartFlyout.jsx

import { useStore } from '@nanostores/solid';
import { isCartOpen, cartItems } from '../cartStore';

export default function CartFlyout() {
  const $isCartOpen = useStore(isCartOpen);
  const $cartItems = useStore(cartItems);

  return $isCartOpen() ? (
    <aside>
      {Object.values($cartItems()).length ? (
        <ul>
          {Object.values($cartItems()).map(cartItem => (
            <li>
              <img src={cartItem.imageSrc} alt={cartItem.name} />
              <h3>{cartItem.name}</h3>
              <p>Quantity: {cartItem.quantity}</p>
            </li>
          ))}
        </ul>
      ) : <p>Your cart is empty!</p>}
    </aside>
  ) : null;
}

Svelte

src/components/CartFlyout.svelte

<script>
  import { isCartOpen, cartItems } from '../cartStore';
</script>

{#if $isCartOpen}
  {#if Object.values($cartItems).length}
    <aside>
      {#each Object.values($cartItems) as cartItem}
      <li>
        <img src={cartItem.imageSrc} alt={cartItem.name} />
        <h3>{cartItem.name}</h3>
        <p>Quantity: {cartItem.quantity}</p>
      </li>
      {/each}
    </aside>
  {#else}
    <p>Votre panier est vide !</p>
  {/if}
{/if}

Vue

src/components/CartFlyout.vue

<template>
  <aside v-if="$isCartOpen">
    <ul v-if="Object.values($cartItems).length">
      <li v-for="cartItem in Object.values($cartItems)" v-bind:key="cartItem.name">
        <img :src=cartItem.imageSrc :alt=cartItem.name />
        <h3>{{cartItem.name}}</h3>
        <p>Quantité : {{cartItem.quantity}}</p>
      </li>
    </ul>
    <p v-else>Votre panier est vide !</p>
  </aside>
</template>

<script setup>
  import { cartItems, isCartOpen } from '../cartStore';
  import { useStore } from '@nanostores/vue';

  const $isCartOpen = useStore(isCartOpen);
  const $cartItems = useStore(cartItems);
</script>

Lit

src/components/CartFlyout.ts

import { LitElement, html } from 'lit';
import { isCartOpen, cartItems } from '../cartStore';
import { StoreController } from '@nanostores/lit';

export class CartFlyoutLit extends LitElement {
  private cartOpen = new StoreController(this, isCartOpen);
  private getCartItems = new StoreController(this, cartItems);

  renderCartItem(cartItem) {
    return html`
      <li>
        <img src="${cartItem.imageSrc}" alt="${cartItem.name}" />
        <h3>${cartItem.name}</h3>
        <p>Quantité : ${cartItem.quantity}</p>
      </li>
    `;
  }

  render() {
    return this.cartOpen.value
      ? html`
          <aside>
            ${
              Object.values(this.getCartItems.value).length
                ? html`
                  <ul>
                    ${Object.values(this.getCartItems.value).map((cartItem) =>
                      this.renderCartItem(cartItem)
                    )}
                  </ul>
                `
                : html`<p>Votre panier est vide !</p>`
            }
          </aside>
        `
      : null;
  }
}

customElements.define('cart-flyout', CartFlyoutLit);

Maintenant, vous devriez avoir un exemple de e-commerce entièrement interactif avec le plus petit bundle de JS de la galaxie 🚀

Essayez l’exemple complété sur votre machine ou en ligne via StackBlitz!