brand icon indicating copy to clipboard operation
brand copied to clipboard

Update Animation stories

Open pouretrebelle opened this issue 1 year ago • 4 comments

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:

  • [x] All new and existing CI checks pass
  • [x] Tests prove that the feature works and covers both happy and unhappy paths
  • [x] Any drop in coverage, breaking changes or regressions have been documented above
  • [x] New visual snapshots have been generated / updated for any UI changes
  • [x] All developer debugging and non-functional logging has been removed
  • [x] 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

pouretrebelle avatar Jul 29 '24 14:07 pouretrebelle

⚠️ No Changeset found

Latest commit: 962e6681b9db046aab9bbf5bf1ce7d10b9a4ed46

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

changeset-bot[bot] avatar Jul 29 '24 14:07 changeset-bot[bot]

🟢 No design token changes found

github-actions[bot] avatar Jul 29 '24 14:07 github-actions[bot]

⚠️ 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:

artifacts section of workflow run

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

Review visual differences

github-actions[bot] avatar Jul 29 '24 14:07 github-actions[bot]

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?

rezrah avatar Jul 31 '24 08:07 rezrah