Documentación y API
Referencia técnica completa de @pablotheblink/scopejs: Component, Modal arrastrable, Router SPA con rutas anidadas y utilidades.
Componentes Component(options)
Guía detallada →Crea componentes reutilizables con controlador ES6, plantilla HTML, CSS encapsulado, data binding model y renderizado quirúrgico.
| Propiedad | Tipo · Defecto | Descripción |
|---|---|---|
| controlleropcional | new () => any defecto: — |
Clase controladora con el estado reactivo, getters y métodos invocables desde eventos HTML. |
| renderrequerido | () => string defecto: — |
Función vinculada al controlador que devuelve la plantilla HTML del componente. |
| styleopcional | string defecto: '' |
CSS encapsulado (scoped) que solo afecta al contenedor del componente. |
| tagNameopcional | string defecto: automático |
Nombre del elemento personalizado en el DOM donde se encapsula el componente. |
| postRenderopcional | () => void defecto: null |
Callback ejecutado tras insertar y actualizar el DOM del componente. |
| title / metaopcional | string / Array<{name, content}> defecto: — |
Actualiza el título de la pestaña y las metaetiquetas SEO al montar la vista. |
import { Component } from "@pablotheblink/scopejs";
const Hello = Component({ controller: class { constructor() { this.msg = "Hola"; } }, render() { return `<h1>${this.msg}</h1>`; } });
Hello.render(document.getElementById("app"));
Modales y ventanas Modal(options)
Guía detallada →Lanza modales clásicos con overlay o múltiples ventanas arrastrables simultáneas con barra de título y apilamiento automático.
| Opción | Tipo · Defecto | Descripción |
|---|---|---|
| titlev2.0.6+ | string defecto: '' |
Texto mostrado en la barra de título superior de la ventana modal. |
| draggablev2.0.6+ | boolean defecto: false |
Permite arrastrar la ventana desde su barra de título respetando los límites del viewport. |
| windowModev2.0.6+ | boolean defecto: false |
Abre el modal sin overlay de fondo y habilita múltiples ventanas simultáneas con apilamiento z-index. |
| hideWhenClickOverlayopcional | boolean defecto: false |
Cierra el modal clásico al pulsar sobre el fondo semitransparente. |
| positionopcional | { x: number, y: number } defecto: centrado |
Coordenadas iniciales personalizadas de la ventana en el viewport. |
| resizable / classNameopcional | boolean / string defecto: false / '' |
Habilita redimensionado de ventana o añade clases CSS adicionales al contenedor. |
Modal({ title: "Ajustes", draggable: true, windowMode: true, render() { return `<button onclick="close()">Cerrar</button>`; } });
Router SPA Router(routes, options)
Guía detallada →Enrutador ligero con rutas dinámicas (:id), middleware de validación, modo hash o History API y suscripción a cambios de ruta.
| Método / Opción | Firma · Defecto | Descripción |
|---|---|---|
| navigate(path, body?)método | (string, any?) => void defecto: — |
Navega programáticamente a la ruta indicada y opcionalmente pasa datos a la vista. |
| render(container)método | (HTMLElement) => void defecto: — |
Monta el router sobre el nodo contenedor principal de la SPA. |
| listen(callback)método | (fn) => string defecto: — |
Suscribe un listener a cada cambio de ruta y devuelve su UUID para cancelarlo. |
| unlisten(uuid)método | (string) => void defecto: — |
Elimina un listener de navegación previamente registrado. |
| useHashopción | boolean defecto: false |
Activa navegación basada en hash (#/ruta) ideal para alojamientos estáticos. |
const router = Router([{ path: "/", controller: Home }, { path: "/usuario/:id", controller: User }]);
router.render(document.getElementById("app"));
Rutas anidadas <router-outlet>
Guía detallada →Mantén un layout padre fijo con barra de navegación mientras las rutas hijas se montan y limpian dentro de <router-outlet>.
| Propiedad / Método | Tipo · Uso | Descripción |
|---|---|---|
| childrenv2.0.5+ | RouteConfig[] defecto: [] |
Lista de rutas hijas que heredan el prefijo del path padre. |
| <router-outlet>etiqueta | HTML element defecto: — |
Marcador dentro del componente padre donde se inyecta la vista hija activa. |
| getAllRoutes()método | () => RouteConfig[] defecto: — |
Devuelve la lista aplanada de todas las rutas registradas, incluidas las anidadas. |
| getChildRoutes(parentPath)método | (string) => RouteConfig[] defecto: — |
Obtiene las rutas hijas asociadas a una ruta padre concreta. |
const childRoutes = appRouter.getChildRoutes("/admin");
const allRoutes = appRouter.getAllRoutes();
Utilidades, lazy y view transitions
Guía detallada →Modo depuración, carga diferida de imágenes (lazy), aparición suave (fadeIn) y transiciones automáticas entre vistas por ID.
| Utilidad / Atributo | Tipo · Uso | Descripción |
|---|---|---|
| enableDebugger(flag)función | (boolean) => void defecto: false |
Activa o desactiva trazas detalladas de depuración en consola. |
| this.apply()método | () => void defecto: — |
Dispara el renderizado quirúrgico del componente tras modificar su estado. |
| this.close(...args)método | (...any) => void defecto: — |
Cierra el modal activo y libera sus listeners de arrastre y teclado. |
| lazy / fadeInatributos | HTML boolean defecto: — |
Atributos integrados para carga diferida de imágenes y aparición animada al entrar en pantalla. |
import { enableDebugger } from "@pablotheblink/scopejs";
enableDebugger(true);