npm.io
3.0.1 • Published 22h ago

@soyleninjs/swappit

Licence
MIT
Version
3.0.1
Deps
0
Size
39 kB
Vulns
0
Weekly
0
Stars
1

Swappit

Swappit es una librería JavaScript ligera que permite actualizar parcial o totalmente el contenido HTML de tu sitio web sin recargar la página. Con un enfoque declarativo basado en atributos data personalizados, facilita la creación de experiencias de navegación modernas sin la complejidad de un framework completo o SPA.

Características principales:

  • Actualización parcial del DOM: Reemplaza solo los elementos que necesitas usando identificadores únicos (handles)
  • Tres formas de uso: API JavaScript, links automáticos con data-swappit-handle, o componente <swappit-instance>
  • Precarga inteligente: Configura precarga instantánea o al hacer hover, a nivel global o por link individual
  • Navegación con historial: Soporte para botones adelante/atrás del navegador
  • Sistema de caché: Controla cuándo usar caché o forzar nuevas descargas
  • Detección automática: Observador de DOM que configura nuevos links dinámicamente
  • Sistema de eventos: Escucha eventos antes/después de actualizar, en errores, al navegar por historial y al destruir
  • Logging colorido: Sistema de debugging con 4 niveles (info, success, warning, error)
  • Zero-config: Funciona con configuración mínima, personalizable según necesites

Menú

Instalación

Puedes integrar Swappit en tu proyecto de las siguientes formas:

NPM
npm install @soyleninjs/swappit

Luego inclúyelo en tu HTML como script:

<script src="node_modules/@soyleninjs/swappit/swappit.min.js"></script>

La clase Swappit queda disponible globalmente en window una vez cargado el script, y el componente <swappit-instance> ya se puede utilizar.

CDN
<script src="https://cdn.jsdelivr.net/npm/@soyleninjs/swappit/swappit.min.js"></script>
Descarga directa
  1. Descarga swappit.min.js desde GitHub Releases
  2. Inclúyelo en tu HTML:
<script src="ruta/a/tu/proyecto/swappit.min.js"></script>

Nota: El archivo swappit.min.js incluye tanto la clase Swappit como el componente <swappit-instance>.

Uso básico

Swappit ofrece tres formas principales de uso:

1. Usando el componente <swappit-instance> (Recomendado para configuración declarativa)
<!-- Elementos que se actualizarán -->
<div data-mi-handle-update="header">Contenido original del header</div>
<div data-mi-handle-update="main">Contenido original del main</div>

<!-- Crear instancia con configuración declarativa -->
<swappit-instance
  data-handle="mi-handle"
  data-log
  data-update-url
  data-enable-history
  data-preload="hover">
</swappit-instance>

<!-- Links que usarán esta instancia -->
<a href="./pagina1.html" data-swappit-handle="mi-handle">Página 1</a>
<a href="./pagina2.html" data-swappit-handle="mi-handle">Página 2</a>

<script src="ruta/a/swappit.min.js"></script>
<!-- Elementos que se actualizarán -->
<div data-mi-handle-update="header">Contenido original del header</div>
<div data-mi-handle-update="main">Contenido original del main</div>

<!-- Links con atributo data-swappit-handle -->
<a href="./pagina1.html" data-swappit-handle="mi-handle">Página 1</a>
<a href="./pagina2.html" data-swappit-handle="mi-handle" data-preload="hover">Página 2 (Precarga al pasar el mouse)</a>
<a href="./pagina3.html" data-swappit-handle="mi-handle" data-preload="instant">Página 3 (Precarga instantánea)</a>

<script>
  // Crear una instancia de Swappit
  const swappit = new Swappit('mi-handle');
  // Los links se configuran automáticamente
</script>
3. Usando la API de JavaScript directamente
<script>
  const swappit = new Swappit('mi-handle');

  // Actualizar contenido desde una URL relativa (usando caché por defecto)
  swappit.update('./contenido-demo.html');

  // Para forzar nueva descarga, pasa false como segundo parámetro
  swappit.update('./contenido-demo.html', false);
</script>

Ejemplos

Ejemplo 1: Actualización básica de contenido

HTML:

<div data-mi-app-update="header">
  <h1>Título original</h1>
</div>
<div data-mi-app-update="content">
  <p>Contenido original</p>
