vitarx-router 0.0.1

package/dist/router/web-history-router.d.ts

@@ -0,0 +1,65 @@
+import { default as Router } from './router.js';
+import { RouteLocation, RouterOptions, RouteTarget } from './type.js';
+/**
+ * 基于`window.history`实现的路由器
+ *
+ * 支持浏览器前进、后退、跳转等操作
+ */
+export default class WebHistoryRouter extends Router {
+    constructor(options: RouterOptions<'path' | 'hash'>);
+    /**
+     * 当前路由目标
+     *
+     * @returns {RouteTarget} - 包含 index、hash 和 query 的对象
+     */
+    protected get currentRouteTarget(): MakeRequired<RouteTarget, 'query' | 'hash'>;
+    /**
+     * window.history
+     *
+     * @private
+     */
+    private get webHistory();
+    /**
+     * @inheritDoc
+     */
+    go(delta?: number): void;
+    /**
+     * @inheritDoc
+     */
+    protected initializeRouter(): void;
+    /**
+     * @inheritDoc
+     */
+    protected pushHistory(data: RouteLocation): void;
+    /**
+     * @inheritDoc
+     */
+    protected replaceHistory(data: RouteLocation): void;
+    /**
+     * 保存当前页面滚动位置
+     *
+     * @private
+     */
+    private saveCurrentScrollPosition;
+    /**
+     * 创建历史记录状态
+     *
+     * 用于在浏览器历史记录中存储路由信息，以支持前进、后退等操作。
+     *
+     * @param data - 路由数据
+     * @param hash - 要替换的哈希值
+     * @param query - 要替换的查询参数
+     * @private
+     */
+    private createState;
+    /**
+     * 处理浏览器历史记录的返回/前进事件
+     */
+    private onPopState;
+    /**
+     * 确保路径是 hash 格式
+     *
+     * @private
+     */
+    private ensureHash;
+}