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

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
fix: add deprecation warnings to webcontents
  • Loading branch information
@alicelovescake
alicelovescake committed May 28, 2024
commit 438373a49e07a1fe685238b7c2ba005877d4ae06
41 changes: 41 additions & 0 deletions lib/browser/api/web-contents.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,6 +511,47 @@ const loggingEnabled = () => {
return environment.hasVar('ELECTRON_ENABLE_LOGGING') || commandLine.hasSwitch('enable-logging');
};

// Deprecation warnings for navigation related APIs.
WebContents.prototype.canGoBack = function () {
deprecate.warnOnce('webContents.canGoBack', 'webContents.navigationHistory.canGoBack');
return this.canGoBack();
};

WebContents.prototype.canGoForward = function () {
deprecate.warnOnce('webContents.canGoForward', 'webContents.navigationHistory.canGoForward');
return this.canGoForward();
};

WebContents.prototype.canGoToOffset = function (index: number) {
deprecate.warnOnce('webContents.canGoToOffset', 'webContents.navigationHistory.canGoToOffset');
return this.canGoToOffset(index);
};

WebContents.prototype.clearHistory = function () {
deprecate.warnOnce('webContents.clearHistory', 'webContents.navigationHistory.clear');
return this.clearHistory();
};

WebContents.prototype.goBack = function () {
deprecate.warnOnce('webContents.goBack', 'webContents.navigationHistory.goBack');
return this.goBack();
};

WebContents.prototype.goForward = function () {
deprecate.warnOnce('webContents.goForward', 'webContents.navigationHistory.goForward');
return this.goForward();
};

WebContents.prototype.goToIndex = function (index: number) {
deprecate.warnOnce('webContents.goToIndex', 'webContents.navigationHistory.goToIndex');
return this.goToIndex(index);
};

WebContents.prototype.goToOffset = function (index: number) {
deprecate.warnOnce('webContents.goToOffset', 'webContents.navigationHistory.goToOffset');
return this.goToOffset(index);
};

// Add JavaScript wrappers for WebContents class.
WebContents.prototype._init = function () {
const prefs = this.getLastWebPreferences() || {};
Expand Down