</div>

JavaScript:

const appBasico = new Swappit('mi-app');
function actualizarContenido() {
  appBasico.update('./contenido-nuevo.html');
}
Ejemplo 2: Actualización con orden específico

Los elementos con data-[handle]-update-order se actualizan primero (de menor a mayor). Los que no tienen este atributo se actualizan al final.

HTML:

<!-- Se actualizan primero, de menor a mayor valor de order -->
<div data-mi-app-orden-update="section1" data-mi-app-orden-update-order="2">Sección 1 (Orden: 2)</div>
<div data-mi-app-orden-update="section2" data-mi-app-orden-update-order="1">Sección 2 (Orden: 1)</div>
<!-- Se actualiza al final por no tener order -->
<div data-mi-app-orden-update="section3">Sección 3 (Sin orden, se actualiza al final)</div>

El orden de ejecución será: section2 → section1 → section3.

JavaScript:

const appOrdenado = new Swappit('mi-app-orden');
appOrdenado.update('./contenido-ordenado.html');
Ejemplo 3: Precarga de múltiples URLs

HTML:

<div data-mi-app-precarga-update="header" class="preload-section">...</div>
<div data-mi-app-precarga-update="main" class="preload-section">...</div>
<div data-mi-app-precarga-update="footer" class="preload-section">...</div>

JavaScript:

const appPrecarga = new Swappit('mi-app-precarga');
appPrecarga.preloadContents(['./header.html', './main.html', './footer.html']);
function actualizarHeader() {
  appPrecarga.update('./header.html');
}
function actualizarMain() {
  appPrecarga.update('./main.html');
}
function actualizarFooter() {
  appPrecarga.update('./footer.html', false);
}

Opciones de configuración

new Swappit(handle, options = {})
Parámetro Tipo Descripción
handle string Identificador único para la instancia (obligatorio)
options object Objeto con todas las opciones de configuración (opcional)

Todas las opciones de configuración se pasan dentro del objeto options. No hay parámetros adicionales fuera de él.

Opciones disponibles (options)
Opción Tipo Default Descripción
log boolean false Activa/desactiva los logs de la consola
updateUrl boolean false Actualiza la URL en la barra del navegador al hacer update
enableHistory boolean false Habilita navegación con botones adelante/atrás del navegador. Requiere updateUrl: true
preload string|false false Modo de precarga por defecto para links con data-swappit-handle. Valores: false, "hover", "instant"

Notas:

  • enableHistory: true no tiene efecto si updateUrl no está en true. El listener de popstate solo se registra cuando ambas opciones están activas
  • updateUrl: true + enableHistory: false: actualiza la URL en cada navegación sin agregar entradas al historial (usa replaceState)
  • updateUrl: true + enableHistory: true: actualiza la URL y agrega cada navegación al historial del navegador (usa pushState), habilitando los botones adelante/atrás
  • Solo una instancia puede controlar el historial a la vez. Intentar crear una segunda instancia con updateUrl: true + enableHistory: true lanzará un error
  • preload: define el comportamiento por defecto para todos los links gestionados, pero puede ser sobreescrito individualmente con el atributo data-preload en cada link
Atributos de datos para elementos que se actualizan
Atributo Descripción
data-[handle]-update Identificador del elemento a actualizar (obligatorio)
data-[handle]-update-order Orden de actualización (opcional, numérico). Los elementos con este atributo se actualizan primero, de menor a mayor valor; los elementos sin este atributo se actualizan al final
Atributo Tipo Descripción
data-swappit-handle string Conecta el link con una instancia Swappit (obligatorio)
data-preload string Modo de precarga: "instant" (inmediata al cargar), "hover" (al pasar mouse/touch), o sin definir (solo al hacer click)
data-use-cache boolean Si es "true" usa caché, si es "false" fuerza nueva descarga al hacer click. Default: true

Métodos

