-
Notifications
You must be signed in to change notification settings - Fork 168
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
MWPW-152411 raw md doc for web components & events #2903
Conversation
- will need some jsdocs flesh in comments for both components & events, - can be linked from or to with card specific doc pages
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## stage #2903 +/- ##
==========================================
- Coverage 96.24% 96.24% -0.01%
==========================================
Files 236 236
Lines 54253 54264 +11
==========================================
+ Hits 52216 52224 +8
- Misses 2037 2040 +3 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should also document .onceSettled
promise that resolves when wcs calls either succeeds or fails.
I think we should first implement the events we want to trigger, then do the doc.
* HTML Checkout Link Anchor element, extends anchor | ||
* | ||
* @element a[data-wcs-osi] | ||
* @fires merch:click |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it doesn't fire merch:click
though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
right, this was a test, i'll remove it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(click doc will come with click event pr)
/** | ||
* HTML Price Web Component, extends span | ||
* | ||
* @element span[data-wcs-osi] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
span[is="inline-price"]
?
/** @type {Commerce.Price.PlaceholderConstructor} */ | ||
/** | ||
* HTML Price Web Component, extends span. | ||
* special member _onceSettled_ promise that either resolves or fail with web commerce information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it always resolves actually. when it fails, it will add placeholder-failed class to the element.
# merch-twp-d2p | ||
|
||
|
||
# merch-whats-included |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would not include anything that is not ready yet like merch-subscription-panel, merch-twp-d2p, merch-whats-included Comment
closing for now :) |
Test URLs: