类:NavigationHistory
类:NavigationHistory
管理导航条目列表,表示用户在应用程序内的浏览历史记录。
进程:主进程
此类未从 'electron'
模块导出。它仅作为 Electron API 中其他方法的返回值提供。
每个 NavigationEntry 对应于一个特定的访问页面。 索引系统遵循顺序,最早访问页面的条目索引为 0,最近访问页面的条目索引为 N。
此类中的某些 API 也接受 *offset*,它是一个整数,表示根据上述索引系统,索引相对于当前条目的位置(即,偏移值 1
表示在历史记录中向前翻一页)。
维护此导航条目的有序列表,使用户能够在其浏览历史记录中无缝地向前和向后导航。
实例方法
navigationHistory.canGoBack()
返回 boolean
- 浏览器是否可以返回上一页网页。
navigationHistory.canGoForward()
返回 boolean
- 浏览器是否可以前进到下一页网页。
navigationHistory.canGoToOffset(offset)
offset
Integer
返回 boolean
- 网页是否可以跳转到相对于当前条目的指定相对偏移量。
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>
- 当页面完成加载选定的导航条目(请参阅 did-finish-load
)时,Promise 将 resolve,如果页面加载失败(请参阅 did-fail-load
),则 Promise 将 reject。 已经附加了一个 noop rejection handler,以避免未处理的 rejection 错误。