Métodos de instancia
Método Descripción
update(url, useCache = true) Carga el HTML de url y reemplaza las regiones del DOM correspondientes.
- url: Ruta relativa (debe empezar con / o ./)
- useCache: true usa caché si existe, false fuerza una nueva descarga
preloadContents(arrayUrls) Precarga en paralelo el contenido de un array de URLs relativas y las almacena en caché sin actualizar el DOM
reinit(options = {}) Actualiza las opciones de la instancia (merge) y reinicializa sus handlers y el observer del DOM.
- options: Objeto con las propiedades que se desean sobreescribir
destroy() Destruye la instancia de forma definitiva: limpia la caché, cancela peticiones pendientes, elimina todos los listeners y el observer del DOM, y la borra del registro Swappit.instances
Métodos estáticos
Método Descripción
Swappit.updateScriptByContent(arrayScriptsNodes) Recibe un array de nodos <script> inline y los recrea en el DOM para forzar su re-ejecución
Swappit.updateScriptBySrc(matchUrl) Recarga los scripts externos cuyo atributo src contenga matchUrl, agregando un timestamp para evitar caché del navegador
Swappit.instances Propiedad estática. Map con todas las instancias Swappit activas, indexadas por su handle

Eventos

Swappit emite eventos personalizados en window que puedes escuchar:

Evento Cuándo se emite Detalle (e.detail)
swappit:[handle]:update:before Antes de iniciar la carga y actualización del DOM { handle: string, url: string }
swappit:[handle]:update:after Después de actualizar el DOM correctamente { handle: string, url: string }
swappit:[handle]:update:error Cuando ocurre un error al actualizar { handle: string, url: string }
swappit:[handle]:historyUpdate:before Antes de actualizar por navegación del historial { handle: string, url: string }
swappit:[handle]:historyUpdate:after Después de actualizar por navegación del historial { handle: string, url: string }
swappit:[handle]:historyUpdate:error Cuando ocurre un error al navegar por el historial { handle: string, url: string }
swappit:[handle]:reinit Después de reiniciar la instancia { handle: string, url: "" }
swappit:[handle]:destroy Después de destruir la instancia { handle: string, url: "" }

Ejemplo de uso:

window.addEventListener('swappit:mi-handle:update:before', (e) => {
  console.log('Comenzando actualización', e.detail);
  // e.detail = { handle: 'mi-handle', url: './pagina.html' }
});

window.addEventListener('swappit:mi-handle:update:after', (e) => {
  console.log('Contenido actualizado', e.detail);
  // Aquí puedes reinicializar scripts, ejecutar animaciones, etc.
});

window.addEventListener('swappit:mi-handle:update:error', (e) => {
  console.log('Error al actualizar', e.detail);
});

window.addEventListener('swappit:mi-handle:historyUpdate:after', (e) => {
  console.log('Navegación por historial completada', e.detail);
});

window.addEventListener('swappit:mi-handle:reinit', (e) => {
  console.log('Instancia reiniciada', e.detail);
});

window.addEventListener('swappit:mi-handle:destroy', (e) => {
  console.log('Instancia destruida', e.detail);
});

Logging

Swappit incluye un sistema de logging con 4 niveles: info (azul), success (verde), warning (amarillo), error (rojo). Actívalo mediante la opción log: true al crear la instancia:

const app = new Swappit('mi-app', { log: true });

O de forma declarativa con <swappit-instance>:

<swappit-instance data-handle="mi-app" data-log></swappit-instance>

Patrones de uso

Identificadores únicos

Cada instancia debe tener un handle único, que se usará como prefijo en los atributos data:

const app1 = new Swappit('mi-app');    // data-mi-app-update
const app2 = new Swappit('otro-app'); // data-otro-app-update
Precarga de contenido

Puedes precargar contenido y luego actualizarlo usando la caché:

app.preloadContents(['./header.html', './main.html', './footer.html']);
app.update('./header.html');       // Usa caché
app.update('./footer.html', false); // Fuerza descarga
Validación de URLs

IMPORTANTE: Swappit solo acepta URLs relativas internas por seguridad:

// ✅ URLs válidas
app.update('/pagina.html');
app.update('./pagina.html');

// ❌ URLs inválidas (lanzarán error)
app.update('https://ejemplo.com/pagina.html'); // URL externa
app.update('pagina.html');                     // No empieza con / ni ./
app.update('../pagina.html');                  // Rutas con ../ no son permitidas

Esta validación se aplica a:

  • Método update(url)
  • Método preloadContents(arrayUrls)
  • Atributo href de links con data-swappit-handle

Configuración de páginas de destino

