Add paramKey: "chromatic" to allow disabling the VTA panel through story parameters

[mellm0]

Configures the addon's paramKey, so that disabling this parameter will disable the Visual Tests panel in Storybook for a specific story:

const MyStory = {
  parameters: {
    chromatic: {
      disable: true
    }
  }
}

Similarly, this can be set on meta instead to disable the VTA for all stories in the file.

The key is set to chromatic because this will cause Chromatic to skip the story when snapshotting. If you want to disable snapshotting without disabling the addon panel, you can use the disableSnapshot: true parameter instead.

[ghengeveld]

@mellm0 Thanks for the contribution! What is your intention here? The paramKey would allow you to disable/hide the addon panel (tab), but it wouldn't completely disable visual testing for a particular story. In fact if you'd disable the panel, the story would still be tested/snapshotted regardless. That's probably not what you expect?

If you'd expect snapshotting to be disabled for the story and have the panel disabled, then we could set paramKey to "chromatic". Normally you'd disable snapshotting for a story using the chromatic.disableSnapshot parameter, but we actually also support chromatic.disable for historical reasons.

@tmeasday WDYT?

[mellm0]

My intention is simply to have the ability to hide the panel on certain stories, though its true this does coincide with also disabling chromatic snapshots for it.

My specific scenario required me to create a story rather than a docs page since I wanted the themes, accessibility and other addons be available for a Sandbox we are creating for our design system.

I only chose the ADDON_ID as some other addons do the same, and I wanted it to be consistent. But I can change the name to chromatic, and that way it can hide at the same time.

Might be a breaking change for users who expect to still see the panel, but are using disable instead of disableSnapshot to disable Chromatic snapshots. I wanted to avoid that too.

[ghengeveld]

@mellm0 Sounds good. I think this is a legitimate use case so if you change PARAM_KEY to "chromatic", I'm happy to merge this.

We're looking at updating some backend code to make disable behave identically to disableSnapshot as there's currently a slight difference, but as an end user it's not noticeable so it doesn't matter.

[mellm0]

Updated 👍🏼

[ghengeveld]

Thanks a lot @mellm0! I've updated the PR title and description to more clearly explain the update and how to use the parameter.

[ghengeveld]

Shipped in v1.8.0 🚀