类:NavigationHistory
类:NavigationHistory
管理导航条目列表,表示用户在应用程序内的浏览历史。
进程:主进程
此类未从 'electron'
模块导出。 它仅作为 Electron API 中其他方法的返回值提供。
每个NavigationEntry 都对应一个特定的访问过的页面。 索引系统遵循顺序排列,最早访问页面的条目位于索引 0,最近访问页面的条目位于索引 N。
此类中的一些 API 也接受一个 *offset*,它是一个整数,表示根据上述索引系统,从当前条目计算的索引相对位置(例如,偏移量 1
表示在历史记录中向前移动一页)。
维护这个有序的导航条目列表可以实现用户浏览历史记录的无缝前后导航。
实例方法
navigationHistory.canGoBack()
返回 boolean
- 浏览器是否可以返回上一页。
navigationHistory.canGoForward()
返回 boolean
- 浏览器是否可以前进到下一页。
navigationHistory.canGoToOffset(offset)
offset
Integer
返回 boolean
- 网页是否可以导航到从当前条目计算的指定相对 offset
位置。
navigationHistory.clear()
清除导航历史记录。
navigationHistory.getActiveIndex()
返回 Integer
- 当前页面的索引,我们可以从该页面后退/前进或重新加载。
navigationHistory.getEntryAtIndex(index)
index
Integer
返回 NavigationEntry - 给定索引处的导航条目。
如果索引超出范围 (大于历史记录长度或小于 0),则返回 null。
navigationHistory.goBack()
使浏览器返回上一页。
navigationHistory.goForward()
使浏览器前进一页。
navigationHistory.goToIndex(index)
index
Integer
将浏览器导航到指定的绝对网页索引。
navigationHistory.goToOffset(offset)
offset
Integer
导航到从当前条目计算的指定相对偏移量位置。
navigationHistory.length()
返回 Integer
- 历史记录长度。
navigationHistory.removeEntryAtIndex(index)
index
Integer
移除给定索引处的导航条目。 无法移除“当前活动索引”处的条目。
返回 boolean
- 导航条目是否已从 webContents 历史记录中移除。
navigationHistory.getAllEntries()
返回 NavigationEntry[] - WebContents 的完整历史记录。
navigationHistory.restore(options)
恢复导航历史记录并加载堆栈中的给定条目。 将尽最大努力不仅恢复导航堆栈,还恢复单个页面的状态 - 例如包括 HTML 表单值或滚动位置。 建议在创建任何导航条目之前调用此 API,因此理想情况下在您对 webContents
对象调用 loadURL()
或 loadFile()
之前调用。
此 API 允许您创建旨在恢复、重新创建或克隆其他 webContents 的常用流程。
返回 Promise<void>
- Promise 在页面完成加载所选导航条目时解析 (参见 did-finish-load
),如果页面加载失败则拒绝 (参见 did-fail-load
)。 已附加一个 noop 拒绝处理程序,以避免未处理的拒绝错误。