Las páginas de destino deben tener elementos con los mismos atributos data-[handle]-update que la página principal. Swappit solo actualiza los elementos que tienen correspondencia por nombre. Si en la página destino no existe un elemento correspondiente, el elemento actual en el DOM se oculta agregando la clase hidden.

Ejemplo:

Página principal:

<div data-mi-app-update="header">Encabezado original</div>
<div data-mi-app-update="sidebar">Barra lateral original</div>
<div data-mi-app-update="content">Contenido original</div>

Página destino:

<div data-mi-app-update="header">Nuevo encabezado</div>
<div data-mi-app-update="content">Nuevo contenido</div>
<!-- No incluye "sidebar": el elemento en el DOM recibirá la clase "hidden" -->
<div data-mi-app-update="footer">Este elemento será ignorado (no existe en la página principal)</div>

Consejos:

  • Usa los mismos nombres de atributos en todas tus páginas
  • Divide el contenido en componentes lógicos
  • Si necesitas orden de actualización, usa data-[handle]-update-order

Swappit incluye un sistema de observación del DOM que detecta automáticamente links con el atributo data-swappit-handle y los configura para actualizar el contenido sin recargar la página.

Uso básico
<!-- Crear instancia -->
<script>
  const app = new Swappit('mi-app');
</script>

<!-- Links automáticos -->
<a href="./pagina1.html" data-swappit-handle="mi-app">Ir a Página 1</a>
<a href="./pagina2.html" data-swappit-handle="mi-app">Ir a Página 2</a>

Cada link puede tener su propia configuración de precarga:

<!-- Sin precarga (solo carga al hacer click) -->
<a href="./pagina1.html" data-swappit-handle="mi-app">Página 1</a>

<!-- Precarga al pasar el mouse o touch -->
<a href="./pagina2.html" data-swappit-handle="mi-app" data-preload="hover">Página 2</a>

<!-- Precarga instantánea (al cargar la página) -->
<a href="./pagina3.html" data-swappit-handle="mi-app" data-preload="instant">Página 3</a>

<!-- Forzar descarga nueva sin usar caché -->
<a href="./pagina4.html" data-swappit-handle="mi-app" data-use-cache="false">Página 4</a>

Puedes definir un modo de precarga predeterminado para todos los links al crear la instancia:

const app = new Swappit('mi-app', {
  preload: 'hover' // Todos los links harán precarga al hover por defecto
});

Los links individuales pueden sobrescribir este comportamiento con su propio data-preload:

<!-- Usará 'hover' (default de la instancia) -->
<a href="./pagina1.html" data-swappit-handle="mi-app">Página 1</a>

<!-- Sobrescribe con precarga instantánea -->
<a href="./pagina2.html" data-swappit-handle="mi-app" data-preload="instant">Página 2</a>

Swappit observa cambios en el DOM y configura automáticamente los nuevos links que se agreguen dinámicamente:

// Los nuevos links se configurarán automáticamente
document.querySelector('#contenedor').innerHTML = `
  <a href="./nueva-pagina.html" data-swappit-handle="mi-app">Nueva Página</a>
`;
Ventajas de este método
  • Zero-config: Solo agrega el atributo data-swappit-handle a tus links
  • Precarga flexible: Configura precarga individual o global
  • Detección automática: Los links dinámicos se configuran automáticamente
  • Control de caché: Decide si usar caché o forzar descarga por link

Swappit Instance

Swappit incluye el custom element <swappit-instance> para crear instancias Swappit de forma declarativa usando atributos HTML.

Uso básico
<swappit-instance data-handle="mi-app"></swappit-instance>
Atributos disponibles
Atributo Tipo Descripción Valor predeterminado
data-handle string Identificador de la instancia Swappit (obligatorio) N/A
data-log boolean (presencia) Activa logs para la instancia false
data-update-url boolean (presencia) Actualiza la URL del navegador false
data-enable-history boolean (presencia) Habilita navegación con botones del navegador false
data-preload string Modo de precarga: "instant", "hover" false

Nota: Los atributos data-log, data-update-url y data-enable-history son de tipo booleano por presencia: se activan con solo incluirlos en el elemento, sin necesidad de asignarles un valor.

