Skip to content

Commit 19de2aa

Browse files
committed
docs: deprecation notice
1 parent f5c4991 commit 19de2aa

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
[![NPM version](https://img.shields.io/npm/v/@vaadin/router.svg)](https://www.npmjs.com/package/@vaadin/router)
22
[![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/@vaadin/router.svg)](https://bundlephobia.com/result?p=@vaadin/router)
33

4+
# Vaadin Router is deprecated
5+
6+
This library is no longer actively maintained.
7+
8+
Consider [`@lit-labs/router`](https://www.npmjs.com/package/@lit-labs/router) as a more lightweight and modern alternative. Also, as the [URLPattern](https://developer.mozilla.org/en-US/docs/Web/API/URLPattern) API is universally available in modern browsers nowadays, we recommend using that for building customized client-side routing.
9+
10+
---
11+
412
# Vaadin Router
513

614
[Live demo](https://vaadin.github.io/router/index.html)

src/router.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ const rootContext: RouteContext = {
9797
* * [setRoutes](#/classes/Router#method-setRoutes) – should be used to configure the routes.
9898
*
9999
* Only `setRoutes` has to be called manually, others are automatically invoked when creating a new instance.
100+
*
101+
* @deprecated Consider [URLPattern](https://developer.mozilla.org/en-US/docs/Web/API/URLPattern) standard Web API or a library based on it, such as [@lit-labs/router](https://www.npmjs.com/package/@lit-labs/router)
100102
*/
101103
export class Router<R extends object = EmptyObject, C extends object = EmptyObject> extends Resolver<
102104
ActionValue,

0 commit comments

Comments
 (0)