Update Animation stories #674

pouretrebelle · 2024-07-29T14:33:04Z

Summary

Part of https://github.com/github/primer/issues/3635

List of notable changes:

Changed title from 'Animations' to 'AnimationProvider' as this is the component's name
Moved examples to examples folder
Added feature stories for interaction observer and advanced animation options
Updated playground to show staggering and only actionable controls
Added minimal default story

What should reviewers focus on?

Review per commit to skip renaming confusion
Not sure I've done the right thing with the visual snapshots? A couple unrelated shots have changed but have no noticeable differences, and I'm not sure all the shots for the animation stories are useful

Steps to test:

https://primer-91b141f773-26139705.drafts.github.io/storybook/?path=/story/components-animationprovider--default

Contributor checklist:

All new and existing CI checks pass
Tests prove that the feature works and covers both happy and unhappy paths
Any drop in coverage, breaking changes or regressions have been documented above
New visual snapshots have been generated / updated for any UI changes
All developer debugging and non-functional logging has been removed
Related issues have been referenced in the PR description

Reviewer checklist:

Check that pull request and proposed changes adhere to our contribution guidelines and code of conduct
Check that tests prove the feature works and covers both happy and unhappy paths
Check that there aren't other open Pull Requests for the same update/change

This is the component which is required for all animations, so is an appropriate name for the group of stories relating to animation.

Also removes the component from the story meta - this shows the props of AnimationProvider in the controls panel which cannot be edited in example or feature stories and may cause confusion.

changeset-bot · 2024-07-29T14:33:08Z

⚠️ No Changeset found

Latest commit: 962e668

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

github-actions · 2024-07-29T14:34:40Z

🟢 No design token changes found

github-actions · 2024-07-29T14:41:50Z

⚠️ Visual differences found

Our visual comparison tests found UI differences.

Please review the differences by using the test artifacts to ensure that the changes were intentional.

Artifacts can be downloaded and reviewed locally.

Download links are available at the bottom of the workflow summary screen.

Example:

If the changes are expected, please run npm run test:visual:update-snapshots to replace the previous fixtures.

Review visual differences

rezrah · 2024-07-31T08:23:38Z

...visual.spec.ts-snapshots/Visual-Comparison-PricingOptions-PricingOptions-Default-1-linux.png

These look like the animation didn't complete before the screenshot was taken. Might be worth increasing the timeout or regenerating these to see if it fixes itself.

rezrah · 2024-07-31T08:28:36Z

packages/react/src/animation/Animation.features.stories.tsx

-      </LogoSuite>
-    </AnimationProvider>
-  )
+IntersectionObserver.argTypes = {


Do argTypes need to be declared per story here? Usually they can be set in the default export at the top of the file to keep the individual stories shorter and reduce duplication. Could we do that here?

rezrah · 2024-07-31T08:30:54Z

packages/react/src/animation/Animation.features.stories.tsx

-      </Stack>
-    </AnimationProvider>
-  )
+export const AdvancedAnimation = args => (


Is advanced referring to the use of multiple parameters like delay, duration etc at the same time? I feel like this example is quite similar to Playground or might be better served in our docs tbh.

rezrah · 2024-07-31T08:33:19Z

packages/react/src/animation/Animation.features.stories.tsx

-        <ProgressBar width="70%" />
-        <ProgressBar width="50%" />
-        <ProgressBar width="25%" />
+export const IntersectionObserver = ({variant, ...args}) => (


Cool example 👍

rezrah · 2024-07-31T08:39:20Z

Changes are looking good @pouretrebelle 👍, thanks.

Some additional feedback that doesn't fit inline...

As you're changing story names, you'll also need to update the VRT exclusion / timeouts list, which is here
Reason for having Animation folder previously was to incorporate all animation-specific components into one folder, like we do for forms. E.g. AnimationProvider and Animate components. Could we create a separation between those two components and follow the forms example instead? Or bring both up to top-level so they exist side-by-side?

pouretrebelle added 6 commits July 29, 2024 12:42

Rename Animation examples story file

d4bfc5b

Rename animation stories to AnimationProvider

6e111cd

This is the component which is required for all animations, so is an appropriate name for the group of stories relating to animation.

Separate features from examples stories

d0bac31

Also removes the component from the story meta - this shows the props of AnimationProvider in the controls panel which cannot be edited in example or feature stories and may cause confusion.

Update animation playground

6a02092

Add animation default story

d75019e

Add animation features stories

36d1a7f

pouretrebelle temporarily deployed to github-pages July 29, 2024 14:39 — with GitHub Actions Inactive

Update visual tests and screenshots

962e668

pouretrebelle marked this pull request as ready for review July 29, 2024 15:21

pouretrebelle requested a review from rezrah July 29, 2024 15:21

pouretrebelle temporarily deployed to github-pages July 29, 2024 15:21 — with GitHub Actions Inactive

rezrah reviewed Jul 31, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Animation stories #674

Update Animation stories #674

pouretrebelle commented Jul 29, 2024 •

edited

Loading

changeset-bot bot commented Jul 29, 2024 •

edited

Loading

github-actions bot commented Jul 29, 2024 •

edited

Loading

github-actions bot commented Jul 29, 2024 •

edited

Loading

Example:

rezrah Jul 31, 2024

rezrah Jul 31, 2024 •

edited

Loading

rezrah Jul 31, 2024

rezrah Jul 31, 2024

rezrah commented Jul 31, 2024

Update Animation stories #674

Are you sure you want to change the base?

Update Animation stories #674

Conversation

pouretrebelle commented Jul 29, 2024 • edited Loading

Summary

List of notable changes:

What should reviewers focus on?

Steps to test:

Contributor checklist:

Reviewer checklist:

changeset-bot bot commented Jul 29, 2024 • edited Loading

⚠️ No Changeset found

github-actions bot commented Jul 29, 2024 • edited Loading

🟢 No design token changes found

github-actions bot commented Jul 29, 2024 • edited Loading

⚠️ Visual differences found

Example:

rezrah Jul 31, 2024

Choose a reason for hiding this comment

rezrah Jul 31, 2024 • edited Loading

Choose a reason for hiding this comment

rezrah Jul 31, 2024

Choose a reason for hiding this comment

rezrah Jul 31, 2024

Choose a reason for hiding this comment

rezrah commented Jul 31, 2024

pouretrebelle commented Jul 29, 2024 •

edited

Loading

changeset-bot bot commented Jul 29, 2024 •

edited

Loading

github-actions bot commented Jul 29, 2024 •

edited

Loading

github-actions bot commented Jul 29, 2024 •

edited

Loading

rezrah Jul 31, 2024 •

edited

Loading