Comportamiento
  1. Crea o reinicia una instancia: Si no existe una instancia con ese data-handle, la crea. Si ya existe, la reinicia con las nuevas opciones.
  2. Configuración declarativa: Todos los atributos se mapean directamente a las opciones de Swappit.
  3. Funciona con links automáticos: Los links con data-swappit-handle que coincidan con el handle se configuran automáticamente.
  4. Reinicio automático: Si el componente ya tiene una instancia activa con ese handle, llama a reinit() para actualizar la configuración.
Ejemplo completo
<!DOCTYPE html>
<html lang="es">
<head>
  <meta charset="UTF-8">
  <title>Ejemplo Swappit Instance</title>
</head>
<body>
  <!-- Elementos que se actualizarán -->
  <div data-mi-app-update="header">
    <h1>Encabezado Original</h1>
  </div>

  <div data-mi-app-update="content">
    <p>Contenido original de la página</p>
  </div>

  <!-- Crear instancia con configuración completa -->
  <swappit-instance
    data-handle="mi-app"
    data-log
    data-update-url
    data-enable-history
    data-preload="hover">
  </swappit-instance>

  <!-- Navegación -->
  <nav>
    <a href="./pagina1.html" data-swappit-handle="mi-app">Página 1</a>
    <a href="./pagina2.html" data-swappit-handle="mi-app">Página 2</a>
    <a href="./pagina3.html" data-swappit-handle="mi-app" data-preload="instant">Página 3 (Precarga inmediata)</a>
    <a href="./pagina4.html" data-swappit-handle="mi-app" data-use-cache="false">Página 4 (Sin caché)</a>
  </nav>

  <script src="ruta/a/swappit.min.js"></script>

  <script>
    // Acceder a la instancia creada por el componente
    const miApp = Swappit.instances.get('mi-app');

    // Escuchar eventos
    window.addEventListener('swappit:mi-app:update:after', (e) => {
      console.log('Contenido actualizado:', e.detail);
    });
  </script>
</body>
</html>

Método reinit()

El método reinit() permite actualizar la configuración de una instancia Swappit existente y volver a inicializar sus handlers y observadores del DOM.

Sintaxis
instance.reinit(options)
Parámetros
  • options (object): Objeto con opciones para actualizar. Se hace merge con las opciones existentes; solo las propiedades que incluyas se sobreescriben.
Comportamiento
  1. Actualiza opciones: Hace merge de las nuevas opciones con las existentes
  2. Reinicia handlers: Vuelve a configurar el handler de historial según las nuevas opciones
  3. Reinicia observer: Vuelve a observar el DOM para detectar links con el handle
  4. Emite evento: Dispara el evento swappit:[handle]:reinit
Ejemplo de uso
const app = new Swappit('mi-app', {
  updateUrl: false,
  preload: false
});

// Después de un tiempo, cambiar la configuración
app.reinit({
  log: true,
  updateUrl: true,
  enableHistory: true,
  preload: 'hover'
});

// Ahora la instancia tiene:
// - log: true
// - updateUrl: true
// - enableHistory: true
// - preload: 'hover'
Cuándo usar reinit()
  • Cuando necesitas cambiar opciones dinámicamente
  • Cuando <swappit-instance> detecta que ya existe una instancia con ese handle
  • Al cambiar entre modos (por ejemplo, de desarrollo a producción)

Método destroy()

El método destroy() destruye completamente una instancia Swappit, liberando todos sus recursos.

Sintaxis
instance.destroy()
Comportamiento
  1. Marca la instancia como destruida: Bloquea el uso de update(), reinit() y preloadContents()
  2. Limpia la caché: Elimina todo el contenido almacenado
  3. Cancela peticiones pendientes: Incrementa el requestId para ignorar respuestas en vuelo
  4. Elimina el listener de historial: Desregistra el evento popstate si estaba activo
  5. Desconecta el MutationObserver: Deja de observar nuevos links en el DOM
  6. Limpia listeners de links: Elimina todos los eventos de click, hover y touch de los links gestionados
  7. Libera el control del historial: Si esta instancia era la controladora del historial, la libera
  8. Emite evento: Dispara swappit:[handle]:destroy
  9. Elimina del registro: Borra la instancia de Swappit.instances
Ejemplo de uso
const app = new Swappit('mi-app');

// Más tarde, cuando ya no necesites la instancia
app.destroy();

