alpine
v3.14.3
Accédez à la documentation Alpine pour la plupart des choses : Alpine Docs
Vous êtes invités à soumettre des mises à jour des documents en soumettant un PR à ce dépôt. Les documents se trouvent dans le répertoire /packages/docs .
Restez ici pour obtenir des informations relatives aux contributions.
Vous recherchez de la documentation sur la V2 ? les voici
npm install et npm run build/packages/alpinejs/dist/cdn.js à partir d'une balise <script> sur une page Web et vous êtes prêt à partir ! Vous pouvez tout installer avec : npm install dans le répertoire racine de ce dépôt après l'avoir cloné localement.
Ce dépôt est un "mono-repo" utilisant des espaces de travail npm pour gérer les packages. Chaque package possède son propre dossier dans le répertoire /packages .
Plutôt que d'avoir à exécuter des builds distincts pour chaque package, tous les packages sont gérés avec la même commande : npm run build
Voici un bref aperçu de chaque package dans ce dépôt :
| Emballer | Description |
|---|---|
| alpinjs | Le dépôt principal d'Alpine avec tout le noyau d'Alpine |
| effondrement | Un plugin pour développer et réduire des éléments à l'aide d'animations fluides |
| csp | Un dépôt pour fournir une version « CSP safe » d'Alpine |
| documents | La documentation alpine |
| se concentrer | Un plugin qui permet de gérer le focus à l'intérieur d'un élément |
| histoire | Un plugin pour lier des données aux paramètres de chaîne de requête à l'aide de l'API d'historique (le nom est susceptible de changer) |
| couper | Un plugin pour déclencher des expressions JS basées sur des éléments croisant la fenêtre |
| masque | Un plugin pour formater automatiquement un champ de saisie de texte au fur et à mesure que l'utilisateur tape |
| se transformer | Un plugin pour transformer intelligemment le HTML (comme morphdom) à l'intérieur de la page |
| persister | Un plugin pour conserver l'état alpin lors des chargements de pages |
Les fichiers JS compilés (à la suite de l'exécution de npm run [build/watch] ) à inclure en tant que balise <script> par exemple sont stockés dans le répertoire packages/[package]/dist de chaque package.
Chaque package doit au moins avoir : une version "cdn" qui s'initialise automatiquement et peut être incluse à l'aide de l'attribut src dans une balise <script defer> , et un fichier module.[esm/cjs].js utilisé pour l'importation. en tant que module JS (cjs pour node, esm pour tout le reste).
Le regroupement pour Alpine V3 est géré exclusivement par ESBuild. Toute la configuration de ces builds est stockée dans le fichier scripts/build.js .
Il existe 2 outils de test différents utilisés dans ce référentiel : Cypress (pour les tests d'intégration) et Jest (pour les tests unitaires).
Tous les tests sont stockés dans le dossier /tests sous /tests/cypress et /tests/jest .
Vous pouvez les exécuter tous les deux à partir de la ligne de commande en utilisant : npm run test
Si vous souhaitez uniquement exécuter Cypress et ouvrir son interface utilisateur (recommandé lors du développement), vous pouvez exécuter : npm run cypress
Si vous souhaitez exécuter uniquement des tests Jest, vous pouvez exécuter npm run jest comme des tests normaux et cibler des tests spécifiques. Vous pouvez spécifier les options de configuration de ligne de commande à transférer vers la commande jest avec -- comme ceci : npm run jest -- --watch
