refactor(card): clarify component's slot API #4938
Conversation
Branch previewReview the following VRT differencesWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
If the changes are expected, update the |
Lighthouse scores
What is this?Lighthouse scores comparing the documentation site built from the PR ("Branch") to that of the production documentation site ("Latest") and the build currently on Transfer Size
Request Count
|
Pull Request Test Coverage Report for Build 12648533469Details
💛 - Coveralls |
Tachometer resultsChromecard permalinktest-basic
grid permalinkbasic-test
icons permalinktest-basic
Firefoxcard permalinktest-basic
grid permalinkbasic-test
icons permalinktest-basic
|
| :host(:not([variant='quiet'])) #preview ::slotted(*) { | ||
| width: 100%; | ||
| #preview ::slotted(*) { | ||
| inline-size: 100%; |
There was a problem hiding this comment.
Should include the quiet variant as per spectrum-css.
mizgaionutalexandru
changed the title
|
This will become a breaking change! Will bring this up in our office hours! |
There was a problem hiding this comment.
We need to create a section called BREAKING CHANGE to surface up this change to the consumers. Let's talk in the office hours and get some more opinions from other product teams. I feel there is a lot of usage of the Card and the asset components in multiple products.
| import '@spectrum-web-components/checkbox/sp-checkbox.js'; | ||
| import '@spectrum-web-components/popover/sp-popover.js'; | ||
| import { Checkbox } from '@spectrum-web-components/checkbox/src/Checkbox'; |
There was a problem hiding this comment.
| import { Checkbox } from '@spectrum-web-components/checkbox/src/Checkbox'; | |
| import { Checkbox } from '@spectrum-web-components/checkbox'; |
|
|
||
| /** | ||
| * @element sp-card | ||
| * | ||
| * @fires change - Announces a change in the `selected` property of a card | ||
| * @slot preview - This is the preview image for Gallery Cards | ||
| * @slot cover-photo - This is the cover photo for Default and Quiet Cards | ||
| * @slot image - This is the image of the card |
There was a problem hiding this comment.
| * @slot image - This is the image of the card | |
| * @slot image - Image content |
| @@ -207,7 +204,7 @@ export class Card extends LikeAnchor( | |||
| this.addEventListener('pointercancel', handleEnd); | |||
| } | |||
|
|
|||
| protected get renderHeading(): TemplateResult { | |||
| protected renderHeading(): TemplateResult { | |||
There was a problem hiding this comment.
I dont see any computation logic here so why change to a callable function instead of keeping it as a getter?
There was a problem hiding this comment.
I think the naming fits a method better than a getter due to the fact that it contains a verb. Would you prefer another naming pattern?
|
|
Thank you for your contribution here! I’m fully on board with this proposal. Just one thing: we’ve been following a practice of providing a migration period where we log developer warnings to inform users and allow them time to migrate while maintaining backward compatibility. |
Description
This PR addresses APIs misunderstandings regarding the
sp-cardcomponent's slots. Previously used slotspreviewandcover-photoare now merged into a single one namedimage. The styles are applied exactly as before, based on thevariantandhorizontalproperties, through using the according id that maps to spectrum CSS styles.Also, now the
quietvariant is included in the style overrides, and a new--mod-*CSS variable was added to allow consumers to reliably obtain the desired behaviour (the added story reflects the usage of this token).Some CSS was also changed to remove deprecated overrides and improve readability.
Related issue(s)
Motivation and context
cover-photoslot should be used with thequietvariant. The consumer should not need to determine which slot to use with each variant.previewwith thequietvariantpreviewwith thequietvariantquietvariant was included in thewidth: 100%at a previous point in time but the change to not include it anymore wasn't documented too much. There is a need to come back to the previous behaviour (to include thequietvariant in the full width CSS). It seems like a--mod-*is the best common ground to allow consumers all behaviours related to using an image and how to position it inside the asset, be that cover, contain, scale-down etc. (discussion context)How has this been tested?
No functional changes were added. All the slots usage in the project have been updated. This being said, all unit tests should pass and VRTs should show changes only for the quiet variant's initial width. A new story was added to reflect the usage of the newly added token.
Screenshots (if appropriate)
Types of changes
Checklist
Best practices
This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against
main.