Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: duplicate navigation related APIs to contents.navigationHistory #41752

Merged
merged 12 commits into from
Jun 5, 2024
Merged

feat: duplicate navigation related APIs to contents.navigationHistory #41752

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9dbdda1
refactor: move navigation related api to navigationHistory
alicelovescake Mar 31, 2024
abcaeab
docs: add deprecation messages to old web content methods
alicelovescake May 3, 2024
438373a
fix: add deprecation warnings to webcontents
alicelovescake May 28, 2024
5e931eb
fix: add deprecation warnings and make existing naviagation apis inte…
alicelovescake May 28, 2024
46743bd
Update docs/api/web-contents.md
alicelovescake May 29, 2024
62ffc88
Update docs/api/web-contents.md
alicelovescake May 29, 2024
7d2d01f
Update docs/api/web-contents.md
alicelovescake May 29, 2024
c7ba345
Update docs/api/web-contents.md
alicelovescake May 29, 2024
56d56e8
docs: fix links
alicelovescake May 29, 2024
91d767a
docs: add breaking change to 31
alicelovescake Jun 4, 2024
4f54210
docs: move breaking change to 32
alicelovescake Jun 4, 2024
1a2c10a
chore: re-run pipeline
alicelovescake Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: add breaking change to 31
  • Loading branch information
@alicelovescake
alicelovescake committed Jun 4, 2024
commit 91d767aa9a3cbbf5606fcf359ba721b92c925694
4 changes: 2 additions & 2 deletions docs/api/navigation-history.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Returns `boolean` - Whether the browser can go forward to next web page.

* `offset` Integer

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

#### `navigationHistory.clear()`

Expand Down Expand Up @@ -60,7 +60,7 @@ Navigates browser to the specified absolute web page index.

* `offset` Integer

Navigates to the specified offset from the "current entry".
Navigates to the specified offset from the current entry.

#### `navigationHistory.length()`

Expand Down
26 changes: 26 additions & 0 deletions docs/breaking-changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,32 @@ See [crbug.com/332584706](https://issues.chromium.org/issues/332584706) for more

This brings the behavior to parity with Windows and Linux. Prior behavior: The first `flashFrame(true)` bounces the dock icon only once (using the [NSInformationalRequest](https://developer.apple.com/documentation/appkit/nsrequestuserattentiontype/nsinformationalrequest) level) and `flashFrame(false)` does nothing. New behavior: Flash continuously until `flashFrame(false)` is called. This uses the [NSCriticalRequest](https://developer.apple.com/documentation/appkit/nsrequestuserattentiontype/nscriticalrequest) level instead. To explicitly use `NSInformationalRequest` to cause a single dock icon bounce, it is still possible to use [`dock.bounce('informational')`](https://www.electronjs.org/docs/latest/api/dock#dockbouncetype-macos).

### Deprecated: `clearHistory`, `canGoBack`, `goBack`, `canGoForward`, `goForward`, `canGoToOffset`, `goToOffset` on `WebContents`

The navigation-related APIs are now deprecated.

These APIs have been moved to the `navigationHistory` property of `WebContents` to provide a more structured and intuitive interface for managing navigation history.

```js
// Deprecated
win.webContents.clearHistory()
win.webContents.canGoBack()
win.webContents.goBack()
win.webContents.canGoForward()
win.webContents.goForward()
win.webContents.canGoToOffset()
win.webContents.goToOffset(index)

// Replace with
win.webContents.navigationHistory.clear()
win.webContents.navigationHistory.canGoBack()
win.webContents.navigationHistory.goBack()
win.webContents.navigationHistory.canGoForward()
win.webContents.navigationHistory.goForward()
win.webContents.navigationHistory.canGoToOffset()
win.webContents.navigationHistory.goToOffset(index)
```

## Planned Breaking API Changes (30.0)

### Behavior Changed: cross-origin iframes now use Permission Policy to access features
Expand Down