mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
electron/docs/api/navigation-history.md
Alice Zhao 406f644d26
feat: duplicate navigation related APIs to contents.navigationHistory (#41752) 
* refactor: move navigation related api to navigationHistory

* docs: add deprecation messages to old web content methods

* fix: add deprecation warnings to webcontents

* fix: add deprecation warnings and make existing naviagation apis internal

* Update docs/api/web-contents.md

Co-authored-by: Sam Maddock <samuel.maddock@gmail.com>

* Update docs/api/web-contents.md

Co-authored-by: Sam Maddock <samuel.maddock@gmail.com>

* Update docs/api/web-contents.md

Co-authored-by: Sam Maddock <samuel.maddock@gmail.com>

* Update docs/api/web-contents.md

Co-authored-by: Sam Maddock <samuel.maddock@gmail.com>

* docs: fix links

* docs: add breaking change to 31

* docs: move breaking change to 32

* chore: re-run pipeline

---------

Co-authored-by: Sam Maddock <samuel.maddock@gmail.com>
2024-06-05 09:34:47 -07:00

2.1 KiB
Raw Blame History

Class: NavigationHistory

Manage a list of navigation entries, representing the user's browsing history within the application.

Process: Main
This class is not exported from the 'electron' module. It is only available as a return value of other methods in the Electron API.

Each navigation entry corresponds to a specific page. The indexing system follows a sequential order, where the first available navigation entry is at index 0, representing the earliest visited page, and the latest navigation entry is at index N, representing the most recent page. Maintaining this ordered list of navigation entries enables seamless navigation both backward and forward through the user's browsing history.

Instance Methods

navigationHistory.canGoBack()

Returns boolean - Whether the browser can go back to previous web page.

navigationHistory.canGoForward()

Returns boolean - Whether the browser can go forward to next web page.

navigationHistory.canGoToOffset(offset)

  • offset Integer

Returns boolean - Whether the web page can go to the specified offset from the current entry.

navigationHistory.clear()

Clears the navigation history.

navigationHistory.getActiveIndex()

Returns Integer - The index of the current page, from which we would go back/forward or reload.

navigationHistory.getEntryAtIndex(index)

  • index Integer

Returns Object:

  • url string - The URL of the navigation entry at the given index.
  • title string - The page title of the navigation entry at the given index.

If index is out of bounds (greater than history length or less than 0), null will be returned.

navigationHistory.goBack()

Makes the browser go back a web page.

navigationHistory.goForward()

Makes the browser go forward a web page.

navigationHistory.goToIndex(index)

  • index Integer

Navigates browser to the specified absolute web page index.

navigationHistory.goToOffset(offset)

  • offset Integer

Navigates to the specified offset from the current entry.

navigationHistory.length()

Returns Integer - History length.