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

Ship Overlay v2 #3456

Merged
merged 46 commits into from
Aug 18, 2023
Merged

Ship Overlay v2 #3456

merged 46 commits into from
Aug 18, 2023

Conversation

Westbrook
Copy link
Contributor

@Westbrook Westbrook commented Jul 17, 2023

Description

Update the Overlay API to leverage <dialog> elements and the popover API as outlined in this discussion.

To do:

  • Update VRTs, I've left this off, for now, in case there are any visual effective code review items
  • include the removal of active-overlay in the migration docs
  • figure out how to get the API table filled for sp-overlay
  • add test for streaming Enter in Picker
  • add test for delayed in the imperative API
  • review the Floating UI bug that pushed multiple updates on open to Safari
  • test Action Menu change event value presence when no selects is provided
  • correct open on load of submenu story

There are a lot of changes herein. To help focus review, I've sequestered specific packages/functional areas into each of the commits in this branch:

Specific feature areas for deeper thought

  • Imperative APIs: We're trying to warn away from them as there will always be a little bit of unexpected behavior there.
    • should they be more feature rich? less?
    • are their Dev Mode messages that we could send these users to point them away from this API
    • a little but of the code path is "left up to fate", is that OK?
  • Overlay [type="page"]
    • small feature, but it's 100% net new, so we want to make sure that we're surfacing this productively
  • Menu system
    • this was a massive refactor from a system that relied on having Menu Items taken on and off of the DOM to work correctly, be on the look out for Menus that fail to capture all of the Items that are provided to them, fail to capture their selection state, or fail to appropriately bind their content to keyboard navigations

Related issue(s)

Motivation and context

Overlays are hard, we want to make it easier through the magic of browsers.

How has this been tested?

Rigorously, extensively, but still with the need of your help!

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

@github-actions
Copy link

github-actions bot commented Jul 17, 2023

Tachometer results

Chrome

accordion permalink

Version Bytes Avg Time vs remote vs branch
npm latest 405 kB 324.36ms - 334.08ms - unsure 🔍
-1% - +3%
-4.27ms - +9.40ms
branch 400 kB 321.84ms - 331.46ms unsure 🔍
-3% - +1%
-9.40ms - +4.27ms
-

action-bar permalink

Version Bytes Avg Time vs remote vs branch
npm latest 477 kB 168.84ms - 175.56ms - unsure 🔍
-1% - +4%
-2.35ms - +7.18ms
branch 472 kB 166.40ms - 173.16ms unsure 🔍
-4% - +1%
-7.18ms - +2.35ms
-

action-button permalink

Version Bytes Avg Time vs remote vs branch
npm latest 517 kB 319.34ms - 328.14ms - unsure 🔍
-3% - +2%
-8.37ms - +5.13ms
branch 513 kB 320.25ms - 330.48ms unsure 🔍
-2% - +3%
-5.13ms - +8.37ms
-

action-group permalink

Version Bytes Avg Time vs remote vs branch
npm latest 538 kB 188.12ms - 194.68ms - faster ✔
0% - 5%
0.27ms - 9.77ms
branch 533 kB 192.99ms - 199.85ms slower ❌
0% - 5%
0.27ms - 9.77ms
-

action-menu permalink

Version Bytes Avg Time vs remote vs branch
npm latest 766 kB 296.34ms - 306.05ms - faster ✔
9% - 13%
31.56ms - 45.46ms
branch 631 kB 334.74ms - 344.68ms slower ❌
10% - 15%
31.56ms - 45.46ms
-

asset permalink

Version Bytes Avg Time vs remote vs branch
npm latest 351 kB 23.19ms - 24.13ms - unsure 🔍
-3% - +4%
-0.64ms - +0.83ms
branch 346 kB 23.00ms - 24.14ms unsure 🔍
-4% - +3%
-0.83ms - +0.64ms
-

avatar permalink

Version Bytes Avg Time vs remote vs branch
npm latest 389 kB 45.40ms - 47.17ms - unsure 🔍
-3% - +3%
-1.29ms - +1.29ms
branch 384 kB 45.35ms - 47.23ms unsure 🔍
-3% - +3%
-1.29ms - +1.29ms
-

badge permalink

Version Bytes Avg Time vs remote vs branch
npm latest 388 kB 72.32ms - 76.02ms - unsure 🔍
-1% - +5%
-0.95ms - +3.84ms
branch 383 kB 71.19ms - 74.25ms unsure 🔍
-5% - +1%
-3.84ms - +0.95ms
-

banner permalink

Version Bytes Avg Time vs remote vs branch
npm latest 350 kB 35.37ms - 36.65ms - unsure 🔍
-2% - +3%
-0.74ms - +0.95ms
branch 345 kB 35.36ms - 36.45ms unsure 🔍
-3% - +2%
-0.95ms - +0.74ms
-

button-group permalink

Version Bytes Avg Time vs remote vs branch
npm latest 432 kB 148.13ms - 152.38ms - unsure 🔍
-3% - +1%
-5.17ms - +1.04ms
branch 427 kB 150.06ms - 154.58ms unsure 🔍
-1% - +3%
-1.04ms - +5.17ms
-

button permalink

Version Bytes Avg Time vs remote vs branch
npm latest 437 kB 170.43ms - 176.55ms - unsure 🔍
-5% - -0%
-8.82ms - +0.04ms
branch 432 kB 174.68ms - 181.09ms unsure 🔍
-0% - +5%
-0.04ms - +8.82ms
-

card permalink

Version Bytes Avg Time vs remote vs branch
npm latest 499 kB 138.42ms - 143.25ms - unsure 🔍
-1% - +3%
-1.08ms - +4.64ms
branch 495 kB 137.52ms - 140.58ms unsure 🔍
-3% - +1%
-4.64ms - +1.08ms
-

checkbox permalink

Version Bytes Avg Time vs remote vs branch
npm latest 413 kB 93.44ms - 97.11ms - unsure 🔍
-1% - +4%
-1.05ms - +3.45ms
branch 409 kB 92.77ms - 95.38ms unsure 🔍
-4% - +1%
-3.45ms - +1.05ms
-

coachmark permalink

Version Bytes Avg Time vs remote vs branch
npm latest 353 kB 57.95ms - 59.44ms - unsure 🔍
-3% - +1%
-1.75ms - +0.53ms
branch 349 kB 58.44ms - 60.17ms unsure 🔍
-1% - +3%
-0.53ms - +1.75ms
-

color-area permalink

Version Bytes Avg Time vs remote vs branch
npm latest 445 kB 246.83ms - 253.99ms - unsure 🔍
-2% - +2%
-5.15ms - +5.05ms
branch 439 kB 246.83ms - 254.10ms unsure 🔍
-2% - +2%
-5.05ms - +5.15ms
-

color-handle permalink

Version Bytes Avg Time vs remote vs branch
npm latest 363 kB 88.06ms - 90.83ms - unsure 🔍
-1% - +3%
-1.21ms - +2.55ms
branch 359 kB 87.49ms - 90.06ms unsure 🔍
-3% - +1%
-2.55ms - +1.21ms
-

color-loupe permalink

Version Bytes Avg Time vs remote vs branch
npm latest 355 kB 58.54ms - 60.58ms - unsure 🔍
-1% - +3%
-0.57ms - +1.96ms
branch 350 kB 58.12ms - 59.62ms unsure 🔍
-3% - +1%
-1.96ms - +0.57ms
-

color-slider permalink

Version Bytes Avg Time vs remote vs branch
npm latest 446 kB 208.41ms - 214.78ms - unsure 🔍
-3% - +2%
-5.53ms - +4.15ms
branch 441 kB 208.64ms - 215.93ms unsure 🔍
-2% - +3%
-4.15ms - +5.53ms
-

color-wheel permalink

Version Bytes Avg Time vs remote vs branch
npm latest 448 kB 207.63ms - 212.77ms - unsure 🔍
-1% - +3%
-2.14ms - +5.52ms
branch 442 kB 205.67ms - 211.35ms unsure 🔍
-3% - +1%
-5.52ms - +2.14ms
-

dialog permalink

Version Bytes Avg Time vs remote vs branch
npm latest 439 kB 88.57ms - 91.90ms - unsure 🔍
-2% - +3%
-1.88ms - +2.56ms
branch 435 kB 88.42ms - 91.36ms unsure 🔍
-3% - +2%
-2.56ms - +1.88ms
-

divider permalink

Version Bytes Avg Time vs remote vs branch
npm latest 352 kB 24.15ms - 25.19ms - unsure 🔍
-3% - +3%
-0.72ms - +0.67ms
branch 348 kB 24.24ms - 25.16ms unsure 🔍
-3% - +3%
-0.67ms - +0.72ms
-

dropzone permalink

Version Bytes Avg Time vs remote vs branch
npm latest 360 kB 69.70ms - 71.51ms - unsure 🔍
-4% - +1%
-2.95ms - +0.47ms
branch 356 kB 70.39ms - 73.29ms unsure 🔍
-1% - +4%
-0.47ms - +2.95ms
-

field-group permalink

Version Bytes Avg Time vs remote vs branch
npm latest 419 kB 391.66ms - 405.14ms - unsure 🔍
-1% - +3%
-4.70ms - +12.35ms
branch 414 kB 389.36ms - 399.79ms unsure 🔍
-3% - +1%
-12.35ms - +4.70ms
-

field-label permalink

Version Bytes Avg Time vs remote vs branch
npm latest 380 kB 54.83ms - 57.46ms - slower ❌
1% - 7%
0.69ms - 3.98ms
branch 376 kB 52.81ms - 54.80ms faster ✔
1% - 7%
0.69ms - 3.98ms
-

grid permalink

Version Bytes Avg Time vs remote vs branch
npm latest 432 kB 76.86ms - 78.89ms - unsure 🔍
-1% - +2%
-0.92ms - +1.88ms
branch 427 kB 76.42ms - 78.36ms unsure 🔍
-2% - +1%
-1.88ms - +0.92ms
-

help-text permalink

Version Bytes Avg Time vs remote vs branch
npm latest 376 kB 27.33ms - 28.48ms - unsure 🔍
-0% - +5%
-0.02ms - +1.40ms
branch 371 kB 26.80ms - 27.64ms unsure 🔍
-5% - +0%
-1.40ms - +0.02ms
-

icon permalink

