docs(overlay): include event lisings #1381
Merged
Conversation
This file contains hidden or 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
Westbrook
added
Component: Overlay
Component: Documentation
Westbrook
force-pushed
the
westbrook/overlay-events
branch
from
4508349 to
c493a80
Compare
najikahalsema
requested changes
Apr 20, 2021
packages/overlay/README.md
Outdated
|
|
||
| ### Events | ||
|
|
||
| The work to both open and close an overlay is asyncronous. This asyncrony is surfaced into the application via DOM events dispatched from the `trigger` element of your overlay. An `sp-opened` event will be dispatched once the overlay has completed all of the work involved in opening an overlay, and an `sp-closed` event will be dispatched onced the overlay has finished closing. In both cases the dispatched event will include a `detail` property with an `interaction: TriggerInteractions` key to support associating the event/overlay with its originating `interaction`. |
Member
There was a problem hiding this comment.
asynchronous/asynchrony are misspelled.
I would also maybe reword " An sp-opened event will be dispatched once the overlay has completed all of the work involved in opening an overlay" to "An sp-opened event will be dispatched once the overlay has done the work to open an overlay" to make it a little less wordy.
Contributor
Author
There was a problem hiding this comment.
Cool. Took the reduction a little further in that sentence, but great instinct.
Westbrook
force-pushed
the
westbrook/overlay-events
branch
from
c493a80 to
5dabb1c
Compare
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.
Description
A first iteration of event documentation in non-element docs pages. All info, no style... so, happy to take notes if there was something easily attainable that was more informative here. We need to expand on our ability to document non-element content, but I'm not sure where to take this right now. This hopefully gets the information into the world, and we can revisit this page (and bundle/base/styles/etc.) soon.
Related Issue
fixes #1360
Motivation and Context
Ensure users know the capabilities made available to them by our APIs.
Screenshots (if appropriate):
https://westbrook-overlay-events--spectrum-web-components.netlify.app/components/overlay
Types of changes
Checklist: