refactor(card): clarify component's slot API #4938
Open
+203
−251
Conversation
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
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 11984367845Details
💛 - Coveralls |
Tachometer resultsChromecard permalinktest-basic
grid permalinkbasic-test
Firefoxcard permalinktest-basic
grid permalinkbasic-test
|
| :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! |
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
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.