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

Pog, Toast, Tooltip, Upsell, Video: add visual diff testing and screenshot to description in VSCode (Flow extension) #2057

Merged
merged 1 commit into from Apr 8, 2022

Conversation

AlbertCarreras
Copy link
Contributor

@AlbertCarreras AlbertCarreras commented Apr 7, 2022

Summary

What changed?

Pog, Toast, Tooltip, Upsell, Video: add visual diff testing and screenshot to description in VSCode (Flow extension)

Why?

Provide basic visual testing coverage for most Gestalt components and link screenshots to VSCode's Flow extension that shows component screenshot below the component description on hover for better in-editor documentation.

OKR:

  • Tooling & Infra
  • Visual Diff testing
  • Every component in our library uses visual diff testing to guard against UI regression

@AlbertCarreras AlbertCarreras added the patch release Patch release label Apr 7, 2022
@AlbertCarreras AlbertCarreras force-pushed the visDiffs5 branch 6 times, most recently from 4765c22 to 6c51203 Compare April 7, 2022 23:08
@AlbertCarreras AlbertCarreras changed the title Toast: add visual diff testing and screenshot to description in VSCode (Flow extension) Pog, Toast, Tooltip, Upsell, Video: add visual diff testing and screenshot to description in VSCode (Flow extension) Apr 7, 2022
@AlbertCarreras AlbertCarreras marked this pull request as ready for review April 7, 2022 23:09
@AlbertCarreras AlbertCarreras requested a review from a team as a code owner April 7, 2022 23:09
@AlbertCarreras AlbertCarreras force-pushed the visDiffs5 branch 2 times, most recently from 3cd4727 to cd5a0bf Compare April 8, 2022 00:01
@netlify
Copy link

netlify bot commented Apr 8, 2022

Deploy Preview for gestalt ready!

Name Link
🔨 Latest commit e1f1493
🔍 Latest deploy log https://app.netlify.com/sites/gestalt/deploys/624f843edfd2b80008cb0a07
😎 Deploy Preview https://deploy-preview-2057--gestalt.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@@ -0,0 +1,15 @@
describe('Pog visual dark mode regression check', () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Should these files be Flow typed? Have we been add Flow annotations to the other visual test files?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Have we been add Flow annotations to the other visual test files?
NO

@@ -89,7 +89,11 @@ type Props = {|
/**
* [Pog](https://gestalt.pinterest.systems/pog) is a lower-level functional component to show the active, hovered, & focused states of [IconButton](https://gestalt.pinterest.systems/pog/iconbutton).
*
*This abstraction to allow for links that look like IconButton.
* This abstraction to allow for links that look like IconButton.
Copy link
Contributor

Choose a reason for hiding this comment

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

(pre-existing) typo: "This is an abstraction to allow for…"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

DONE

@@ -40,6 +40,10 @@ type Props = {|
* [Toasts](https://gestalt.pinterest.systems/toast) can educate people on the content of the screen, provide confirmation when people complete an action, or simply communicate a short message.
*
* Toast is purely visual. In order to properly handle the showing and dismissing of Toasts, as well as any animations, you will need to implement a Toast manager.
*
* ⚠️ Please note: Toast is not currently supported in dark mode.
Copy link
Contributor

Choose a reason for hiding this comment

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

🙏

@@ -131,7 +131,9 @@ type Props = {|
/**
* [Upsells](https://gestalt.pinterest.systems/upsell) are banners that display short messages that focus on promoting an action or upgrading something the user already has.
*
* ⚠️ Please note: Upsell is not currently supported in dark mode.
* ⚠️ Please note: Upsells is not currently supported in dark mode.
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: Upsell should be singular

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