WS
Docs /Démarrage/API JavaScript

API JavaScript

Après avoir ajouté @wsScripts dans votre layout, les helpers suivants sont disponibles globalement dans le navigateur.

DsToast — Notifications

Déclenche des notifications flottantes gérées par le composant <livewire:ws::toast />.

Prérequis : <livewire:ws::toast /> doit être présent dans votre layout principal.

Aperçu — 4 types de toast
DsToast.success(message, options = {});
DsToast.error(message, options = {});
DsToast.warning(message, options = {});
DsToast.info(message, options = {});
Option Type Défaut Description
titlestring—Titre affiché en gras au-dessus du message
durationnumber4000Durée en ms avant auto-dismiss (0 = persistant)
// Simple
DsToast.success("Enregistré avec succès");
DsToast.error("Une erreur est survenue");

// Avec titre
DsToast.success("Le fichier a été importé.", { title: "Import réussi" });

// Persistant (fermeture manuelle)
DsToast.error("Connexion refusée", { title: "Erreur réseau", duration: 0 });

// Durée personnalisée
DsToast.info("Redirection dans 3 secondes...", { duration: 3000 });

DsModal — Modales

Contrôle des composants <livewire:ws::modal> par leur modal-id.

Aperçu
DsModal.open("identifiant-de-la-modale");
DsModal.close("identifiant-de-la-modale");


<livewire:ws::modal modal-id="confirm-delete" title="Confirmer">
    Êtes-vous sûr de vouloir supprimer cet élément ?
</livewire:ws::modal>

<!-- Déclencheur -->
<button onclick="DsModal.open('confirm-delete')">Ouvrir</button>

DsDrawer — Panneaux coulissants

Contrôle des composants <livewire:ws::drawer> par leur drawer-id.

Aperçu
DsDrawer.open("identifiant-du-drawer");
DsDrawer.close("identifiant-du-drawer");

<livewire:ws::drawer drawer-id="user-settings" title="Paramètres">
    <!-- contenu -->
</livewire:ws::drawer>

<button onclick="DsDrawer.open('user-settings')">Ouvrir</button>

DsCommandPalette — Palette de commandes

Contrôle du composant <livewire:ws::command-palette>.

Raccourci clavier intégré : ⌘K (macOS) ou Ctrl+K ouvre automatiquement la palette sans configuration supplémentaire.

DsCommandPalette.open();
DsCommandPalette.close();
<button onclick="DsCommandPalette.open()">
    Rechercher...
    <span class="text-xs opacity-60">⌘K</span>
</button>

DsCopy — Presse-papiers

Copie du texte dans le presse-papiers avec feedback visuel optionnel. Le composant <x-ws::copy-button> utilise DsCopy en interne.

// Retourne true si la copie a réussi
const success = await DsCopy.copy(text, buttonElement);

// Exemple avec un élément bouton pour le feedback visuel
const btn = document.getElementById('copy-btn');
const ok = await DsCopy.copy('npm install wirestack-ui', btn);
if (ok) { console.log('Copié !'); }

Utilisation depuis Livewire (PHP)

Vous pouvez déclencher les helpers JS depuis un composant Livewire via $this->dispatch() :

// Dans un composant Livewire

// Toast
$this->dispatch('ds-toast', type: 'success', message: 'Enregistré !');
$this->dispatch('ds-toast', type: 'error', message: 'Erreur', title: 'Oops');

// Modal
$this->dispatch('ds-modal-open:confirm-delete');
$this->dispatch('ds-modal-close:confirm-delete');

// Drawer
$this->dispatch('ds-drawer-open:user-settings');
$this->dispatch('ds-drawer-close:user-settings');

Ou depuis une vue Blade avec $dispatch Alpine.js :

<x-ws::button
    x-on:click="$dispatch('ds-toast', { type: 'success', message: 'Action réussie !' })"
>
    Envoyer
</x-ws::button>

<x-ws::button
    x-on:click="$dispatch('ds-modal-open:confirm-delete')"
    color="danger"
>
    Supprimer
</x-ws::button>