generated from adobe/aem-boilerplate
-
Notifications
You must be signed in to change notification settings - Fork 168
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MWPW-152411 raw md doc for web components & events
- will need some jsdocs flesh in comments for both components & events, - can be linked from or to with card specific doc pages
- Loading branch information
Showing
7 changed files
with
1,362 additions
and
1,122 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,133 @@ | ||
# a[data-wcs-osi] | ||
|
||
HTML Checkout Link Anchor element, extends anchor | ||
|
||
## Events | ||
|
||
| Event | | ||
|---------------| | ||
| `merch:click` | | ||
|
||
|
||
# span[data-wcs-osi] | ||
|
||
HTML Price Web Component, extends span | ||
|
||
|
||
# wcms-commerce | ||
|
||
Custom web component to provide active instance of commerce service | ||
to consumers, appended to the head section of current document. | ||
|
||
|
||
# merch-card-collection | ||
|
||
## Events | ||
|
||
| Event | Type | | ||
|----------------------------------|--------------------------------| | ||
| `merch-card-collection:showmore` | `CustomEvent<any>` | | ||
| `merch-card-collection:sort` | `CustomEvent<{ value: any; }>` | | ||
|
||
|
||
# merch-card | ||
|
||
## Events | ||
|
||
| Event | Type | | ||
|------------------------|--------------------------------------| | ||
| `merch-card:ready` | `CustomEvent<any>` | | ||
| `merch-storage:change` | `CustomEvent<{ offerSelect: any; }>` | | ||
|
||
|
||
# merch-datasource | ||
|
||
Custom element representing a MerchDataSource. | ||
|
||
|
||
# merch-icon | ||
|
||
|
||
# merch-mnemonic-list | ||
|
||
|
||
# merch-offer-select | ||
|
||
## Events | ||
|
||
| Event | Type | | ||
|----------------------------|---------------------| | ||
| `merch-offer-select:ready` | `CustomEvent<any>` | | ||
| `merch-offer:selected` | `CustomEvent<this>` | | ||
|
||
|
||
# merch-offer | ||
|
||
## Events | ||
|
||
| Event | Type | | ||
|---------------------|--------------------| | ||
| `merch-offer:ready` | `CustomEvent<any>` | | ||
|
||
|
||
# merch-quantity-select | ||
|
||
## Events | ||
|
||
| Event | Type | | ||
|----------------------------------|------------------------------------| | ||
| `merch-quantity-selector:change` | `CustomEvent<{ option: number; }>` | | ||
|
||
|
||
# merch-search | ||
|
||
## Events | ||
|
||
| Event | Type | | ||
|-----------------------|-------------------------------------------------| | ||
| `merch-search:change` | `CustomEvent<{ type: string; value: string; }>` | | ||
|
||
|
||
# merch-secure-transaction | ||
|
||
|
||
# merch-stock | ||
|
||
## Events | ||
|
||
| Event | Type | | ||
|----------------------|-------------------------------------------------| | ||
| `merch-stock:change` | `CustomEvent<{ checked: any; planType: any; }>` | | ||
|
||
|
||
# merch-subscription-panel | ||
|
||
|
||
# merch-twp-d2p | ||
|
||
|
||
# merch-whats-included | ||
|
||
## Events | ||
|
||
| Event | Type | | ||
|--------------------------|--------------------| | ||
| `hide-see-more-elements` | `CustomEvent<any>` | | ||
|
||
|
||
# plans-modal | ||
|
||
|
||
# merch-sidenav-checkbox-group | ||
|
||
|
||
# merch-sidenav-list | ||
|
||
## Events | ||
|
||
| Event | Type | | ||
|------------------------|--------------------------------------------------| | ||
| `merch-sidenav:select` | `CustomEvent<{ type: string; value: any; elt: any; }>` | | ||
|
||
|
||
# merch-sidenav |
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
Oops, something went wrong.