Skip to content

Toast ​

La pile visible.

Un seul <Toaster /> à la racine de l'application. Il rend les six coins : une annonce peut choisir le sien, ce qui permet à une confirmation d'apparaître près du geste qui l'a déclenchée et à une panne générale de s'imposer en haut de l'écran.

Installation ​

bash
sia-ui add toast

Ou par le paquet, sans rien copier :

tsx
import { Toaster, ToastProvider, useToast } from "@sia-ui/react-web";

Props de Toaster ​

PropTypeDéfautDescription
classNamestring—
containerHTMLElement—Où rendre la pile. Par défaut, un nœud créé sous document.body. À fournir quand le thème est porté par un conteneur plutôt que par la racine du document : sorties de ce conteneur, les annonces perdraient ses variables et s'afficheraient dans le thème clair.
durationnumber—Durée par défaut, pour les tons qui n'en imposent pas une.
limitnumber—Nombre visible simultanément. Au-delà, la plus ancienne s'efface.
offsetstring | number1remDécalage depuis le bord de l'écran.
placementToastPlacementbottom-rightCoin par défaut des annonces qui n'en précisent pas.
spinnerPropsSpinnerProps—Les props du Spinner des annonces en attente (toast.loading, toast.promise) — variante, taille. Sans effet sur une annonce qui fournit sa propre icon.
widthstring | number24remLargeur d'une annonce.

Props de ToastProvider ​

Enveloppe les enfants et monte le Toaster.

Aucun contexte : le magasin vit hors de React. Ce composant n'existe que pour monter la pile au bon endroit sans y penser.

PropTypeDéfautDescription
classNamestring—
containerHTMLElement—Où rendre la pile. Par défaut, un nœud créé sous document.body. À fournir quand le thème est porté par un conteneur plutôt que par la racine du document : sorties de ce conteneur, les annonces perdraient ses variables et s'afficheraient dans le thème clair.
durationnumber—Durée par défaut, pour les tons qui n'en imposent pas une.
limitnumber—Nombre visible simultanément. Au-delà, la plus ancienne s'efface.
offsetstring | number—Décalage depuis le bord de l'écran.
placementToastPlacement—Coin par défaut des annonces qui n'en précisent pas.
spinnerPropsSpinnerProps—Les props du Spinner des annonces en attente (toast.loading, toast.promise) — variante, taille. Sans effet sur une annonce qui fournit sa propre icon.
widthstring | number—Largeur d'une annonce.

Voir aussi ​

Publié sous licence MIT.