@viewfly/router 3.0.0-alpha.8 → 3.0.0

package/README.md

@@ -7,7 +7,7 @@
 ## 安装
 
 ```bash
-pnpm add @viewfly/router @viewfly/platform-browser @viewfly/core
+npm install @viewfly/router @viewfly/platform-browser @viewfly/core
 ```
 
 ---
@@ -16,7 +16,7 @@ pnpm add @viewfly/router @viewfly/platform-browser @viewfly/core
 
 1. 使用 **`RouterModule`** 作为应用级扩展（通过 `createApp(...).use(...)` 注册）。
 2. 在布局中用 **`Link`** 生成导航，用 **`RouterOutlet`** 根据配置渲染匹配到的组件。
-3. 在组件内通过 **`inject(Router)`** 拿到路由实例，调用 **`navigateTo`** 等方法做跳转。
+3. 在组件内通过 **`inject(Router)`** 拿到路由实例，调用 **`navigateTo(path, queryParams?, hash?)`** / **`replaceTo`** 做跳转（第二参为查询对象，与 path 上的 **`Router.params`** / **`useParams()`** 区分）。
 
 最小串联示例（节选；完整路由表、懒加载等请结合类型定义与本包源码中的 `RouterModule` / `RouterOutlet` 用法扩展）：
 
@@ -46,21 +46,20 @@ function App() {
         <Link active="active" exact to="/">Home</Link>
         <Link active="active" to="/list">List</Link>
       </nav>
-      <RouterOutlet
-        config={[
-          { name: 'home', component: Home },
-          { name: 'list', component: List }
-        ]}
-      >
+      <RouterOutlet>
         未匹配到路由
       </RouterOutlet>
     </div>
   )
 }
 
-createApp(<App />)
-  .use(new RouterModule())
-  .mount(document.getElementById('app')!)
+createApp(<App/>).use(new RouterModule({
+  routes: [
+    { path: '', component: Home },
+    { path: 'list', component: List }
+  ]
+})).mount(document.querySelector('#main')!)
+
 ```
 
 **嵌套路由**：在子页面组件内再次放置 `RouterOutlet`，并为其传入子级 `config`。
@@ -69,7 +68,8 @@ createApp(<App />)
 
 ## 文档
 
-- 以 **`@viewfly/router` 类型定义** 与本 README、仓库内 `packages/playground` 示例为准。
+- 官方文档：<https://viewfly.org/guide/router>（路由接入与常见用法）。
+- **`@viewfly/router`** 类型定义（补充 API 参数与返回值细节）。
 
 ---
 

package/dist/hooks/_api.d.ts

@@ -1 +1,2 @@
 export * from './use-query-params';
+export * from './use-params';

package/dist/hooks/use-params.d.ts

@@ -0,0 +1,2 @@
+import { Params } from '../providers/routes';
+export declare function useParams<T extends Params = Params>(): T;