Added a new example, session-state #300
Merged
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
|
@bobsilverberg , since you reviewed the code for these APIs, I wondered if you would mind reviewing this example? |
andymckay
reviewed
Oct 13, 2017
session-state/README.md
Outdated
|
|
||
| ## What it shows | ||
|
|
||
| This example demonstrates how you can use the [sessions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/sessions) API to store and retrieve arbitrary state that you want to associate with a tab or window. Then if the tab/window is closed and subsequently restored, you can retrieve the state. |
There was a problem hiding this comment.
I would maybe add some notes about how to do a restore in firefox, as mentioned on IRC so its clear the difference between that and just opening example.com again :)
session-state/background.js
Outdated
| * Add a context menu item to borderify the current tab. | ||
| */ | ||
| browser.menus.create({ | ||
| id: "borderify", |
There was a problem hiding this comment.
minor nit, but if someone had this and borderify installed this might be confusing
session-state/background.js
Outdated
| } | ||
| }); | ||
| }); | ||
| */ |
|
It looks like a decent example to me, @wbamberg. Thanks for creating it. |
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 adds an example of using
sessions.setTabValueandsessions.getTabValueto store and retrieve state that the extension wants to associate with a tab. This means the extension can restore this state if the user closes and then restores the tab.I'd like feedback on whether this is a good example of how to use the API, as well as whether the code seems to be correct. I'm not very keen on the onCreated->onUpdated stuff I do here, but it seems that onCreated is too early to call insertCSS. Of course there are alternative ways we could illustrate the concept without needing insertCSS, but they bring they own complexities too. But I'd be happy to hear suggestions for simplifying the example.