https://github.com/doesdev/rage-route

Tiny, feature lite, super basic client router
https://github.com/doesdev/rage-route

Last synced: 9 days ago
JSON representation

Tiny, feature lite, super basic client router

• Host: GitHub
• URL: https://github.com/doesdev/rage-route
• Owner: doesdev
• License: mit
• Created: 2017-08-01T01:17:16.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-27T06:50:05.000Z (about 2 months ago)
• Last Synced: 2024-10-31T05:35:17.484Z (14 days ago)
• Language: JavaScript
• Size: 137 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rage-route [![NPM version](https://badge.fury.io/js/rage-route.svg)](https://npmjs.org/package/rage-route)   [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)   

> Tiny, feature lite, super basic client router

## Why rage?

This was built as a very feature light replacement for page.js.

Ships with es6 styled module and commonjs module for your rolling pleasure.

## Install

```sh

$ npm install --save rage-route

```

## Usage

```js

import { addRoute, addRedirect, route, history } from 'rage-route'

addRoute('/somepage', 'Page Title', (state) => handlePageRoute(state))

addRedirect('/someotherpage', '/somepage')

addRoute('.*', 'Everything Else', (state) => handleDefaultRoute(state))

...

route('/somepage')

...

console.log(history.previous)

console.log(history.current)

```

## API

#### Add route handler

#### `addRoute(*path, *title, *callback)`

- **path** *[string - required]* (ex. `'/somepage'`)

- **title** *[string - required]* (ex. `'Page Title'`)

- **callback** *[function - receives state object - required]* (ex. `(state) => fn(state)`)

#### Add redirect from a new path to an existing path

#### `addRedirect(*newPath, *existingPath)`

- **newPath** *[string - required]* (ex. `'/someotherpage'`)

- **existingPath** *[string - required]* (ex. `'/somepage'`)

#### Route to another page, triggering callback set in addRoute

#### `route(*path, *title, *state, *noStore)`

- **path** *[string - required]* (ex. `'/somepage'`)

- **title** *[string - optional]* (ex. `'Page Title'`)

- **state** *[object - optional]* (ex. `{foo: 'bar'}`)

- **noStore** *[boolean - optional - don't store state in history]* (ex. `true`)

#### Get array of registered routes

#### `list()`

#### We also expose a history object with the previous and current page

#### `history`

- **previous** *[string]* previous page

- **current** *[string]* current page

## License

MIT © [Andrew Carpenter](https://github.com/doesdev)