@viewfly/router 3.0.1 → 3.0.2

package/README.en.md

@@ -0,0 +1,80 @@
+# @viewfly/router
+
+**Languages:** [简体中文](./README.md)
+
+Browser routing for **Viewfly**: declarative links, nested outlets, programmatic navigation. Requires **`@viewfly/core`** and **`@viewfly/platform-browser`**.
+
+---
+
+## Install
+
+```bash
+npm install @viewfly/router @viewfly/platform-browser @viewfly/core
+```
+
+---
+
+## Wiring into the app
+
+1. Register **`RouterModule`** at app level (`createApp(...).use(...)`).
+2. Use **`Link`** for nav and **`RouterOutlet`** to render the matched view.
+3. **`inject(Router)`** inside components, then **`navigateTo(path, queryParams?, hash?)`** / **`replaceTo`** — the second argument is the **query object** (distinct from path **`Router.params`** / **`useParams()`**).
+
+Minimal sketch (extend with your route table, lazy loading, etc.):
+
+```tsx
+import { inject } from '@viewfly/core'
+import { createApp } from '@viewfly/platform-browser'
+import { Link, Router, RouterModule, RouterOutlet } from '@viewfly/router'
+
+function Home() {
+  const router = inject(Router)
+  return () => (
+    <div>
+      <p>Home</p>
+      <button type="button" onClick={() => router.navigateTo('/list')}>Go to list</button>
+    </div>
+  )
+}
+
+function List() {
+  return () => <div>List</div>
+}
+
+function App() {
+  return () => (
+    <div>
+      <nav>
+        <Link active="active" exact to="/">Home</Link>
+        <Link active="active" to="/list">List</Link>
+      </nav>
+      <RouterOutlet>
+        No route matched
+      </RouterOutlet>
+    </div>
+  )
+}
+
+createApp(<App/>).use(new RouterModule({
+  routes: [
+    { path: '', component: Home },
+    { path: 'list', component: List }
+  ]
+})).mount(document.querySelector('#main')!)
+
+```
+
+**Nested routes:** place another `RouterOutlet` in child layouts and pass nested route config.
+
+---
+
+## Docs
+
+- Official docs: <https://viewfly.org/guide/router>
+- **`@viewfly/router`** typings.
+
+---
+
+## License
+
+MIT

package/README.md

@@ -1,5 +1,7 @@
 # @viewfly/router
 
+**Languages:** [English](./README.en.md)
+
 基于 **Viewfly** 的浏览器端路由：声明式链接、嵌套路由出口、编程式导航等。需配合 **`@viewfly/core`** 与 **`@viewfly/platform-browser`** 使用。
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@viewfly/router",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "A routing library based on the Viewfly framework that can be run in the browser or Nodejs background.",
   "main": "./dist/index.js",
   "module": "./dist/index.esm.js",
@@ -19,7 +19,7 @@
   "keywords": [],
   "dependencies": {
     "@tanbo/stream": "^1.2.4",
-    "@viewfly/core": "^3.0.1",
+    "@viewfly/core": "^3.0.2",
     "url": "^0.11.4"
   },
   "devDependencies": {