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.

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

init StorageEvent documentation #29760

Merged
merged 24 commits into from
Nov 29, 2023
Merged

Conversation

skyclouds2001
Copy link
Contributor

@skyclouds2001 skyclouds2001 commented Oct 21, 2023

Description

add StorageEvent documentation

Motivation

add those missing documentations of StorageEvent

StorageEvent()
StorageEvent.key
StorageEvent.newValue
StorageEvent.oldValue
StorageEvent.storageArea
StorageEvent.url

Additional details

See StorageEvent Interface

Also Broadcast Storage Event

Related issues and pull requests

Fixes #29419

@github-actions github-actions bot added the Content:WebAPI Web API docs label Oct 21, 2023
@skyclouds2001 skyclouds2001 changed the title Storage-event init StorageEvent documentation Oct 21, 2023
@skyclouds2001 skyclouds2001 marked this pull request as ready for review October 27, 2023 14:34
@skyclouds2001 skyclouds2001 requested a review from a team as a code owner October 27, 2023 14:34
@skyclouds2001 skyclouds2001 requested review from wbamberg and removed request for a team October 27, 2023 14:34
files/en-us/web/api/storageevent/newvalue/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/storageevent/newvalue/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/storageevent/oldvalue/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/storageevent/oldvalue/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/storageevent/storagearea/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/storageevent/storageevent/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/storageevent/storageevent/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/storageevent/storageevent/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/storageevent/url/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/storageevent/url/index.md Outdated Show resolved Hide resolved
@ShubhamOulkar
Copy link
Contributor

@skyclouds2001 , This event is not cancelable and does not bubble.
add this in document.

StorageEvent

@teoli2003
Copy link
Member

@skyclouds2001 , This event is not cancelable and does not bubble. add this in document.

This can be added as a sentence at the end of the storage event page on Window.

This event is not cancelable and does not bubble.

Copy link
Contributor

@ShubhamOulkar ShubhamOulkar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hope this will be helpful.

files/en-us/web/api/storageevent/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/window/storage_event/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/window/storage_event/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/storageevent/index.md Outdated Show resolved Hide resolved
@teoli2003
Copy link
Member

@ShubhamOulkar There is a GitHub feature that allows you to propose a change:
Capture d’écran 2023-11-29 à 09 55 21

When clicking on the +/- button, you can make a suggestion: the author can accept it if it is pertinent. It is quicker, and GitHub credits you with the edit.

@skyclouds2001
Copy link
Contributor Author

skyclouds2001 commented Nov 29, 2023

@skyclouds2001 , This event is not cancelable and does not bubble. add this in document.

StorageEvent

Thanks!

Content updated

@skyclouds2001
Copy link
Contributor Author

I hope this will be helpful.

I'm not quite agree with the change on deleting -, but other text update seems good!

@teoli2003
Copy link
Member

I hope this will be helpful.

I'm not quite agree with the change on deleting -, but other text update seems good!

Where do you see this?

@ShubhamOulkar
Copy link
Contributor

I hope this will be helpful.

I'm not quite agree with the change on deleting -, but other text update seems good!

is it about sessionStorage deletion?

@skyclouds2001
Copy link
Contributor Author

I mean, the part I don't think it should change

image

@teoli2003
Copy link
Member

Yep, these ' - ' shouldn't be removed.

Copy link
Member

@teoli2003 teoli2003 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@teoli2003 teoli2003 merged commit cec2a00 into mdn:main Nov 29, 2023
7 checks passed
Copy link
Contributor

@ShubhamOulkar ShubhamOulkar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@teoli2003 @skyclouds2001, see following gif as proof from my side
about session storage, if I did anything wrong let me know.

@@ -10,6 +10,8 @@ browser-compat: api.Window.storage_event

The **`storage`** event of the {{domxref("Window")}} interface fires when a storage area (`localStorage` or `sessionStorage`) has been modified in the context of another document.
Copy link
Contributor

@ShubhamOulkar ShubhamOulkar Nov 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It make sense because session storage is bound to current session/tab. What is use of sharing session storage with other tabs ?

sessionStorage

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing documentation for StorageEvent interface member
4 participants