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

deprecation: color lightest and darkest #4179

Merged
merged 3 commits into from
Mar 15, 2024
Merged

Conversation

Rajdeepc
Copy link
Contributor

@Rajdeepc Rajdeepc commented Mar 14, 2024

Description

Deprecation warning for color lightest and darkest

Related issue(s)

Motivation and context

How has this been tested?

Screenshot 2024-03-14 at 7 57 15 PM
  • Test case 1
    1. Go here
    2. Do this
  • Test case 2
    1. Go here
    2. Do this

Screenshots (if appropriate)

Screenshot 2024-03-14 at 7 47 29 PM

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

Checklist

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • If my change required a change to the documentation, I have updated the documentation in this pull request.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices

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.

@Rajdeepc Rajdeepc requested a review from Westbrook March 14, 2024 14:27
@Rajdeepc Rajdeepc changed the title deprecation: deprecation warning for color lightest and darkest deprecation: color lightest and darkest Mar 14, 2024
Copy link

github-actions bot commented Mar 14, 2024

Lighthouse scores

Category Latest (report) Main (report) Branch (report)
Performance 0.94 0.97 0.97
Accessibility 1 1 1
Best Practices 1 1 1
SEO 1 0.92 0.92
PWA 1 1 1
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 main ("Main"). Higher scores are better, but note that the SEO scores on Netlify URLs are artifically constrained to 0.92.

Transfer Size

Category Latest Main Branch
Total 241.319 kB 228.848 kB 228.645 kB 🏆
Scripts 60.515 kB 54.628 kB 🏆 54.668 kB
Stylesheet 48.274 kB 42.339 kB 42.103 kB 🏆
Document 5.818 kB 5.169 kB 5.162 kB 🏆
Third Party 126.712 kB 126.712 kB 126.712 kB

Request Count

Category Latest Main Branch
Total 43 43 43
Scripts 35 35 35
Stylesheet 5 5 5
Document 1 1 1
Third Party 2 2 2

Copy link

github-actions bot commented Mar 14, 2024

Tachometer results

Chrome

action-bar permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 483 kB 69.13ms - 72.25ms - unsure 🔍
-4% - +2%
-2.91ms - +1.68ms
branch 474 kB 69.62ms - 72.99ms unsure 🔍
-2% - +4%
-1.68ms - +2.91ms
-

action-menu permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 644 kB 161.16ms - 165.20ms - unsure 🔍
-1% - +2%
-1.76ms - +3.35ms
branch 636 kB 160.82ms - 163.95ms unsure 🔍
-2% - +1%
-3.35ms - +1.76ms
-

banner permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 358 kB 20.85ms - 21.04ms - unsure 🔍
-0% - +1%
-0.01ms - +0.24ms
branch 350 kB 20.76ms - 20.91ms unsure 🔍
-1% - +0%
-0.24ms - +0.01ms
-

card permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 502 kB 58.83ms - 59.45ms - unsure 🔍
-1% - +0%
-0.82ms - +0.20ms
branch 493 kB 59.05ms - 59.85ms unsure 🔍
-0% - +1%
-0.20ms - +0.82ms
-

coachmark permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 626 kB 111.86ms - 115.01ms - unsure 🔍
-1% - +2%
-1.13ms - +2.50ms
branch 618 kB 111.85ms - 113.65ms unsure 🔍
-2% - +1%
-2.50ms - +1.13ms
-

combobox permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 704 kB 36.63ms - 37.05ms - unsure 🔍
-1% - +1%
-0.20ms - +0.38ms
branch 696 kB 36.55ms - 36.95ms unsure 🔍
-1% - +1%
-0.38ms - +0.20ms
-

light-dom-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 705 kB 387.29ms - 393.70ms - unsure 🔍
-1% - +2%
-2.55ms - +5.84ms
branch 696 kB 386.14ms - 391.55ms unsure 🔍
-1% - +1%
-5.84ms - +2.55ms
-

menu permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 473 kB 205.26ms - 208.13ms - unsure 🔍
-1% - +1%
-2.71ms - +1.95ms
branch 465 kB 205.24ms - 208.91ms unsure 🔍
-1% - +1%
-1.95ms - +2.71ms
-

overlay permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 674 kB 457.00ms - 460.45ms - unsure 🔍
-1% - +0%
-4.78ms - +0.08ms
branch 682 kB 459.35ms - 462.78ms unsure 🔍
-0% - +1%
-0.08ms - +4.78ms
-

