chromaui / addon-visual-tests

Visual Tests addon for Storybook
MIT License
28 stars 1 forks source link

Ensure VTA panel opens when clicking "run tests" button in warning state #253

Closed ghengeveld closed 1 month ago

ghengeveld commented 3 months ago

As discussed below, rather than hiding the "run tests" button when there's an issue, make sure that it opens the Visual Tests panel. Currently this doesn't work when on a docs page, as there is no addons panel in this situation.

shilman commented 3 months ago

I'd argue this is a conversion feature. Possibly annoying to users but good for discoverability.

ghengeveld commented 2 months ago

This is the current state of the button while onboarding:

Screenshot 2024-05-07 at 11 30 13

After logging in:

Screenshot 2024-05-07 at 11 29 16

I agree with @shilman that this is okay for discoverability. The VTA addon is focussed when clicking the button (unless you're on a docs page).

However, I did also encounter this issue, which happens when restarting Storybook after the initial setup in a monorepo:

Screenshot 2024-05-07 at 11 32 58

The configuration file that's generated currently does not automatically include any of the suggested configuration fixes. I think we should fix that, so the autogenerated config file includes those suggestions.

MichaelArestad commented 2 months ago

I am on the fence with this one. I see it as potentially an avenue for discoverability, but we may want to change from a tooltipNote to something this actionable. For example, we could possibly show a full tooltipMessage with a button that either takes the user through the login flow or takes the user to the addon panel project selection.

shilman commented 2 months ago

@ghengeveld can you elaborate on the config problem and the fix?

I like this button for discoverability, and I agree with @MichaelArestad that we could make it a better experience for helping users get to the next step.

I only worry about prematurely optimizing this flow, so I'd like to:

  1. Track the click when it's in this state
  2. Do the simplest thing that makes it less frustrating, like possibly what you're suggesting @ghengeveld

Then we can look at the numbers and add the full improvement later if it's worth it. WDYT?

ghengeveld commented 1 month ago

The config issue has been addressed in #306, so this is no longer a problem out of the box.

I'm going to keep the button state as-is, for sake of discoverability. I would hate for the VTA to go unnoticed because it's not configured / the user isn't signed in. The dot isn't obtrusive so even if people leave it like that it doesn't get in the way.

The button already opens the VTA panel, which then contains more details about the problem (or simply prompts for what it needs). I don't think a more elaborate tooltip is worthwhile.

Here's what I'll do (as part of this ticket):