// Puedes crear una nueva instancia con el mismo handle
const appNueva = new Swappit('mi-app');

Manejo de scripts

IMPORTANTE: Los scripts dentro de los elementos actualizados NO se ejecutan automáticamente.

Comportamiento actual

Cuando Swappit actualiza el DOM:

  • Los elementos HTML se reemplazan correctamente
  • Los <noscript> se procesan (su contenido se preserva como texto)
  • Los <script> NO se ejecutan automáticamente
Cómo ejecutar scripts manualmente

Si necesitas que los scripts se ejecuten después de actualizar el contenido, usa los métodos estáticos en el evento update:after:

1. Actualizar scripts inline (por contenido)
window.addEventListener('swappit:mi-app:update:after', () => {
  // Seleccionar scripts dentro de los elementos actualizados
  const scripts = document.querySelectorAll('[data-mi-app-update] script');

  // Ejecutarlos recreándolos en el DOM
  Swappit.updateScriptByContent(Array.from(scripts));
});
2. Actualizar scripts externos (por src)
window.addEventListener('swappit:mi-app:update:after', () => {
  // Recargar todos los scripts que contengan "analytics" en su URL
  // Se agrega un timestamp para forzar la recarga
  Swappit.updateScriptBySrc('analytics');
});
Ejemplo completo
<script>
  const app = new Swappit('mi-app', { log: true });

  window.addEventListener('swappit:mi-app:update:after', (e) => {
    console.log('Contenido actualizado de:', e.detail.url);

    // Ejecutar scripts inline dentro de los elementos actualizados
    const inlineScripts = document.querySelectorAll('[data-mi-app-update] script:not([src])');
    if (inlineScripts.length > 0) {
      Swappit.updateScriptByContent(Array.from(inlineScripts));
    }

    // Recargar scripts externos específicos
    Swappit.updateScriptBySrc('mi-libreria.js');
  });
</script>
Por qué los scripts no se ejecutan automáticamente

Este comportamiento intencional evita:

  • Ejecución duplicada de scripts
  • Problemas con librerías que no soportan reinicialización
  • Comportamientos inesperados en aplicaciones complejas

Esto te da control total sobre qué scripts ejecutar y cuándo.

Solución de problemas

Problema Posible causa Solución
No se actualiza el contenido Atributos data incorrectos o handle distinto Verifica que los atributos data-[handle]-update coincidan entre la página principal y las páginas de destino
Errores en consola sobre URL inválida URL externa o con formato incorrecto Solo se permiten rutas que empiecen con / o ./
Links no funcionan automáticamente Falta atributo data-swappit-handle Agrega data-swappit-handle="tu-handle" a los links
Orden de actualización incorrecto Falta atributo order Añade data-[handle]-update-order con valores numéricos
Error "El handle ya está en uso" Intentas crear dos instancias con el mismo handle Usa Swappit.instances.get('tu-handle') para reutilizar una instancia existente, o usa <swappit-instance> que llama a reinit() automáticamente
<swappit-instance> no crea la instancia Falta atributo data-handle El atributo data-handle es obligatorio
Los scripts no se ejecutan Scripts no se ejecutan automáticamente por diseño Usa Swappit.updateScriptByContent() o Swappit.updateScriptBySrc() en el evento update:after
La precarga no funciona Valor incorrecto en data-preload Usa "instant" o "hover" (con comillas en el atributo HTML)
Los botones adelante/atrás no funcionan Falta configuración de historial Activa updateUrl: true y enableHistory: true en las opciones
Error "Solo una instancia puede controlar el historial" Dos instancias con updateUrl y enableHistory activos Solo una instancia puede tener updateUrl: true + enableHistory: true simultáneamente
Links dinámicos no se configuran Error en el observer El observer se inicia automáticamente. Activa log: true para ver mensajes de depuración
El caché no se actualiza useCache está en true por defecto Pasa false como segundo argumento: update(url, false) para forzar nueva descarga
La instancia no toma las nuevas opciones Las opciones se definen al crear la instancia Usa el método reinit(options) para actualizar opciones dinámicamente
Eventos no se escuchan correctamente Nombre de evento desactualizado Los eventos ahora usan el formato swappit:[handle]:update:after, swappit:[handle]:update:before, etc.

Keywords