Navigation API
Navigation API 的 NavigationHistoryEntry 接口表示单个导航历史记录条目。
这些对象通常通过 Navigation.currentEntry 属性和 Navigation.entries() 方法访问。
导航 API 仅公开在当前浏览上下文中创建的与当前页面同源的历史记录条目(例如,不是嵌入式 iframe 内的导航或跨源导航),为你的应用提供所有先前历史记录条目的准确列表。与使用旧版History API 相比,这使得遍历历史记录变得不那么脆弱。
实例属性
从其父接口 EventTarget 继承属性。
- NavigationHistoryEntry.id
- : 返回历史记录条目的
id。这是一个唯一的、由 UA 生成的值,始终代表特定的历史记录条目,可用于将其与外部资源(如存储缓存)关联。
- : 返回历史记录条目的
- NavigationHistoryEntry.index
- : 返回历史条目列表(即 Navigation.entries() 返回的列表)中历史条目的索引,如果该条目未出现在列表中,则返回
-1。
- : 返回历史条目列表(即 Navigation.entries() 返回的列表)中历史条目的索引,如果该条目未出现在列表中,则返回
- NavigationHistoryEntry.key
- : 返回历史条目的
key。这是一个唯一的 UA 生成值,表示历史条目在条目列表中的位置,而不是条目本身。它用于通过 Navigation.traverseTo() 导航该特定位置。替换列表中条目的其他条目将重用该key(即,如果 NavigateEvent.navigationType 为replace)。
- : 返回历史条目的
- NavigationHistoryEntry.sameDocument
- : 如果此历史记录条目与当前 Document 值属于同一个
document,则返回true,否则返回false。
- : 如果此历史记录条目与当前 Document 值属于同一个
- NavigationHistoryEntry.url
- : 返回此历史记录条目的绝对 URL 地址。如果该条目对应的文档与当前文档不同(例如
sameDocument属性为false),并且该文档是在将 Referrer-Policy 标头设置为no-referrer或origin的情况下获取的,则该属性返回null。
- : 返回此历史记录条目的绝对 URL 地址。如果该条目对应的文档与当前文档不同(例如
实例方法
从其父接口 EventTarget 继承方法。
- NavigationHistoryEntry.getState
- : 返回与此历史记录条目相关的可用状态数据的克隆。
事件
- NavigationHistoryEntry/dispose_event
- : 当条目不再是历史条目列表的一部分时触发。
示例
function initHomeBtn() {
// 获取第一个加载条目的键,以便用户可以随时返回该视图。
const { key } = navigation.currentEntry;
backToHomeButton.onclick = () => {
navigation.traverseTo(key);
};
}
// 拦截 navigate 事件(例如链接点击),并将其替换为单页导航
navigation.addEventListener("navigate", (event) => {
event.intercept({
async handler() {
// 导航到不同的视图,但“主页”按钮始终有效
},
});
});
规范
浏览器兼容性
参见
- 现代客户端路由:导航 API
- 导航 API 说明
- Domenic Denicola 的导航 API 在线演示
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
