Vaya a Alpine docs para la mayoría de las cosas: Alpine Docs
Le invitamos a enviar actualizaciones de los documentos enviando un PR a este repositorio. Los documentos se encuentran en el directorio /packages/docs
.
Quédese aquí para obtener información relacionada con las contribuciones.
¿Busca documentos V2? aqui estan
npm install
y npm run build
/packages/alpinejs/dist/cdn.js
de una etiqueta <script>
en una página web y ¡listo! Puede instalar todo con: npm install
en el directorio raíz de este repositorio después de clonarlo localmente.
Este repositorio es un "mono-repositorio" que utiliza espacios de trabajo npm para administrar los paquetes. Cada paquete tiene su propia carpeta en el directorio /packages
.
En lugar de tener que ejecutar compilaciones separadas para cada paquete, todos los paquetes de paquetes se manejan con el mismo comando: npm run build
Aquí hay un breve vistazo a cada paquete en este repositorio:
Paquete | Descripción |
---|---|
alpinejs | El repositorio principal de Alpine con todo el núcleo de Alpine. |
colapsar | Un complemento para expandir y contraer elementos usando animaciones fluidas. |
csp | Un repositorio para proporcionar una versión "segura para CSP" de Alpine |
documentos | La documentación alpina |
enfocar | Un complemento que te permite administrar el foco dentro de un elemento. |
historia | Un complemento para vincular datos para consultar parámetros de cadena utilizando la API de historial (es probable que el nombre cambie) |
intersecarse | Un complemento para activar expresiones JS basadas en elementos que se cruzan con la ventana gráfica |
mascarilla | Un complemento para formatear automáticamente un campo de entrada de texto mientras el usuario escribe |
transformarse | Un complemento para transformar HTML (como morphdom) dentro de la página de manera inteligente |
persistir | Un complemento para conservar el estado alpino a través de cargas de página |
Los archivos JS compilados (como resultado de ejecutar npm run [build/watch]
) que se incluirán como una etiqueta <script>
, por ejemplo, se almacenan en el directorio packages/[package]/dist
de cada paquete.
Cada paquete debe tener al menos: una compilación "cdn" que se autoinicializa y se puede incluir usando el atributo src
en una etiqueta <script defer>
, y un archivo module.[esm/cjs].js
que se usa para importar como módulo JS (cjs para nodo, esm para todo lo demás).
El paquete para Alpine V3 está a cargo exclusivamente de ESBuild. Toda la configuración de estas compilaciones se almacena en el archivo scripts/build.js
.
Se utilizan dos herramientas de prueba diferentes en este repositorio: Cypress (para pruebas de integración) y Jest (para pruebas unitarias).
Todas las pruebas se almacenan dentro de la carpeta /tests
en /tests/cypress
y /tests/jest
.
Puede ejecutar ambos desde la línea de comando usando: npm run test
Si solo desea ejecutar cypress y abrir su interfaz de usuario (recomendado durante el desarrollo), puede ejecutar: npm run cypress
Si desea ejecutar solo pruebas de Jest, puede ejecutar npm run jest
como de costumbre y apuntar a pruebas específicas. Puede especificar opciones de configuración de la línea de comando para reenviar al comando jest con --
así: npm run jest -- --watch