https://github.com/smonn/rautr

A tiny zero-dependency client-side routing library.
https://github.com/smonn/rautr

Last synced: 7 days ago
JSON representation

A tiny zero-dependency client-side routing library.

• Host: GitHub
• URL: https://github.com/smonn/rautr
• Owner: smonn
• License: mit
• Created: 2017-03-30T20:36:15.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-05-22T16:32:54.000Z (over 3 years ago)
• Last Synced: 2024-02-11T13:04:59.506Z (11 months ago)
• Language: JavaScript
• Homepage:
• Size: 12.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rautr - tiny zero-dependency client-side router

Intentionally basic client-side routing library. Does not have URL variable matching (e.g. `/user/paul` would not match `/user/:name`). Does not rely on the HTML5 history API. Instead it only requires HashChangeEvent support, which means IE8 and above will support this library.

## Usage

```javascript

var router = new Router();

var homeRoute = router.add(

    // route name/path, required

    "#/home",

    // code to execute when route is matched, optional

    function onEnter() {

        var homeWrapper = document.querySelector("#home");

        homeWrapper.style.display = "";

    },

    // code to execute when route is changed, optional

    function onExit() {

        var homeWrapper = document.querySelector("#home");

        homeWrapper.style.display = "none";

    }

);

// to remove a route

//router.remove(homeRoute);

// to set new route

//router.set("#/home");

// to get current route

//router.get(); // => "#/home"

// to remove event listener and clean up

//router.dispose();

// check if route is matching current

//homeRoute.isMatch(router.get()); // => true/false

```

## License

[MIT](LICENSE)

## Development

Clone repository and run `npm install`.

- `npm test` to execute tests in browsers using Karma and Jasmine.

- `npm run build` to uglify and copy files to the dist folder.