vitarx-router 0.0.1

package/dist/widget/RouterView.d.ts

@@ -0,0 +1,84 @@
+import { Element, VNode, Widget } from 'vitarx';
+import { RouteNormalized } from '../router/index.js';
+export interface RouteOptions {
+    /**
+     * 命名视图
+     *
+     * @default 'default'
+     */
+    name?: string;
+}
+/**
+ * # 路由器视图
+ *
+ * 用于渲染路由线路配置的`widget`，可以在子组件中嵌套`RouterView`，但应用内只能存在一个根视图。
+ *
+ * 如需实现页面缓存等功能，可以重写该类的{@link build}方法。
+ */
+export declare class RouterView extends Widget<RouteOptions> {
+    #private;
+    constructor(props: RouteOptions);
+    /**
+     * 当前路由器视图所在层级索引
+     *
+     * `index`的值从0开始，它与`RouteLocation.matched`数组下标一一对应
+     */
+    get index(): number;
+    /**
+     * 是否为最后一个路由视图
+     */
+    get isLastView(): boolean;
+    /**
+     * 视图名称
+     *
+     * @default 'default'
+     */
+    get name(): string;
+    get matchedRoute(): RouteNormalized | undefined;
+    /**
+     * 当前路由器视图要显示的虚拟节点
+     *
+     * 注意未匹配时会返回`undefined`，匹配成功时返回的是`VNode<WidgetType>`
+     *
+     * @protected
+     */
+    protected get currentElement(): VNode | undefined;
+    /**
+     * 当前的路由位置对象
+     *
+     * @protected
+     */
+    protected get location(): Readonly<import('vitarx').Reactive<import('../index.js').RouteLocation>>;
+    /**
+     * @inheritDoc
+     */
+    protected onMounted(): void;
+    /**
+     * @inheritDoc
+     */
+    protected onUpdated(): void;
+    /**
+     * ## 构建视图
+     *
+     * 可以重写该方法添加自定义的视图元素
+     *
+     * 例如，使用`KeepAlive`组件缓存当前视图元素：
+     * ```tsx
+     * protected build() {
+     *   // 不可省略，因为`KeepAlive`不能渲染非组件节点。
+     *   if (!this.currentElement) return <></> // 使用空片段节点占位
+     *
+     *   // 将当前显示的视图元素(VNode<WidgetType>对象)传递给`KeepAlive`插槽，使用缓存功能。
+     *   return <KeepAlive onlyKey={this.matchedRoute?.path}>{this.currentElement}</KeepAlive>
+     * }
+     * ```
+     * @protected
+     */
+    protected build(): Element;
+    /**
+     * 视图渲染完成通知路由器
+     *
+     * @private
+     */
+    private completeViewRender;
+}

package/dist/widget/index.d.ts

@@ -0,0 +1 @@
+export * from './RouterView.js';

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "vitarx-router",
+  "version": "0.0.1",
+  "type": "module",
+  "main": "dist/vitarx-router.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "dev": "vite --force",
+    "build": "rimraf dist && tsc --p tsconfig-build.json && vite build",
+    "preview": "vite preview",
+    "prepublishOnly": "npm run build",
+    "push": "npm publish --access=public"
+  },
+  "peerDependencies": {
+    "vitarx": "^1.0.0-beta.19"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "prettier": "^3.3.1",
+    "typescript": "^5.2.2",
+    "vite": "^5.2.0",
+    "vite-plugin-dts": "^4.3.0",
+    "vite-plugin-vitarx": "^1.0.0-beta.13"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ]
+}