开源项目 `vanilla-spa-router` 使用教程

2024-08-27 12:13:37作者：卓炯娓

1. 项目的目录结构及介绍

vanilla-spa-router/
├── css/
│   └── styles.css
├── js/
│   └── router.js
├── pages/
│   ├── home.html
│   ├── about.html
│   └── contact.html
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
└── index.html

css/: 包含项目的样式文件 styles.css。
js/: 包含项目的核心路由文件 router.js。
pages/: 包含各个页面的 HTML 文件，如 home.html, about.html, contact.html。
.gitattributes: Git 属性配置文件。
.gitignore: Git 忽略文件配置。
LICENSE: 项目许可证文件，采用 MIT 许可证。
README.md: 项目说明文档。
index.html: 项目的主入口文件。

2. 项目的启动文件介绍

项目的启动文件是 index.html。这个文件包含了基本的 HTML 结构，并引入了必要的 CSS 和 JavaScript 文件。以下是 index.html 的部分代码示例：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Vanilla SPA Router</title>
    <link rel="stylesheet" href="css/styles.css">
</head>
<body>
    <div id="app"></div>
    <script src="js/router.js"></script>
</body>
</html>

<link rel="stylesheet" href="css/styles.css">: 引入样式文件。
<script src="js/router.js"></script>: 引入核心路由文件。

3. 项目的配置文件介绍

项目的主要配置文件是 router.js，它负责实现单页应用的路由功能。以下是 router.js 的部分代码示例：

const routes = {
    '/': 'pages/home.html',
    '/about': 'pages/about.html',
    '/contact': 'pages/contact.html'
};

function navigateTo(url) {
    history.pushState(null, null, url);
    router();
}

function router() {
    const path = window.location.pathname;
    const route = routes[path] || routes['/'];
    fetch(route)
        .then(response => response.text())
        .then(html => {
            document.getElementById('app').innerHTML = html;
        });
}

window.addEventListener('popstate', router);
document.addEventListener('DOMContentLoaded', () => {
    document.body.addEventListener('click', e => {
        if (e.target.matches('[data-link]')) {
            e.preventDefault();
            navigateTo(e.target.href);
        }
    });
    router();
});

routes: 定义了路径与页面文件的映射关系。
navigateTo: 处理页面导航。
router: 根据当前路径加载对应的页面内容。
事件监听: 监听 popstate 事件和 DOMContentLoaded 事件，确保路由功能正常工作。

以上是 vanilla-spa-router 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。

vanilla-spa-router

A super simple solution to basic SPA routing in a vanilla JS web app.

项目地址：https://gitcode.com/gh_mirrors/va/vanilla-spa-router