docs: Add examples section for navigation history #588
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dsanders11
requested changes
Jul 2, 2024
erickzhao
reviewed
Jul 9, 2024
| @@ -0,0 +1,61 @@ | |||
| --- | |||
| title: "Navigation history" | |||
There was a problem hiding this comment.
Suggested change
| title: "Navigation history" | |
| title: "Navigation History" |
| The [NavigationHistory](latest/api/navigation-history.md) API allows you to manage and interact with the browsing history of your Electron application. This powerful feature enables you to create intuitive navigation experiences for your users. | ||
|
|
||
| ### Accessing NavigationHistory | ||
| To use NavigationHistory, access it through the webContents of your BrowserWindow: |
There was a problem hiding this comment.
Suggested change
| To use NavigationHistory, access it through the webContents of your BrowserWindow: | |
| To use NavigationHistory, access it through the [webContents](../api/web-contents.md) of your [BrowserWindow](../api/browser-window.md): |
Comment on lines
+19
to
+20
| let mainWindow = new BrowserWindow({ width: 800, height: 600 }) | ||
| let navigationHistory = mainWindow.webContents.navigationHistory |
There was a problem hiding this comment.
Suggested change
| let mainWindow = new BrowserWindow({ width: 800, height: 600 }) | |
| let navigationHistory = mainWindow.webContents.navigationHistory | |
| const mainWindow = new BrowserWindow({ width: 800, height: 600 }) | |
| const navigationHistory = mainWindow.webContents.navigationHistory |
| let navigationHistory = mainWindow.webContents.navigationHistory | ||
| ``` | ||
| ### Key Features | ||
| #### Navigating Through History |
There was a problem hiding this comment.
Suggested change
| #### Navigating Through History | |
| #### Navigating through history |
To be consistent with other docs, all headings should be in sentence case
Comment on lines
+38
to
+39
| #### Accessing History Entries | ||
| Retrieve and display the user's browsing history: |
There was a problem hiding this comment.
I think this will fail lint. We'll need to add a newline in between each heading and content.
Suggested change
| #### Accessing History Entries | |
| Retrieve and display the user's browsing history: | |
| #### Accessing History Entries | |
| Retrieve and display the user's browsing history: |
erickzhao
reviewed
Jul 9, 2024
| let mainWindow = new BrowserWindow({ width: 800, height: 600 }) | ||
| let navigationHistory = mainWindow.webContents.navigationHistory | ||
| ``` | ||
| ### Key Features |
There was a problem hiding this comment.
Suggested change
| ### Key Features |
I would remove this heading since it doesn't add anything here
|
Moving this to Todo:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR:
Note:
getAllEntriesdoes not work until this PR is merged, so we can hold on merging or remove the history portion of the example