# zvitek-vaadin-router
> Small and powerful client-side router for Web Components. Framework-agnostic.
Latest version **1.3.6** (published 2020-01-15) · Apache-2.0 license · 0 weekly downloads
## Install
```sh
npm install zvitek-vaadin-router
pnpm add zvitek-vaadin-router
yarn add zvitek-vaadin-router
bun add zvitek-vaadin-router
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: esm support; no vulnerabilities.
Warnings: low downloads; no types.
Negative: abandoned.
## Facts
| | |
|---|---|
| Version | 1.3.6 |
| Published | 2020-01-15 |
| First published | 2020-01-15 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 780.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 456 |
| Author | Vaadin Ltd |
| Maintainers | zvitek |
| Keywords | Vaadin, vaadin-router, router, client-side, web-components |
## Links
- npm: https://www.npmjs.com/package/zvitek-vaadin-router
- Repository: https://github.com/vaadin/vaadin-router
- Homepage: https://vaadin.com
- Issues: https://github.com/vaadin/vaadin-router/issues
- npm.io page: https://npm.io/package/zvitek-vaadin-router
## Dependencies (2)
- [path-to-regexp](https://npm.io/package/path-to-regexp.md) ^6.1.0
- [@vaadin/vaadin-usage-statistics](https://npm.io/package/@vaadin/vaadin-usage-statistics.md) ^2.0.8
## Alternatives
- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads
## Recent versions
- 1.3.6 (latest) — 2020-01-15
- 1.3.5 — 2020-01-15
- 1.3.4 — 2020-01-15
- 1.3.3 — 2020-01-15
- 1.3.2 — 2020-01-15
- 1.3.1 — 2020-01-15
- 1.3.0 — 2020-01-15
## README
[](https://www.npmjs.com/package/@vaadin/router)
[](https://bundlephobia.com/result?p=@vaadin/router)
[](https://travis-ci.org/vaadin/vaadin-router)
[](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
# Vaadin Router
[Live Demo ↗](https://vaadin.github.io/vaadin-router/vaadin-router/demo)
|
[API documentation ↗](https://vaadin.github.io/vaadin-router/vaadin-router/)
A client-side router for Web Components
Vaadin Router is a small and powerful client-side router JS library. It uses the widely adopted express.js syntax for routes (`/users/:id`) to map URLs to Web Component views. All features one might expect from a modern router are supported: async route resolution, animated transitions, navigation guards, redirects, and more. It is framework-agnostic and works equally well with all Web Components regardless of how they are created (Polymer / SkateJS / Stencil / Angular / Vue / etc).
Vaadin Router is a good fit for developers that do not want to go all-in with one framework, and prefer to have freedom in picking the components that work best for their specific needs.
```
npm install --save @vaadin/router
```
```javascript
import {Router} from '@vaadin/router';
const router = new Router(document.getElementById('outlet'));
router.setRoutes([
{path: '/', component: 'x-home-view'},
{path: '/users', component: 'x-user-list'}
]);
```
## Browser support
[](https://saucelabs.com/u/vaadin-router)
### Big Thanks
Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com).
## Running demos and tests in the browser
1. Fork the `vaadin-router` repository and clone it locally.
1. Make sure you have [npm](https://www.npmjs.com/) installed.
1. When in the `vaadin-router` directory, run `npm install` and then `npm run install:dependencies` to install dependencies.
1. Run `npm start`, and open [http://127.0.0.1:8000/components/vaadin-router](http://127.0.0.1:8000/components/vaadin-router) in your browser to see the component API documentation.
1. You can also open demo or in-browser tests by adding **demo** or **test** to the URL, for example:
- [http://127.0.0.1:8000/components/vaadin-router/demo](http://127.0.0.1:8000/components/vaadin-router/demo)
- Public API tests: [http://127.0.0.1:8000/components/vaadin-router/test](http://127.0.0.1:8000/components/vaadin-router/test)
- Unit tests: [http://127.0.0.1:8000/components/vaadin-router/test/index.coverage.html](http://127.0.0.1:8000/components/vaadin-router/test/index.coverage.html)
## Running tests from the command line
1. When in the `vaadin-router` directory, run `npm test`
## Following the coding style
We are using [ESLint](http://eslint.org/) for linting JavaScript code. You can check if your code is following our standards by running `npm run lint`, which will automatically lint all `.js` files as well as JavaScript snippets inside `.html` files.
## Contributing
- Make sure your code is compliant with our code linters: `npm run lint`
- Check that tests are passing: `npm test`
- [Submit a pull request](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) with detailed title and description
- Wait for response from one of Vaadin components team members
## License
Apache License 2.0
Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.
---
_Source: https://npm.io/package/zvitek-vaadin-router · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._