Skip to content

Latest commit

 

History

History
62 lines (52 loc) · 1.53 KB

README.md

File metadata and controls

62 lines (52 loc) · 1.53 KB

vanjs-router

Simple Frontend Routing Component Based on Van.js.

This is version 2. For version 1 documentation, please click here.

Features

  • Supports both string and regex matching.
  • Supports setting page display delay.
  • Supports configuring events for the first route match (onFirst) and subsequent route matches (onLoad).
  • Implemented using TypeScript.
  • Simple API.

Quick Start

npm install vanjs-router
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/vanjs-org/van/public/van-1.5.2.nomodule.min.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/vanjs-router@latest/dist/vanjs-router.min.js"></script>
<script>
  const { Route, goto } = router;
  const { div, button } = van.tags;

  const Home = () =>
    Route({
      rule: "home",
      Loader() {
        return div(
          "This Is Home Page.",
          button({ onclick: () => goto("about") }, "Go To About")
        );
      },
      async onFirst() {
        console.log("home onfirst");
      },
      async onLoad() {
        console.log("home onload");
      },
    });

  const About = () =>
    Route({
      rule: "about",
      delayed: true,
      Loader() {
        return div(
          "This Is About Page.",
          button({ onclick: () => goto("home") }, "Go To Home")
        );
      },
      async onLoad() {
        this.show();
      },
    });

  van.add(document.body, Home(), About());
</script>