Summary

Improved EuiSelectable documentation around test environment, specifically how to apply a global mock that disables virtualization.

Why are we making this change?

Resolves #8740

There was an issue reported in EUI Slack some time ago about EuiSelectable not showing any options in jsdom unless isVirtualized={false} is passed. Recently, this issue has been bumped.

I thought about this for a while and I'm open to different opinions / suggestions. Personally, I think that while it's technically possible to "force" from our code EuiSelectable to not use virtualization in test environment, a better approach would be to let consumers mock it as needed.

If they are testing EuiSelectable directly (which is rarely I suppose) they can pass the prop directly. If they are testing a composition with EuiSelectable rendered, they can mock it with jest.mock (and clear the mocks if necessary) afterwards.

The issue has some more details in the comments ☝🏻

Impact to users

🟢 Dev-only change. Doesn't impact end users.

QA

Specific checklist

• Verify the global mock works (unfortunately, Codesandbox doesn't support it... still)
• Verify the documentation section is correct (staging)

General checklist

• Browser QA
  • Checked in both light and dark modes
  • Checked in both MacOS and Windows high contrast modes
    • (emulate forced colors if you do not have access to a Windows machine.)
  • Checked in mobile
  • Checked in Chrome, Safari, Edge, and Firefox
  • Checked for accessibility including keyboard-only and screenreader modes
• Docs site QA
  • Added documentation
  • Props have proper autodocs (using @default if default values are missing) and playground toggles
  • Checked Code Sandbox works for any docs examples
• Code quality checklist
  • Added or updated jest and cypress tests
  • Updated visual regression tests
• Release checklist
  • A changelog entry exists and is marked appropriately
  • If applicable, added the breaking change issue label (and filled out the breaking change checklist)
  • If the changes unblock an issue in a different repo, smoke tested carefully (see Testing EUI features in Kibana ahead of time)
• Designer checklist
  • If applicable, file an issue to update EUI's Figma library with any corresponding UI changes. (This is an internal repo, if you are external to Elastic, ask a maintainer to submit this request)