Version Bytes Avg Time vs remote vs branch
npm latest 383 kB 30.97ms - 31.95ms - unsure 🔍
-2% - +3%
-0.55ms - +0.84ms
branch 378 kB 30.82ms - 31.81ms unsure 🔍
-3% - +2%
-0.84ms - +0.55ms
-

icons permalink

Version Bytes Avg Time vs remote vs branch
npm latest 364 kB 54.37ms - 55.87ms - unsure 🔍
-3% - +2%
-1.55ms - +0.98ms
branch 359 kB 54.39ms - 56.43ms unsure 🔍
-2% - +3%
-0.98ms - +1.55ms
-

illustrated-message permalink

Version Bytes Avg Time vs remote vs branch
npm latest 395 kB 57.33ms - 59.41ms - unsure 🔍
-2% - +4%
-0.92ms - +2.19ms
branch 391 kB 56.58ms - 58.89ms unsure 🔍
-4% - +2%
-2.19ms - +0.92ms
-

link permalink

Version Bytes Avg Time vs remote vs branch
npm latest 374 kB 32.84ms - 34.13ms - unsure 🔍
-3% - +2%
-0.99ms - +0.82ms
branch 369 kB 32.93ms - 34.20ms unsure 🔍
-2% - +3%
-0.82ms - +0.99ms
-

menu permalink

Version Bytes Avg Time vs remote vs branch
npm latest 447 kB 377.24ms - 388.89ms - faster ✔
11% - 15%
46.12ms - 64.19ms
branch 445 kB 431.32ms - 445.13ms slower ❌
12% - 17%
46.12ms - 64.19ms
-

meter permalink

Version Bytes Avg Time vs remote vs branch
npm latest 395 kB 105.66ms - 108.32ms - unsure 🔍
-3% - +1%
-3.26ms - +1.16ms
branch 390 kB 106.27ms - 109.80ms unsure 🔍
-1% - +3%
-1.16ms - +3.26ms
-

number-field permalink

Version Bytes Avg Time vs remote vs branch
npm latest 633 kB 256.59ms - 264.80ms - unsure 🔍
-3% - +1%
-7.98ms - +2.82ms
branch 629 kB 259.76ms - 266.78ms unsure 🔍
-1% - +3%
-2.82ms - +7.98ms
-

overlay permalink

Version Bytes Avg Time vs remote vs branch
npm latest 464 kB 93.80ms - 96.50ms - faster ✔
19% - 22%
22.06ms - 26.57ms
branch 472 kB 117.67ms - 121.27ms slower ❌
23% - 28%
22.06ms - 26.57ms
-

picker-button permalink

Version Bytes Avg Time vs remote vs branch
npm latest 403 kB 72.58ms - 75.05ms - unsure 🔍
-4% - +1%
-3.41ms - +0.63ms
branch 398 kB 73.60ms - 76.80ms unsure 🔍
-1% - +5%
-0.63ms - +3.41ms
-

picker permalink

Version Bytes Avg Time vs remote vs branch
npm latest 621 kB 1150.12ms - 1182.41ms - unsure 🔍
-2% - +2%
-23.64ms - +20.77ms
branch 486 kB 1152.45ms - 1182.94ms unsure 🔍
-2% - +2%
-20.77ms - +23.64ms
-

popover permalink

Version Bytes Avg Time vs remote vs branch
npm latest 373 kB 42.66ms - 44.27ms - unsure 🔍
-0% - +5%
-0.17ms - +2.01ms
branch 368 kB 41.81ms - 43.28ms unsure 🔍
-5% - +0%
-2.01ms - +0.17ms
-

progress-bar permalink

Version Bytes Avg Time vs remote vs branch
npm latest 396 kB 86.84ms - 90.11ms - unsure 🔍
-4% - +1%
-3.44ms - +0.80ms
branch 391 kB 88.45ms - 91.14ms unsure 🔍
-1% - +4%
-0.80ms - +3.44ms
-

progress-circle permalink

Version Bytes Avg Time vs remote vs branch
npm latest 372 kB 85.83ms - 88.62ms - unsure 🔍
-4% - +1%
-3.61ms - +0.66ms
branch 368 kB 87.08ms - 90.32ms unsure 🔍
-1% - +4%
-0.66ms - +3.61ms
-

quick-actions permalink

Version Bytes Avg Time vs remote vs branch
npm latest 351 kB 25.59ms - 26.50ms - unsure 🔍
-1% - +4%
-0.30ms - +1.01ms
branch 346 kB 25.21ms - 26.17ms unsure 🔍
-4% - +1%
-1.01ms - +0.30ms
-

radio permalink

Version Bytes Avg Time vs remote vs branch
npm latest 400 kB 154.31ms - 160.86ms - unsure 🔍
-3% - +3%
-5.28ms - +4.24ms
branch 395 kB 154.65ms - 161.56ms unsure 🔍
-3% - +3%
-4.24ms - +5.28ms
-

search permalink

Version Bytes Avg Time vs remote vs branch
npm latest 475 kB 134.34ms - 138.43ms - unsure 🔍
-3% - +1%
-3.81ms - +1.71ms
branch 470 kB 135.58ms - 139.29ms unsure 🔍
-1% - +3%
-1.71ms - +3.81ms
-

sidenav permalink

Version Bytes Avg Time vs remote vs branch
npm latest 417 kB 539.96ms - 554.59ms - unsure 🔍
-2% - +2%
-11.26ms - +9.51ms
branch 412 kB 540.78ms - 555.52ms unsure 🔍
-2% - +2%
-9.51ms - +11.26ms
-

slider permalink

Version Bytes Avg Time vs remote vs branch
npm latest 460 kB 191.52ms - 200.68ms - unsure 🔍
-2% - +4%
-4.41ms - +7.63ms
branch 456 kB 190.59ms - 198.40ms unsure 🔍
-4% - +2%
-7.63ms - +4.41ms
-

split-button permalink

Version Bytes Avg Time vs remote vs branch
npm latest 697 kB 2045.25ms - 2049.45ms - slower ❌
8% - 8%
145.18ms - 151.86ms
branch 689 kB 1896.23ms - 1901.44ms faster ✔
7% - 7%
145.18ms - 151.86ms
-

split-view permalink

Version Bytes Avg Time vs remote vs branch
npm latest 384 kB 58.35ms - 60.43ms - unsure 🔍
-2% - +3%
-1.10ms - +1.79ms
branch 379 kB 58.04ms - 60.05ms unsure 🔍
-3% - +2%
-1.79ms - +1.10ms
-

swatch permalink

Version Bytes Avg Time vs remote vs branch
npm latest 396 kB 48.23ms - 49.98ms - unsure 🔍
-3% - +3%
-1.24ms - +1.36ms
branch 391 kB 48.09ms - 50.00ms unsure 🔍
-3% - +3%
-1.36ms - +1.24ms
-

switch permalink

Version Bytes Avg Time vs remote vs branch
npm latest 377 kB 57.54ms - 59.39ms - unsure 🔍
-0% - +4%
-0.25ms - +2.07ms
branch 372 kB 56.85ms - 58.25ms unsure 🔍
-4% - +0%
-2.07ms - +0.25ms
-

table permalink

Version Bytes Avg Time vs remote vs branch
npm latest 506 kB 635.74ms - 649.63ms - unsure 🔍
-2% - +1%
-16.04ms - +5.35ms
branch 501 kB 639.90ms - 656.16ms unsure 🔍
-1% - +3%
-5.35ms - +16.04ms
-

tabs permalink

Version Bytes Avg Time vs remote vs branch
npm latest 414 kB 208.78ms - 215.95ms - unsure 🔍
-3% - +2%
-5.55ms - +4.47ms
branch 409 kB 209.41ms - 216.40ms unsure 🔍
-2% - +3%
-4.47ms - +5.55ms
-

tags permalink

Version Bytes Avg Time vs remote vs branch
npm latest 459 kB 36.90ms - 37.91ms - unsure 🔍
-4% - +1%
-1.36ms - +0.47ms
branch 454 kB 37.09ms - 38.61ms unsure 🔍
-1% - +4%
-0.47ms - +1.36ms
-

textfield permalink

Version Bytes Avg Time vs remote vs branch
npm latest 422 kB 81.76ms - 84.51ms - unsure 🔍
-3% - +2%
-2.31ms - +1.68ms
branch 418 kB 82.00ms - 84.90ms unsure 🔍
-2% - +3%
-1.68ms - +2.31ms
-

thumbnail permalink

Version Bytes Avg Time vs remote vs branch
npm latest 754 kB 51.42ms - 53.43ms - unsure 🔍
-3% - +3%
-1.58ms - +1.42ms
branch 750 kB 51.39ms - 53.61ms unsure 🔍
-3% - +3%
-1.42ms - +1.58ms
-

toast permalink

Version Bytes Avg Time vs remote vs branch
npm latest 426 kB 100.62ms - 105.41ms - unsure 🔍
-2% - +5%
-1.56ms - +4.62ms
branch 422 kB 99.53ms - 103.44ms unsure 🔍
-4% - +1%
-4.62ms - +1.56ms
-

tooltip permalink

Version Bytes Avg Time vs remote vs branch
npm latest 548 kB 93.17ms - 98.65ms - faster ✔
22% - 28%
27.66ms - 36.32ms
branch 571 kB 124.55ms - 131.24ms slower ❌
28% - 39%
27.66ms - 36.32ms
-

top-nav permalink

Version Bytes Avg Time vs remote vs branch
npm latest 418 kB 205.04ms - 209.94ms - unsure 🔍
-2% - +1%
-4.55ms - +3.12ms
branch 414 kB 205.25ms - 211.16ms unsure 🔍
-2% - +2%
-3.12ms - +4.55ms
-

tray permalink

Version Bytes Avg Time vs remote vs branch
npm latest 451 kB 156.08ms - 159.70ms - unsure 🔍
-2% - +1%
-3.14ms - +2.07ms
branch 447 kB 156.55ms - 160.30ms unsure 🔍
-1% - +2%
-2.07ms - +3.14ms
-

underlay permalink

Version Bytes Avg Time vs remote vs branch
npm latest 350 kB 30.65ms - 31.72ms - unsure 🔍
-3% - +2%
-0.89ms - +0.75ms
branch 346 kB 30.63ms - 31.88ms unsure 🔍
-2% - +3%
-0.75ms - +0.89ms
-
Firefox

accordion permalink

Version Bytes Avg Time vs remote vs branch
npm latest 405 kB 596.18ms - 624.06ms - unsure 🔍
-5% - +2%
-33.17ms - +10.33ms
branch 400 kB 604.84ms - 638.24ms unsure 🔍
-2% - +5%
-10.33ms - +33.17ms
-

action-bar permalink

Version Bytes Avg Time vs remote vs branch
npm latest 477 kB 401.64ms - 425.96ms - unsure 🔍
-6% - +3%
-23.50ms - +10.98ms
branch 472 kB 407.85ms - 432.27ms unsure 🔍
-3% - +6%
-10.98ms - +23.50ms
-

action-button permalink

Version Bytes Avg Time vs remote vs branch
npm latest 517 kB 572.58ms - 599.62ms - unsure 🔍
-4% - +3%
-21.39ms - +16.23ms
branch 513 kB 575.61ms - 601.75ms unsure 🔍
-3% - +4%
-16.23ms - +21.39ms
-

action-group permalink

Version Bytes Avg Time vs remote vs branch
npm latest 538 kB 390.80ms - 415.64ms - unsure 🔍
-5% - +3%
-22.17ms - +12.53ms
branch 533 kB 395.92ms - 420.16ms unsure 🔍
-3% - +6%
-12.53ms - +22.17ms
-

action-menu permalink

Version Bytes Avg Time vs remote vs branch
npm latest 766 kB 495.78ms - 526.38ms - faster ✔
8% - 15%
43.87ms - 91.13ms
branch 631 kB 560.57ms - 596.59ms slower ❌
8% - 18%
43.87ms - 91.13ms
-

asset permalink

Version Bytes Avg Time vs remote vs branch
npm latest 351 kB 49.77ms - 62.03ms - unsure 🔍
-18% - +11%
-10.49ms - +6.29ms
branch 346 kB 52.27ms - 63.73ms unsure 🔍
-12% - +19%
-6.29ms - +10.49ms
-

avatar permalink

Version Bytes Avg Time vs remote vs branch
npm latest 389 kB 120.30ms - 138.50ms - unsure 🔍
-8% - +12%
-9.52ms - +15.24ms
branch 384 kB 118.14ms - 134.94ms unsure 🔍
-12% - +7%
-15.24ms - +9.52ms
-

badge permalink

Version Bytes Avg Time vs remote vs branch
npm latest 388 kB 172.39ms - 196.21ms - unsure 🔍
-10% - +8%
-19.18ms - +14.54ms
branch 383 kB 174.69ms - 198.55ms unsure 🔍
-8% - +10%
-14.54ms - +19.18ms
-

banner permalink

Version Bytes Avg Time vs remote vs branch
npm latest 350 kB 68.40ms - 83.16ms - unsure 🔍
-11% - +13%
-8.04ms - +9.92ms
branch 345 kB 69.73ms - 79.95ms unsure 🔍
-13% - +11%
-9.92ms - +8.04ms
-

button-group permalink

Version Bytes Avg Time vs remote vs branch
npm latest 432 kB 377.53ms - 407.11ms - unsure 🔍
-1% - +9%
-2.09ms - +32.93ms
branch 427 kB 367.53ms - 386.27ms unsure 🔍
-8% - +0%
-32.93ms - +2.09ms
-

button permalink

Version Bytes Avg Time vs remote vs branch
npm latest 437 kB 389.88ms - 407.68ms - unsure 🔍
-8% - +1%
-34.08ms - +5.04ms
branch 432 kB 395.89ms - 430.71ms unsure 🔍
-1% - +9%
-5.04ms - +34.08ms
-

card permalink

Version Bytes Avg Time vs remote vs branch
npm latest 499 kB 313.14ms - 332.30ms - unsure 🔍
-6% - +4%
-18.12ms - +11.60ms
branch 495 kB 314.61ms - 337.35ms unsure 🔍
-4% - +6%
-11.60ms - +18.12ms
-

checkbox permalink

Version Bytes Avg Time vs remote vs branch
npm latest 413 kB 266.24ms - 286.52ms - unsure 🔍
-7% - +5%
-20.16ms - +14.00ms
branch 409 kB 265.71ms - 293.21ms unsure 🔍
-5% - +7%
-14.00ms - +20.16ms
-

coachmark permalink

Version Bytes Avg Time vs remote vs branch
npm latest 353 kB 161.61ms - 182.91ms - unsure 🔍
-4% - +13%
-5.71ms - +21.71ms
branch 349 kB 155.62ms - 172.90ms unsure 🔍
-12% - +3%
-21.71ms - +5.71ms
-

color-area permalink

Version Bytes Avg Time vs remote vs branch
npm latest 445 kB 459.14ms - 484.90ms - unsure 🔍
-7% - +0%
-34.63ms - +2.11ms
branch 439 kB 475.19ms - 501.37ms unsure 🔍
-1% - +7%
-2.11ms - +34.63ms
-

color-handle permalink

Version Bytes Avg Time vs remote vs branch
npm latest 363 kB 206.07ms - 233.85ms - unsure 🔍
-9% - +9%
-20.70ms - +19.14ms
branch 359 kB 206.46ms - 235.02ms unsure 🔍
-9% - +9%
-19.14ms - +20.70ms
-

color-loupe permalink

Version Bytes Avg Time vs remote vs branch
npm latest 355 kB 157.81ms - 178.43ms - unsure 🔍
-12% - +6%
-21.88ms - +10.68ms
branch 350 kB 161.12ms - 186.32ms unsure 🔍
-6% - +13%
-10.68ms - +21.88ms
-

color-slider permalink

Version Bytes Avg Time vs remote vs branch
npm latest 446 kB 449.43ms - 468.49ms - unsure 🔍
-5% - +3%
-25.66ms - +12.26ms
branch 441 kB 449.27ms - 482.05ms unsure 🔍
-3% - +6%
-12.26ms - +25.66ms
-

color-wheel permalink

Version Bytes Avg Time vs remote vs branch
npm latest 448 kB 439.03ms - 461.77ms - unsure 🔍
-4% - +3%
-20.03ms - +13.83ms
branch 442 kB 440.96ms - 466.04ms unsure 🔍
-3% - +4%
-13.83ms - +20.03ms
-

dialog permalink

Version Bytes Avg Time vs remote vs branch
npm latest 439 kB 205.38ms - 224.30ms - unsure 🔍
-9% - +4%
-20.28ms - +8.80ms
branch 435 kB 209.54ms - 231.62ms unsure 🔍
-4% - +10%
-8.80ms - +20.28ms
-

divider permalink

Version Bytes Avg Time vs remote vs branch
npm latest 352 kB 82.84ms - 96.28ms - unsure 🔍
-11% - +8%
-10.35ms - +7.67ms
branch 348 kB 84.90ms - 96.90ms unsure 🔍
-9% - +12%
-7.67ms - +10.35ms
-

dropzone permalink

Version Bytes Avg Time vs remote vs branch
npm latest 360 kB 142.30ms - 154.98ms - unsure 🔍
-6% - +8%
-9.19ms - +11.47ms
branch 356 kB 139.35ms - 155.65ms unsure 🔍
-8% - +6%
-11.47ms - +9.19ms
-

field-group permalink

Version Bytes Avg Time vs remote vs branch
npm latest 419 kB 979.75ms - 1011.25ms - unsure 🔍
-2% - +2%
-21.71ms - +18.59ms
branch 414 kB 984.50ms - 1009.62ms unsure 🔍
-2% - +2%
-18.59ms - +21.71ms
-

field-label permalink

Version Bytes Avg Time vs remote vs branch
npm latest 380 kB 154.21ms - 180.51ms - unsure 🔍
-9% - +12%
-14.57ms - +20.29ms
branch 376 kB 153.06ms - 175.94ms unsure 🔍
-12% - +9%
-20.29ms - +14.57ms
-

grid permalink

Version Bytes Avg Time vs remote vs branch
npm latest 432 kB 147.01ms - 173.67ms - unsure 🔍
-12% - +11%
-18.54ms - +18.34ms
branch 427 kB 147.70ms - 173.18ms unsure 🔍
-11% - +12%
-18.34ms - +18.54ms
-

help-text permalink

Version Bytes Avg Time vs remote vs branch
npm latest 376 kB 92.42ms - 108.86ms - unsure 🔍
-9% - +13%
-8.81ms - +12.53ms
branch 371 kB 91.98ms - 105.58ms unsure 🔍
-12% - +9%
-12.53ms - +8.81ms
-

icon permalink

Version Bytes Avg Time vs remote vs branch
npm latest 383 kB 98.71ms - 117.09ms - unsure 🔍
-8% - +17%
-8.10ms - +17.58ms
branch 378 kB 94.20ms - 112.12ms unsure 🔍
-16% - +7%
-17.58ms - +8.10ms
-

icons permalink

Version Bytes Avg Time vs remote vs branch
npm latest 364 kB 128.78ms - 143.98ms - unsure 🔍
-10% - +6%
-14.74ms - +8.22ms
branch 359 kB 131.04ms - 148.24ms unsure 🔍
-6% - +11%
-8.22ms - +14.74ms
-

illustrated-message permalink

Version Bytes Avg Time vs remote vs branch
npm latest 395 kB 168.99ms - 188.33ms - unsure 🔍
-7% - +9%
-12.41ms - +15.97ms
branch 391 kB 166.50ms - 187.26ms unsure 🔍
-9% - +7%
-15.97ms - +12.41ms
-

link permalink

Version Bytes Avg Time vs remote vs branch
npm latest 374 kB 99.92ms - 111.76ms - unsure 🔍
-11% - +7%
-11.89ms - +7.21ms
branch 369 kB 100.68ms - 115.68ms unsure 🔍
-7% - +11%
-7.21ms - +11.89ms
-

menu permalink

Version Bytes Avg Time vs remote vs branch
npm latest 447 kB 809.43ms - 841.41ms - faster ✔
4% - 9%
32.28ms - 79.28ms
branch 445 kB 863.98ms - 898.42ms slower ❌
4% - 10%
32.28ms - 79.28ms
-

meter permalink

Version Bytes Avg Time vs remote vs branch
npm latest 395 kB 269.91ms - 292.29ms - unsure 🔍
-4% - +8%
-10.45ms - +21.21ms
branch 390 kB 264.53ms - 286.91ms unsure 🔍
-7% - +4%
-21.21ms - +10.45ms
-

number-field permalink

Version Bytes Avg Time vs remote vs branch
npm latest 633 kB 564.38ms - 597.06ms - unsure 🔍
-4% - +3%
-25.38ms - +20.34ms
branch 629 kB 567.25ms - 599.23ms unsure 🔍
-4% - +4%
-20.34ms - +25.38ms
-

overlay permalink

Version Bytes Avg Time vs remote vs branch
npm latest 464 kB 212.24ms - 225.56ms - faster ✔
26% - 35%
78.28ms - 116.72ms
branch 472 kB 298.37ms - 334.43ms slower ❌
35% - 54%
78.28ms - 116.72ms
-

picker-button permalink

Version Bytes Avg Time vs remote vs branch
npm latest 403 kB 190.87ms - 212.21ms - unsure 🔍
-7% - +9%
-14.37ms - +18.13ms
branch 398 kB 187.40ms - 211.92ms unsure 🔍
-9% - +7%
-18.13ms - +14.37ms
-

picker permalink

Version Bytes Avg Time vs remote vs branch
npm latest 621 kB 1552.01ms - 1604.67ms - unsure 🔍
-1% - +4%
-15.33ms - +56.81ms
branch 486 kB 1532.94ms - 1582.26ms unsure 🔍
-4% - +1%
-56.81ms - +15.33ms
-

popover permalink

Version Bytes Avg Time vs remote vs branch
npm latest 373 kB 145.23ms - 168.45ms - unsure 🔍
-9% - +10%
-14.72ms - +15.88ms
branch 368 kB 146.29ms - 166.23ms unsure 🔍
-10% - +9%
-15.88ms - +14.72ms
-

progress-bar permalink

Version Bytes Avg Time vs remote vs branch
npm latest 396 kB 213.78ms - 232.42ms - unsure 🔍
-8% - +5%
-19.23ms - +10.71ms
branch 391 kB 215.65ms - 239.07ms unsure 🔍
-5% - +9%
-10.71ms - +19.23ms
-

progress-circle permalink

Version Bytes Avg Time vs remote vs branch
npm latest 372 kB 280.64ms - 302.68ms - unsure 🔍
-6% - +4%
-17.65ms - +12.21ms
branch 368 kB 284.30ms - 304.46ms unsure 🔍
-4% - +6%
-12.21ms - +17.65ms
-

quick-actions permalink

Version Bytes Avg Time vs remote vs branch
npm latest 351 kB 80.05ms - 96.07ms - unsure 🔍
-11% - +15%
-9.52ms - +12.56ms
branch 346 kB 78.93ms - 94.15ms unsure 🔍
-14% - +11%
-12.56ms - +9.52ms
-

radio permalink

Version Bytes Avg Time vs remote vs branch
npm latest 400 kB 355.34ms - 373.46ms - unsure 🔍
-5% - +3%
-17.08ms - +11.52ms
branch 395 kB 356.11ms - 378.25ms unsure 🔍
-3% - +5%
-11.52ms - +17.08ms
-

search permalink

Version Bytes Avg Time vs remote vs branch
npm latest 475 kB 287.03ms - 314.73ms - unsure 🔍
-0% - +12%
-0.16ms - +32.56ms
branch 470 kB 275.97ms - 293.39ms unsure 🔍
-11% - -0%
-32.56ms - +0.16ms
-

sidenav permalink

Version Bytes Avg Time vs remote vs branch
npm latest 417 kB 1062.35ms - 1098.49ms - unsure 🔍
-2% - +2%
-26.92ms - +26.84ms
branch 412 kB 1060.57ms - 1100.35ms unsure 🔍
-2% - +2%
-26.84ms - +26.92ms
-

slider permalink

Version Bytes Avg Time vs remote vs branch
npm latest 460 kB 414.48ms - 447.08ms - unsure 🔍
-5% - +4%
-21.25ms - +18.33ms
branch 456 kB 421.02ms - 443.46ms unsure 🔍
-4% - +5%
-18.33ms - +21.25ms
-

split-button permalink

Version Bytes Avg Time vs remote vs branch
npm latest 697 kB 2217.59ms - 2239.09ms - slower ❌
33% - 35%
547.12ms - 575.88ms
branch 689 kB 1657.29ms - 1676.39ms faster ✔
25% - 26%
547.12ms - 575.88ms
-

split-view permalink

Version Bytes Avg Time vs remote vs branch
npm latest 384 kB 175.68ms - 199.68ms - unsure 🔍
-6% - +11%
-11.08ms - +20.32ms
branch 379 kB 172.93ms - 193.19ms unsure 🔍
-11% - +6%
-20.32ms - +11.08ms
-

swatch permalink

Version Bytes Avg Time vs remote vs branch
npm latest 396 kB 149.79ms - 174.53ms - unsure 🔍
-7% - +13%
-10.92ms - +21.00ms
branch 391 kB 147.03ms - 167.21ms unsure 🔍
-13% - +7%
-21.00ms - +10.92ms
-

switch permalink

Version Bytes Avg Time vs remote vs branch
npm latest 377 kB 148.15ms - 167.45ms - unsure 🔍
-10% - +7%
-16.14ms - +10.62ms
branch 372 kB 151.30ms - 169.82ms unsure 🔍
-7% - +10%
-10.62ms - +16.14ms
-

table permalink

