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

Fix control UI loading state #29080

Open
wants to merge 4 commits into
base: next
Choose a base branch
from

Conversation

g-cappai
Copy link
Contributor

@g-cappai g-cappai commented Sep 10, 2024

Closes #28306

What I did

Added a div to wrap the Skeleton, fixing a bug where the AddonWrapper's style incorrectly applied gridTemplateRows to the Skeleton's rows.

Additionally, refactored the Skeleton's structure for better clarity (can revert if it's out of scope).

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. Set ArgsTable's prop isLoading to true inside ControlPanel
  2. Run yarn start
  3. Check related issue

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

name before after diff z %
createSize 0 B 0 B 0 B - -
generateSize 77.4 MB 77.4 MB 0 B 1.74 0%
initSize 162 MB 162 MB -5.9 kB -0.23 0%
diffSize 85 MB 85 MB -5.9 kB -0.42 0%
buildSize 7.57 MB 7.57 MB -2.21 kB -1.24 0%
buildSbAddonsSize 1.66 MB 1.66 MB -1.11 kB -1.23 -0.1%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 2.34 MB 2.34 MB 0 B - 0%
buildSbPreviewSize 352 kB 352 kB 0 B - 0%
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 4.55 MB 4.55 MB -1.11 kB -1.23 0%
buildPreviewSize 3.02 MB 3.02 MB -1.1 kB -1.25 0%
testBuildSize 0 B 0 B 0 B - -
testBuildSbAddonsSize 0 B 0 B 0 B - -
testBuildSbCommonSize 0 B 0 B 0 B - -
testBuildSbManagerSize 0 B 0 B 0 B - -
testBuildSbPreviewSize 0 B 0 B 0 B - -
testBuildStaticSize 0 B 0 B 0 B - -
testBuildPrebuildSize 0 B 0 B 0 B - -
testBuildPreviewSize 0 B 0 B 0 B - -
name before after diff z %
createTime 6.8s 6.8s 4ms -0.98 0.1%
generateTime 21.6s 22.7s 1.1s 2.26 4.9%
initTime 16.1s 18.4s 2.3s 1.73 🔺12.5%
buildTime 11.1s 10.4s -694ms -0.89 -6.6%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 6.9s 7.4s 569ms 0.7 7.6%
devManagerResponsive 4.6s 4.7s 126ms 0.51 2.6%
devManagerHeaderVisible 849ms 840ms -9ms 0.12 -1.1%
devManagerIndexVisible 895ms 873ms -22ms 0.05 -2.5%
devStoryVisibleUncached 1.4s 1.5s 34ms 0.44 2.3%
devStoryVisible 893ms 871ms -22ms 0.03 -2.5%
devAutodocsVisible 840ms 706ms -134ms -0.63 -19%
devMDXVisible 796ms 693ms -103ms -0.6 -14.9%
buildManagerHeaderVisible 835ms 741ms -94ms -0.92 -12.7%
buildManagerIndexVisible 837ms 808ms -29ms -0.39 -3.6%
buildStoryVisible 920ms 808ms -112ms -0.7 -13.9%
buildAutodocsVisible 816ms 676ms -140ms -0.69 -20.7%
buildMDXVisible 773ms 743ms -30ms 0.33 -4%

Greptile Summary

This PR addresses a visual bug in the Controls UI loading state by refactoring the Skeleton component in the ArgsTable.

  • Wrapped Skeleton content in a div to prevent incorrect style application from AddonWrapper
  • Introduced contentStructure array for improved layout definition of the Skeleton
  • Replaced hardcoded rows and columns with dynamic mapping for better maintainability
  • To test, set ArgsTable's isLoading prop to true in the ControlPanel component

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings

Comment on lines 43 to 47
const contentStructure = [
[[60], [30], [60], [60]],
[[60], [80, 30], [60], [60]],
[[60], [80, 30], [60], [60]],
[[60], [80, 30], [60], [60]],
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Consider using a more descriptive name for this constant, such as skeletonStructure or skeletonLayout

Copy link

nx-cloud bot commented Sep 10, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 1f2f3df. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

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.

[Bug]: Small visual bug in Controls UI loading state
4 participants