feat: Add parts property on createStencil for better type safety
#3134
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
|
|
Workday/canvas-kit
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| Project |
Workday/canvas-kit
|
| Branch Review |
mc-magic-strings
|
| Run status |
|
| Run duration | 02m 21s |
| Commit |
|
| Committer | Manuel Carrera |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
1
|
Flaky
|
1
|
Pending
|
7
|
Skipped
|
0
|
Passing
|
345
|
| View all changes introduced in this branch ↗︎ | |
Warning
Partial Report: The results for the Application Quality reports may be incomplete.
UI Coverage
14.5%
|
|
|---|---|
|
Untested elements
|
1060
|
|
Tested elements
|
177
|
Accessibility
96.88%
|
|
|---|---|
|
Failed rules
|
4 critical
3 serious
0 moderate
2 minor
|
|
Failed elements
|
91
|
Tests for review
Breadcrumbs.spec.tsx • 1 failed test
| Test | Artifacts | |
|---|---|---|
| given the [Components/Navigation/Breadcrumbs, Overflow Breadcrumbs] menu is rendered > should not have any axe errors |
Test Replay
Screenshots
|
|
The first 5 failed specs are shown, see all 30 specs in Cypress Cloud.
cypress/component/SelectPreview.spec.tsx • 1 flaky test
| Test | Artifacts | |
|---|---|---|
| ... > when the down arrow key is pressed > the menu > should have focus |
Test Replay
Screenshots
|
|
mannycarrera4
commented
Feb 24, 2025
Comment on lines
+20
to
+26
| vars: { | ||
| separator: '', | ||
| }, | ||
| parts: { | ||
| separator: 'card-separator', | ||
| bar: 'foo', | ||
| }, |
There was a problem hiding this comment.
Suggested change
| vars: { | |
| separator: '', | |
| }, | |
| parts: { | |
| separator: 'card-separator', | |
| bar: 'foo', | |
| }, |
mannycarrera4
commented
Feb 24, 2025
Comment on lines
+33
to
+35
| [`:has(${separatorPart})`]: { | ||
| backgroundColor: 'red', | ||
| }, |
There was a problem hiding this comment.
Suggested change
| [`:has(${separatorPart})`]: { | |
| backgroundColor: 'red', | |
| }, |
mannycarrera4
commented
Feb 24, 2025
Comment on lines
+39
to
+51
| const testStencil = createStencil({ | ||
| extends: cardStencil, | ||
| parts: { | ||
| test: 'test-part', | ||
| }, | ||
| base: ({separator, testPart, separatorPart}) => ({ | ||
| [`:has(${separatorPart})`]: { | ||
| color: 'red', | ||
| }, | ||
| [`:has(${testPart})`]: { | ||
| backgroundColor: 'blue', | ||
| }, | ||
| }), |
There was a problem hiding this comment.
Suggested change
| const testStencil = createStencil({ | |
| extends: cardStencil, | |
| parts: { | |
| test: 'test-part', | |
| }, | |
| base: ({separator, testPart, separatorPart}) => ({ | |
| [`:has(${separatorPart})`]: { | |
| color: 'red', | |
| }, | |
| [`:has(${testPart})`]: { | |
| backgroundColor: 'blue', | |
| }, | |
| }), |
mannycarrera4
commented
Feb 24, 2025
Comment on lines
+71
to
+72
| <div data-part={testStencil.parts.separator}>foo</div> | ||
| <div data-part={testStencil.parts.test}>test</div> |
There was a problem hiding this comment.
Suggested change
| <div data-part={testStencil.parts.separator}>foo</div> | |
| <div data-part={testStencil.parts.test}>test</div> |
mannycarrera4
commented
Feb 24, 2025
| @@ -1188,6 +1216,7 @@ export function createStencil< | |||
| }; | |||
| }) as any; | |||
|
|
|||
| stencil.parts = {...composes?.parts, ..._parts} as P; | |||
There was a problem hiding this comment.
@NicholasBoll it is very unhappy about this.
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.
Summary
Fixes: #3118
Release Category
Utils
Release Note
Optional release note message. Changelog and release summaries will contain a pull request title. This section will add additional notes under that title. This section is not a summary, but something extra to point out in release notes. An example might be calling out breaking changes in a labs component or minor visual changes that need visual regression updates. Remove this section if no additional release notes are required.
Checklist
ready for reviewhas been added to PRFor the Reviewer
Where Should the Reviewer Start?
Areas for Feedback? (optional)
Testing Manually
Screenshots or GIFs (if applicable)
Thank You Gif (optional)