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

MWPW-152411 raw md doc for web components & events #2903

Open
wants to merge 3 commits into
base: stage
Choose a base branch
from

Conversation

npeltier
Copy link
Contributor

  • will need some jsdocs flesh in comments for both components & events,
  • can be linked from or to with card specific doc pages

Test URLs:

- will need some jsdocs flesh in comments for both components & events,
- can be linked from or to with card specific doc pages
@npeltier npeltier added trivial PR doesn't require E2E testing by a reviewer commerce labels Sep 18, 2024
@npeltier npeltier requested a review from a team as a code owner September 18, 2024 19:46
Copy link
Contributor

aem-code-sync bot commented Sep 18, 2024

Page Scores Audits Google
📱 /?martech=off PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI
🖥️ /?martech=off PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI

Copy link

codecov bot commented Sep 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.24%. Comparing base (c80cf18) to head (63b03e9).
Report is 1 commits behind head on stage.

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.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@yesil yesil left a 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
Copy link
Contributor

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.

Copy link
Contributor Author

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

Copy link
Contributor Author

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]
Copy link
Contributor

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.
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
commerce trivial PR doesn't require E2E testing by a reviewer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants