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

[initialfallback] Rename WithSSRPlaceholder to InitialFallback #2304

Merged
merged 3 commits into from
Aug 27, 2024

Conversation

somewhatabstract
Copy link
Member

@somewhatabstract somewhatabstract commented Aug 26, 2024

Summary:

This renames WithSSRPlaceholder to more accurately reflect its purpose. This includes changing the placeholder prop to fallback so that we more closely match the React.Suspense API.

To update code using WithSSRPlaceholder:

  1. Find/replace WithSSRPlaceholder placeholder= in files using that component to InitialFallback fallback=
  2. Find/replace WithSSRPlaceholder to InitialFallback

Issue: XXX-XXXX

Test plan:

yarn test
yarn typecheck
yarn start:storybook and view the docs for the InitialFallback component

@somewhatabstract somewhatabstract self-assigned this Aug 26, 2024
@somewhatabstract somewhatabstract requested a review from a team August 26, 2024 21:53
Copy link

changeset-bot bot commented Aug 26, 2024

🦋 Changeset detected

Latest commit: 3cb03f3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 27 packages
Name Type
@khanacademy/wonder-blocks-core Major
@khanacademy/wonder-blocks-layout Minor
@khanacademy/wonder-blocks-accordion Patch
@khanacademy/wonder-blocks-banner Patch
@khanacademy/wonder-blocks-birthday-picker Patch
@khanacademy/wonder-blocks-breadcrumbs Patch
@khanacademy/wonder-blocks-button Patch
@khanacademy/wonder-blocks-cell Patch
@khanacademy/wonder-blocks-clickable Patch
@khanacademy/wonder-blocks-data Patch
@khanacademy/wonder-blocks-dropdown Patch
@khanacademy/wonder-blocks-form Patch
@khanacademy/wonder-blocks-grid Patch
@khanacademy/wonder-blocks-icon-button Patch
@khanacademy/wonder-blocks-icon Patch
@khanacademy/wonder-blocks-labeled-field Patch
@khanacademy/wonder-blocks-link Patch
@khanacademy/wonder-blocks-modal Patch
@khanacademy/wonder-blocks-pill Patch
@khanacademy/wonder-blocks-popover Patch
@khanacademy/wonder-blocks-progress-spinner Patch
@khanacademy/wonder-blocks-search-field Patch
@khanacademy/wonder-blocks-switch Patch
@khanacademy/wonder-blocks-testing Patch
@khanacademy/wonder-blocks-toolbar Patch
@khanacademy/wonder-blocks-tooltip Patch
@khanacademy/wonder-blocks-typography Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@khan-actions-bot
Copy link
Contributor

Gerald

Required Reviewers
  • @Khan/wonder-blocks for changes to .changeset/wicked-carrots-hope.md, __docs__/wonder-blocks-core/initial-fallback.stories.tsx, packages/wonder-blocks-core/src/index.ts, packages/wonder-blocks-core/src/components/initial-fallback.tsx, packages/wonder-blocks-core/src/components/unique-id-provider.tsx, packages/wonder-blocks-layout/src/components/media-layout.tsx, packages/wonder-blocks-core/src/components/__tests__/initial-fallback.test.tsx, packages/wonder-blocks-core/src/components/__tests__/unique-id-provider.test.tsx

Don't want to be involved in this pull request? Comment #removeme and we won't notify you of further changes.

@khan-actions-bot khan-actions-bot requested a review from a team August 26, 2024 21:53
Copy link
Contributor

github-actions bot commented Aug 26, 2024

npm Snapshot: Published

🎉 Good news!! We've packaged up the latest commit from this PR (16cd966) and published all packages with changesets to npm.

You can install the packages in webapp by running:

./services/static/dev/tools/deploy_wonder_blocks.js --tag="PR2304"

Packages can also be installed manually by running:

yarn add @khanacademy/wonder-blocks-<package-name>@PR2304

Copy link
Contributor

github-actions bot commented Aug 26, 2024

Size Change: -16 B (-0.02%)

Total Size: 96.1 kB

Filename Size Change
packages/wonder-blocks-core/dist/es/index.js 3.44 kB -12 B (-0.35%)
packages/wonder-blocks-layout/dist/es/index.js 1.82 kB -4 B (-0.22%)
ℹ️ View Unchanged
Filename Size
packages/wonder-blocks-accordion/dist/es/index.js 3.78 kB
packages/wonder-blocks-banner/dist/es/index.js 1.53 kB
packages/wonder-blocks-birthday-picker/dist/es/index.js 1.61 kB
packages/wonder-blocks-breadcrumbs/dist/es/index.js 887 B
packages/wonder-blocks-button/dist/es/index.js 4.04 kB
packages/wonder-blocks-cell/dist/es/index.js 2.01 kB
packages/wonder-blocks-clickable/dist/es/index.js 3.06 kB
packages/wonder-blocks-data/dist/es/index.js 6.24 kB
packages/wonder-blocks-dropdown/dist/es/index.js 14.1 kB
packages/wonder-blocks-form/dist/es/index.js 6.19 kB
packages/wonder-blocks-grid/dist/es/index.js 1.36 kB
packages/wonder-blocks-i18n/dist/es/index.js 4.76 kB
packages/wonder-blocks-icon-button/dist/es/index.js 2.99 kB
packages/wonder-blocks-icon/dist/es/index.js 828 B
packages/wonder-blocks-labeled-field/dist/es/index.js 72 B
packages/wonder-blocks-link/dist/es/index.js 2.28 kB
packages/wonder-blocks-modal/dist/es/index.js 5.36 kB
packages/wonder-blocks-pill/dist/es/index.js 1.64 kB
packages/wonder-blocks-popover/dist/es/index.js 4.85 kB
packages/wonder-blocks-progress-spinner/dist/es/index.js 1.52 kB
packages/wonder-blocks-search-field/dist/es/index.js 1.3 kB
packages/wonder-blocks-switch/dist/es/index.js 1.94 kB
packages/wonder-blocks-testing-core/dist/es/index.js 3.64 kB
packages/wonder-blocks-testing/dist/es/index.js 1.13 kB
packages/wonder-blocks-theming/dist/es/index.js 693 B
packages/wonder-blocks-timing/dist/es/index.js 1.8 kB
packages/wonder-blocks-tokens/dist/es/index.js 2.1 kB
packages/wonder-blocks-toolbar/dist/es/index.js 855 B
packages/wonder-blocks-tooltip/dist/es/index.js 7 kB
packages/wonder-blocks-typography/dist/es/index.js 1.23 kB

compressed-size-action

Copy link

codecov bot commented Aug 26, 2024

Codecov Report

Attention: Patch coverage is 96.87500% with 1 line in your changes missing coverage. Please review.

Project coverage is 95.14%. Comparing base (982f680) to head (3cb03f3).
Report is 2 commits behind head on main.

Files Patch % Lines
...er-blocks-core/src/components/initial-fallback.tsx 95.83% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2304      +/-   ##
==========================================
+ Coverage   94.41%   95.14%   +0.73%     
==========================================
  Files         254      254              
  Lines       30537    30533       -4     
  Branches     1715     1865     +150     
==========================================
+ Hits        28830    29052     +222     
+ Misses       1702     1462     -240     
- Partials        5       19      +14     
Files Coverage Δ
...-blocks-core/src/components/unique-id-provider.tsx 99.09% <100.00%> (ø)
...nder-blocks-layout/src/components/media-layout.tsx 99.32% <100.00%> (ø)
...er-blocks-core/src/components/initial-fallback.tsx 85.29% <95.83%> (ø)

... and 47 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 982f680...3cb03f3. Read the comment docs.

Copy link
Contributor

A new build was pushed to Chromatic! 🚀

https://5e1bf4b385e3fb0020b7073c-ipllnlneff.chromatic.com/

Chromatic results:

Metric Total
Captured snapshots 364
Tests with visual changes 0
Total stories 482
Inherited (not captured) snapshots [TurboSnap] 0
Tests on the build 364

@somewhatabstract somewhatabstract merged commit 07f7f40 into main Aug 27, 2024
16 checks passed
@somewhatabstract somewhatabstract deleted the initialfallback branch August 27, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants