Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Biblioteca para manejar rutas en proyectos con vanilla js

License

Notifications You must be signed in to change notification settings

jcervant16/simple-spa

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

jsimple-spa

jsimple-spa es una librería ligera que permite implementar un sistema de rutas en aplicaciones creadas con Vanilla JavaScript, ideal para construir Single Page Applications (SPA) sin necesidad de frameworks pesados.


☺️ Acá encontraras el repositorio con el código fuente https://github.com/jcervant16/simple-spa


🚀 Instalación

Instálala con npm:

npm install jsimple-spa

📖 Modo de uso

1. Agrega en tu archivo HTML principal la etiqueta router-slot

<!DOCTYPE html>
<html lang="es">
    <head>
        <meta charset="UTF-8">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <base href="">
        <title>Mi SPA</title>
    </head>
    <body>
        <nav>
            <a id="nav-item-home">Inicio</a>
            <a id="nav-item-about">Acerca de</a>
        </nav>
        <router-slot> </router-slot>
        <script type="module" src="./main.js"></script>
    </body>
</html>

2. Definir rutas con router

La función router recibe como parámetro un array de objetos con las propiedades:

  • path → ruta de la aplicación.
  • page → archivo HTML que se renderizará.
import { router } from "jsimple-spa";

router([
  { path: "/home", page: "./home.html" },
  { path: "/about", page: "./about.html" },
]);

3. Navegar entre páginas con navigate

Para cambiar de página dentro de la aplicación, usa la función navigate pasando la ruta deseada:

import { navigate } from "jsimple-spa";

navigate("/home");

Esto actualizará el contenido dinámicamente sin recargar la página.


📌 Características

  • ✨ Ligera y sin dependencias.
  • ⚡ Compatible con proyectos de Vanilla JS.
  • 📂 Permite organizar vistas en archivos HTML externos.
  • 🔄 Navegación fluida entre páginas.

🛠 Ejemplo completo

import { router, navigate } from "jsimple-spa";

// Configuración de rutas
router([
  { path: "/home", page: "./home.html" },
  { path: "/about", page: "./about.html" },
]);

// Navegar a /home al iniciar
navigate("/home");

💂‍♂️ Uso del Guarda de rutas

La propiedad activeGuard es una funcion que retorna un boolean o promise<boolean> que indica si se permite o no el acceso a la ruta solicitada.

import { router } from "jsimple-spa";
//funcion guarda
function guardFn() {
    return new Promise((resolve)=>{
        setTimeout(() => {
            resolve(true)
        }, 2000);
    })  
}

// Configuración de rutas
router([
  { path: "/home", page: "./home.html", activeGuard: guardFn  },
  { path: "/about", page: "./about.html" },
]);

📄 Licencia

Este proyecto está licenciado bajo los términos de la
GNU General Public License v3.0 o posterior (LGPL-3.0-or-later).

Puedes ver una copia completa en el archivo LICENSE de este repositorio
o en gnu.org/licenses/lgpl-3.0.

About

Biblioteca para manejar rutas en proyectos con vanilla js

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published