[EuiSelectable] Fix searchable single selection selectables not correctly highlighting the checked option on initial render #6072
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR also contains 2 other small fixes / cleanups (see commit history).
Before
After
Problem
EuiSelectable.onSearchChange
was being called on mount byEuiSelectableSearch
, which was settingactiveOptionIndex
to undefined:eui/src/components/selectable/selectable.tsx
Lines 423 to 432 in eb493ff
Solution
Moving the
searchProps.onChange
callback to theEuiSelectable
's constructor (which callsgetMatchingOptions
/sets search state on mount anyway, so no need forEuiSelectableSearch
to repeat it) fixes the issue and leaves the foundactiveOptionIndex
from the constructor intact.Checklist
- [ ] Checked in both light and dark modes- [ ] Checked in mobile- [ ] Checked in Chrome, Safari, Edge, and Firefox- [ ] Props have proper autodocs and playground toggles- [ ] Added documentation- [ ] Checked Code Sandbox works for any docs examples- [ ] Checked for breaking changes and labeled appropriately- [ ] Updated the Figma library counterpart- [ ] Checked for accessibility including keyboard-only and screenreader modesTested but no meaningful impact for these users - they have to tab into the Selectable which triggers the highlight in any case