dbravoan / dbcms-blocks-scrollytelling
Accessible scroll-based editorial composition for dbCMS
Package info
github.com/dbravoan/dbcms-blocks-scrollytelling
Language:JavaScript
Type:dbcms-block-package
pkg:composer/dbravoan/dbcms-blocks-scrollytelling
Requires
- php: ^8.4
- dbravoan/dbcms-core: ~0.0.1
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Bloque editorial para montar desde una entrada sencilla hasta una landing de producto con capítulos, giro por fotogramas, paletas sincronizadas y marquesina reactiva. El editor y MCP trabajan sobre la misma composición de dbCMS.
Instalación
El paquete requiere PHP 8.4 y declara dbravoan/dbcms-core:~0.0.1 en Composer. Instálalo desde la raíz de la aplicación y compila sus recursos Vite. Estos comandos usan Sail.
./vendor/bin/sail composer require dbravoan/dbcms-blocks-scrollytelling ./vendor/bin/sail npm run build
En Sistema y ajustes → Paquetes de bloques, habilita Scrollytelling. Añade el bloque a una sección propia y elige un preset o una composición en blanco.
Composición
Cada escena tiene una disposición y capas en orden de lectura. Las capas persistentes conservan una instancia de principio a fin del rango de escenas que se les asigna. Dentro de una capa se pueden componer bloques registrados. Los puntos de cambio gobiernan visibilidad y paleta. Los fotogramas editoriales enlazan valores de movimiento, postura o giro con un porcentaje de recorrido. El esquema y los presets se descubren mediante cms_block_types.
El servidor entrega títulos, texto, vínculos, leyendas y un póster de dimensiones conocidas. Búsqueda y los lectores de GEO recorren las mismas escenas y zonas editoriales desde la vista publicada del mercado y el idioma. Las disposiciones animadas amplían ese HTML con CSS, Web Animations y canvas 2D. La lectura lineal conserva todos los capítulos con JavaScript desactivado o preferencia de movimiento reducido.
Fotogramas
La importación del editor admite de 2 a 512 PNG o WebP numerados consecutivamente y con las mismas dimensiones. Prepara un póster y láminas de hasta 16 imágenes. La variante móvil reduce resolución y número de fotogramas. Se descarga por delante el muestreo de baja resolución y se solicita el detalle según la posición y la dirección del scroll. El reproductor comparte una cola de cuatro descargas y un presupuesto de memoria decodificada de 96 MiB. El póster y el fotograma disponible más cercano mantienen el producto visible cuando falta detalle.
El empaquetador CLI usa PHP con GD. Indica los directorios de origen y destino y añade --mobile para generar una variante móvil. La herramienta genera manifest.json junto al póster y a las láminas. Sube las imágenes a la biblioteca multimedia y usa sus identificadores en el bloque. Las URLs versionadas permiten caché inmutable en el CDN.
php tools/prepare-frames.php /tmp/bruma-frames /tmp/bruma-atlas --mobile
Desarrollo
| Pieza | Qué reutilizar al extenderla |
|---|---|
ScrollytellingBlock |
Registro, validación estructural, zonas de hijos, resolución de vistas y lectura semántica de Core. |
StorySchema y StoryPresets |
Una definición de campos para el editor y MCP. Las escenas, capas, puntos de cambio y fotogramas usan identificadores estables. |
StoryMedia |
Biblioteca y MediaUrlResolver de Core para medios, dimensiones y URLs. |
Resources/js/admin.js |
Puente del gestor de bloques, inspector y biblioteca. Cada montaje devuelve su limpieza. |
Resources/js/public.js |
HTML del servidor como base de lectura. motion.js resuelve recorrido y poses, sequence.js carga las secuencias y blocks.css presenta el contenido. |
Antes de añadir un campo o gesto, busca una capa, bloque hijo o control del inspector que cubra el caso. Amplía el esquema y el dueño de la operación. Define las rutas traducibles y comprueba las variantes del ejemplo. Convenciones de Core
Ejecuta npm test desde el checkout para verificar orden de fotogramas,
interpolación y mapeo de láminas. Para integración, usa una aplicación
desechable con el paquete y Core como repositorios Composer path. Compila los
recursos, comprueba el bloque en ambos recorridos y revisa el contenido público
con movimiento reducido y en móvil.