Version Bytes Avg Time vs remote vs branch
npm latest 506 kB 1471.10ms - 1511.66ms - unsure 🔍
-2% - +2%
-25.19ms - +25.75ms
branch 501 kB 1475.69ms - 1506.51ms unsure 🔍
-2% - +2%
-25.75ms - +25.19ms
-

tabs permalink

Version Bytes Avg Time vs remote vs branch
npm latest 414 kB 388.33ms - 416.87ms - unsure 🔍
-7% - +3%
-28.24ms - +12.32ms
branch 409 kB 396.15ms - 424.97ms unsure 🔍
-3% - +7%
-12.32ms - +28.24ms
-

tags permalink

Version Bytes Avg Time vs remote vs branch
npm latest 459 kB 96.12ms - 117.04ms - unsure 🔍
-3% - +23%
-2.99ms - +22.19ms
branch 454 kB 89.98ms - 103.98ms unsure 🔍
-20% - +2%
-22.19ms - +2.99ms
-

textfield permalink

Version Bytes Avg Time vs remote vs branch
npm latest 422 kB 169.91ms - 201.69ms - unsure 🔍
-9% - +13%
-15.50ms - +24.30ms
branch 418 kB 169.42ms - 193.38ms unsure 🔍
-13% - +8%
-24.30ms - +15.50ms
-

thumbnail permalink

Version Bytes Avg Time vs remote vs branch
npm latest 754 kB 179.35ms - 199.13ms - unsure 🔍
-8% - +8%
-15.55ms - +15.95ms
branch 750 kB 176.78ms - 201.30ms unsure 🔍
-8% - +8%
-15.95ms - +15.55ms
-

toast permalink

Version Bytes Avg Time vs remote vs branch
npm latest 427 kB 252.80ms - 275.64ms - unsure 🔍
-9% - +4%
-25.99ms - +10.23ms
branch 422 kB 258.04ms - 286.16ms unsure 🔍
-4% - +10%
-10.23ms - +25.99ms
-

tooltip permalink

Version Bytes Avg Time vs remote vs branch
npm latest 554 kB 247.86ms - 270.66ms - unsure 🔍
-7% - +5%
-17.56ms - +13.00ms
branch 549 kB 251.36ms - 271.72ms unsure 🔍
-5% - +7%
-13.00ms - +17.56ms
-

top-nav permalink

Version Bytes Avg Time vs remote vs branch
npm latest 419 kB 291.17ms - 313.43ms - unsure 🔍
-8% - +3%
-25.93ms - +9.93ms
branch 414 kB 296.25ms - 324.35ms unsure 🔍
-3% - +9%
-9.93ms - +25.93ms
-

tray permalink

Version Bytes Avg Time vs remote vs branch
npm latest 452 kB 282.07ms - 307.29ms - unsure 🔍
-4% - +8%
-11.40ms - +22.04ms
branch 447 kB 278.38ms - 300.34ms unsure 🔍
-7% - +4%
-22.04ms - +11.40ms
-

underlay permalink

Version Bytes Avg Time vs remote vs branch
npm latest 350 kB 91.20ms - 105.08ms - unsure 🔍
-16% - +2%
-17.65ms - +2.77ms
branch 346 kB 98.10ms - 113.06ms unsure 🔍
-3% - +18%
-2.77ms - +17.65ms
-


### trigger

The `trigger` option accepts an `HTMLElement` or a `VirtualTrigger` from which to position the Overlay.
Copy link
Contributor

Choose a reason for hiding this comment

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

Several of these options reference a trigger. Should we specify here the side-effects of not providing a trigger, with an example of why you'd use or not use one?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Initially optional to support straight to <dialog> opening of Overlay.open((overlayElement: HTMLElement));.

Clarify what not having a trigger in other cases means...

@hunterloftis
Copy link
Contributor

hunterloftis commented Jul 19, 2023

Some early clarification questions as I start to review -

We're trying to warn away from them as there will always be a little bit of unexpected behavior there.

What kind of unexpected behavior?

a little but of the code path is "left up to fate"

What does this mean exactly?

Edit: after our sync I think I know the gist of this.

packages/overlay/README.md Outdated Show resolved Hide resolved
packages/overlay/README.md Outdated Show resolved Hide resolved
packages/overlay/README.md Outdated Show resolved Hide resolved
packages/overlay/README.md Outdated Show resolved Hide resolved
packages/overlay/README.md Outdated Show resolved Hide resolved
packages/overlay/imperative-api.md Outdated Show resolved Hide resolved
packages/overlay/imperative-api.md Outdated Show resolved Hide resolved
packages/overlay/README.md Show resolved Hide resolved
packages/overlay/src/OverlayBase.ts Outdated Show resolved Hide resolved
packages/overlay/src/OverlayDialog.ts Show resolved Hide resolved
});
const content = this.contentSlot
.assignedNodes()
.map((node) => node.cloneNode(true));
Copy link
Collaborator

Choose a reason for hiding this comment

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

Isn't it possible for contentSlot or iconSlot to be undefined / null?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In the frame before the first call to render(), sure there is a moment in which these are not yet defined. There's likely harder to define issues that arise in that moment than this, but we'd love to hear if you happen to have a use case where that arises! Then we can make sure it's covered in our unit test suite and resilient to any subsequent changes that may come to this part of the library.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks! I created #3626.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
6 participants