directive-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 785 kB 35.63ms - 36.17ms - unsure 🔍
-3% - +0%
-0.96ms - +0.12ms
branch 760 kB 35.86ms - 36.79ms unsure 🔍
-0% - +3%
-0.12ms - +0.96ms
-

element-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 756 kB 340.73ms - 344.05ms - unsure 🔍
-1% - +1%
-2.81ms - +2.08ms
branch 748 kB 340.95ms - 344.55ms unsure 🔍
-1% - +1%
-2.08ms - +2.81ms
-

lazy-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 757 kB 51.93ms - 52.82ms - unsure 🔍
-2% - +1%
-0.79ms - +0.51ms
branch 749 kB 52.05ms - 52.99ms unsure 🔍
-1% - +2%
-0.51ms - +0.79ms
-

picker permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 510 kB 548.01ms - 557.32ms - unsure 🔍
-1% - +1%
-5.39ms - +7.59ms
branch 502 kB 547.04ms - 556.08ms unsure 🔍
-1% - +1%
-7.59ms - +5.39ms
-

popover permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 382 kB 20.63ms - 21.00ms - unsure 🔍
-2% - +1%
-0.32ms - +0.14ms
branch 373 kB 20.77ms - 21.03ms unsure 🔍
-1% - +2%
-0.14ms - +0.32ms
-

quick-actions permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 359 kB 13.90ms - 14.13ms - unsure 🔍
-1% - +1%
-0.20ms - +0.13ms
branch 350 kB 13.94ms - 14.16ms unsure 🔍
-1% - +1%
-0.13ms - +0.20ms
-

slider permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 477 kB 102.72ms - 104.59ms - unsure 🔍
-1% - +2%
-1.11ms - +1.73ms
branch 469 kB 102.28ms - 104.42ms unsure 🔍
-2% - +1%
-1.73ms - +1.11ms
-

split-button permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 717 kB 1865.07ms - 1867.94ms - unsure 🔍
-0% - +0%
-1.75ms - +2.44ms
branch 710 kB 1864.64ms - 1867.68ms unsure 🔍
-0% - +0%
-2.44ms - +1.75ms
-

tooltip permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 650 kB 60.29ms - 61.25ms - unsure 🔍
-2% - +1%
-1.14ms - +0.60ms
branch 642 kB 60.31ms - 61.76ms unsure 🔍
-1% - +2%
-0.60ms - +1.14ms
-

test-directive permalink

Version Bytes Avg Time vs remote vs branch
npm latest 630 kB 34.52ms - 35.10ms - unsure 🔍
-1% - +1%
-0.39ms - +0.41ms
branch 622 kB 34.53ms - 35.08ms unsure 🔍
-1% - +1%
-0.41ms - +0.39ms
-
Firefox

action-bar permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 483 kB 144.33ms - 150.55ms - unsure 🔍
-4% - +2%
-5.81ms - +3.69ms
branch 474 kB 144.92ms - 152.08ms unsure 🔍
-3% - +4%
-3.69ms - +5.81ms
-

action-menu permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 644 kB 315.17ms - 327.63ms - unsure 🔍
-3% - +2%
-10.26ms - +7.58ms
branch 636 kB 316.35ms - 329.13ms unsure 🔍
-2% - +3%
-7.58ms - +10.26ms
-

banner permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 358 kB 41.34ms - 45.74ms - unsure 🔍
-5% - +10%
-2.08ms - +4.20ms
branch 350 kB 40.24ms - 44.72ms unsure 🔍
-10% - +5%
-4.20ms - +2.08ms
-

card permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 502 kB 111.25ms - 117.31ms - unsure 🔍
-5% - +3%
-6.07ms - +3.79ms
branch 493 kB 111.53ms - 119.31ms unsure 🔍
-3% - +5%
-3.79ms - +6.07ms
-

coachmark permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 626 kB 395.83ms - 405.29ms - unsure 🔍
-1% - +3%
-3.31ms - +13.03ms
branch 618 kB 389.04ms - 402.36ms unsure 🔍
-3% - +1%
-13.03ms - +3.31ms
-

combobox permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 704 kB 66.22ms - 71.82ms - slower ❌
6% - 15%
3.69ms - 9.59ms
branch 696 kB 61.45ms - 63.31ms faster ✔
6% - 14%
3.69ms - 9.59ms
-

light-dom-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 705 kB 710.51ms - 728.05ms - slower ❌
3% - 6%
21.99ms - 42.61ms
branch 696 kB 681.55ms - 692.41ms faster ✔
3% - 6%
21.99ms - 42.61ms
-

