https://github.com/keajs/kea-router

Router for Kea
https://github.com/keajs/kea-router

Last synced: about 2 months ago
JSON representation

Router for Kea

• Host: GitHub
• URL: https://github.com/keajs/kea-router
• Owner: keajs
• License: mit
• Created: 2019-09-09T13:48:39.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-29T14:40:51.000Z (4 months ago)
• Last Synced: 2025-04-04T21:47:58.187Z (about 2 months ago)
• Language: TypeScript
• Size: 941 KB
• Stars: 6
• Watchers: 2
• Forks: 5
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![NPM Version](https://img.shields.io/npm/v/kea-router.svg)

[![minified](https://badgen.net/bundlephobia/min/kea-router)](https://bundlephobia.com/result?p=kea-router)

[![minified + gzipped](https://badgen.net/bundlephobia/minzip/kea-router)](https://bundlephobia.com/result?p=kea-router)

[![Backers on Open Collective](https://opencollective.com/kea/backers/badge.svg)](#backers)

[![Sponsors on Open Collective](https://opencollective.com/kea/sponsors/badge.svg)](#sponsors)

# kea-router

Router plugin for kea. Version 3 works with kea `3.0.0` and up.

## Installation

Install the package: 

```sh

yarn add kea-router

```

Add the plugin to the list when resetting the context:

```js

import { routerPlugin } from 'kea-router'

resetContext({

  plugins: [routerPlugin]

})

```

You may add extra options with `routerPlugin(options)`, see the source for more :)

## Sample usage

[Read the documentation](https://kea.js.org/docs/plugins/router)