menu permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 473 kB 435.76ms - 447.16ms - unsure 🔍
-1% - +2%
-4.92ms - +10.00ms
branch 465 kB 434.11ms - 443.73ms unsure 🔍
-2% - +1%
-10.00ms - +4.92ms
-

overlay permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 763 kB 698.99ms - 705.45ms - slower ❌
1% - 4%
8.23ms - 26.25ms
branch 755 kB 676.57ms - 693.39ms faster ✔
1% - 4%
8.23ms - 26.25ms
-

directive-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 765 kB 71.53ms - 72.11ms - faster ✔
0% - 3%
0.11ms - 2.41ms
branch 757 kB 71.97ms - 74.19ms slower ❌
0% - 3%
0.11ms - 2.41ms
-

element-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 756 kB 625.45ms - 629.47ms - slower ❌
5% - 6%
29.23ms - 36.65ms
branch 748 kB 591.40ms - 597.64ms faster ✔
5% - 6%
29.23ms - 36.65ms
-

lazy-test permalink

Version Bytes Avg Time vs remote vs branch
npm latest 757 kB 114.44ms - 119.64ms - slower ❌
7% - 12%
7.21ms - 12.67ms
branch 749 kB 106.26ms - 107.94ms faster ✔
6% - 11%
7.21ms - 12.67ms
-

picker permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 510 kB 1010.91ms - 1037.69ms - unsure 🔍
-1% - +2%
-10.10ms - +21.34ms
branch 502 kB 1010.46ms - 1026.90ms unsure 🔍
-2% - +1%
-21.34ms - +10.10ms
-

popover permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 382 kB 43.29ms - 46.79ms - unsure 🔍
-10% - +3%
-4.88ms - +1.48ms
branch 373 kB 44.09ms - 49.39ms unsure 🔍
-3% - +11%
-1.48ms - +4.88ms
-

quick-actions permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 359 kB 29.31ms - 32.57ms - unsure 🔍
-7% - +7%
-2.30ms - +2.22ms
branch 350 kB 29.41ms - 32.55ms unsure 🔍
-7% - +7%
-2.22ms - +2.30ms
-

slider permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 477 kB 202.11ms - 209.05ms - unsure 🔍
-1% - +4%
-2.44ms - +7.24ms
branch 469 kB 199.80ms - 206.56ms unsure 🔍
-4% - +1%
-7.24ms - +2.44ms
-

split-button permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 717 kB 1646.97ms - 1653.67ms - unsure 🔍
-0% - +1%
-1.80ms - +8.48ms
branch 710 kB 1643.08ms - 1650.88ms unsure 🔍
-1% - +0%
-8.48ms - +1.80ms
-

tooltip permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 650 kB 210.26ms - 216.98ms - slower ❌
0% - 4%
0.32ms - 9.20ms
branch 642 kB 205.95ms - 211.77ms faster ✔
0% - 4%
0.32ms - 9.20ms
-

test-directive permalink

Version Bytes Avg Time vs remote vs branch
npm latest 630 kB 72.13ms - 74.83ms - faster ✔
20% - 25%
18.56ms - 24.64ms
branch 622 kB 92.35ms - 97.81ms slower ❌
25% - 34%
18.56ms - 24.64ms
-

Copy link
Contributor

@Westbrook Westbrook left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit in the language. If you think component work well enough, we can move this forward, but want to see if we're being as clear as possible here.

<sp-icon-alert class="spectrum-InLineAlert-icon" dir="ltr" aria-hidden="true"></sp-icon-alert>
</div>
<div class="spectrum-InLineAlert-content">
This component has been deprecated.<br></br>
{% if isComponent %}
This component will be deprecated.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be package vs component?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So you want to bifurcate as a package and a tool?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tricky intersection of naming. Here, by "package", I mean @spectrum-web-components/... as found on NPM. So any directory that gets published would satisfy this meaning.

Maybe the more flexible approach would be to leverage the deprecationNotice only, and require that we make we include text of this shape there rather than centralizing it here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we can make something like @spectrum-web-components/packages/banner will be deprecated instead of This component will be deprecated maybe something like this?
Screenshot 2024-03-15 at 12 13 17 PM
Screenshot 2024-03-15 at 12 13 24 PM

@Rajdeepc Rajdeepc requested a review from Westbrook March 15, 2024 08:21
Copy link
Contributor

@Westbrook Westbrook left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! :shipit:

@Westbrook Westbrook merged commit 0c01a66 into main Mar 15, 2024
49 checks passed
@Westbrook Westbrook deleted the deprecation/theme-color branch March 15, 2024 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants