[EuiInMemoryTable] Support controlled plain text search #9142

acstll · 2025-10-24T09:58:37Z

Summary

Closes #9019 (see #9019 (comment))

This addresses 2 issues with EuiInMemoryTable when used with plain text, namely searchFormat="text", it:

enables "controlled" support via the search.query prop
ensure search.defaultQuery is being passed to the search box

It's a follow-up for a previous fix in #9059

Why are we making this change?

To fix a bug, and to unblock fixing another bug in Kibana.

Impact to users

🟢 Since this is a bug fix impact should just be positive, but tests may fail expecting the old broken behavior. However, no instances of searchFormat="text" can be found in Kibana with a simple search. And these changes should not affect the default searchFormat="eql".

QA

Suggestion

The bug happens when the component attempts to parse the search value as EQL syntax despite searchFormat being text, although it shouldn't, as expressed in the description of the searchFormat prop.

To reproduce it, you can:

copy/paste the test story (23d9e8b) in main
run Storybook, open the story: http://localhost:6006/?path=/story/tabular-content-euiinmemorytable--controlled-text
typing or in the search box should throw an error and break
verify the value for searchText is text and the controlled logic is correct
to test search.defaultQuery works as expected, in the Storybook UI you can set the search prop to { query: null, defaultQuery: 'hello world' }

This test story should work as expected in this branch.

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)

- don't throw when an invalid query like "or" is passed in search.query - ensure controlled behavior by ensuring search.query is passed down to the search bar

…in text

rmyz

Tested against local kibana with elastic/kibana#233836 and it works fine, thanks!

mgadewoll

✅ The updated search.query and search.defaultQuery props work as expected:

query no longer results in an error for searchFormat="text"
defaultQuery is properly applied

I have one doubt about a possible edge case, otherwise the changes LGTM.

packages/eui/src/components/basic_table/in_memory_table.tsx

This reverts commit 23d9e8b.

packages/eui/src/components/basic_table/in_memory_table.tsx

namely handling also defaultQuery, and also improve JSDoc

elasticmachine · 2025-11-26T14:19:55Z

💚 Build Succeeded

History

💚 Build #2072 succeeded 6e40d54
💚 Build #2052 succeeded 23d9e8b
💚 Build #1995 succeeded 9967c96
💚 Build #1680 succeeded ebe0bf2

cc @acstll

elasticmachine · 2025-11-26T14:37:10Z

💚 Build Succeeded

Buildkite Build
Commit: 74d05ec

History

💚 Build #5319 succeeded 6e40d54
💚 Build #5307 succeeded 23d9e8b
💚 Build #5259 succeeded 9967c96
💚 Build #5024 succeeded ebe0bf2

cc @acstll

mgadewoll

🟢 Thanks for the additional changes! The code LGTM and the updated search.query and search.defaultQuery work as expected 👍

this is reverting a change introduced in elastic#9142 for EuiSearchBarOnChangeArgs, where the query prop could be null also when there was no error, requiring additional checks in consumer code

## Dependency updates - `@elastic/eui`: `v109.2.0` ⏩ `v110.0.0` --- ## Changes - Updates usages of the `message` prop on `EuiInMemoryTable` to `noItemsMessage` - Updates usages of `EuiSearchBar`'s `onChange` prop to check for the `query` argument, as it may be `null` now - Removes obsolete `color` props on implementations of `EuiPageTemplate` and `EuiPageTemplate.Header` (`color` prop wasn't applied before either) ## Package updates ### `@elastic/eui` v110.0.0 - Updated `EuiSuperDatePicker` to expose plain text `utcOffset` and `timeZoneName` in `timeZoneDisplayProps.customRender` render function ([#9245](elastic/eui#9245)) - Updated `EuiHeaderLogo` to add a hover style ([#9240](elastic/eui#9240)) - Made `EuiQuickSelectPanel` available for importing from the `@elastic/eui` package ([#9239](elastic/eui#9239)) - Updated `EuiAvatar` to support Emoji Sequence ("advanced") in the `initials` prop ([#9227](elastic/eui#9227)) - Added `color` prop on `EuiPageHeader` to support `transparent` (default) and `plain` backgrounds. ([#9220](elastic/eui#9220)) - Added `color` prop on `EuiPage` to support `transparent` (default) and `plain` backgrounds. ([#9220](elastic/eui#9220)) - Updated `EuiPageTemplate` to ensure `panelled=true` renders a `EuiPageHeader` with a plain background by default ([#9220](elastic/eui#9220)) - Removed the default background style on `EuiPageTemplate`'s outer wrapper ([#9220](elastic/eui#9220)) **Bug fixes** - Fixed icon size in `EuiSuperDatePicker`'s time window buttons when `compressed={true}` ([#9245](elastic/eui#9245)) - Fixed `EuiIcon` visibility issue with `logoElastic` when `color` is set to `text` or `ghost` in light mode ([#9247](elastic/eui#9247)) - Fixed `EuiInMemoryTable` support for controlled search for plain text (when `searchFormat="text"`) by properly handling `search.query` and `search.defaulQuery` ([#9142](elastic/eui#9142)) **Breaking changes** - Removed deprecated `message` prop from `EuiInMemoryTable`, use `noItemsMessage` instead ([#9234](elastic/eui#9234)) **Accessibility** - Improved the accessibility of input fields in the popover of `EuiSuperDatePicker` by properly labeling them ([#9239](elastic/eui#9239)) - Improved the accessibility of `EuiSelectable` by removing empty `aria-activedescendant` attribute when no option is active to ensure the search input is perceivable by screen readers ([#9223](elastic/eui#9223)) --------- Co-authored-by: Weronika Olejniczak <[email protected]> Co-authored-by: Jorge Oliveira <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

## Dependency updates - `@elastic/eui`: `v109.2.0` ⏩ `v110.0.0` --- ## Changes - Updates usages of the `message` prop on `EuiInMemoryTable` to `noItemsMessage` - Updates usages of `EuiSearchBar`'s `onChange` prop to check for the `query` argument, as it may be `null` now - Removes obsolete `color` props on implementations of `EuiPageTemplate` and `EuiPageTemplate.Header` (`color` prop wasn't applied before either) ## Package updates ### `@elastic/eui` v110.0.0 - Updated `EuiSuperDatePicker` to expose plain text `utcOffset` and `timeZoneName` in `timeZoneDisplayProps.customRender` render function ([elastic#9245](elastic/eui#9245)) - Updated `EuiHeaderLogo` to add a hover style ([elastic#9240](elastic/eui#9240)) - Made `EuiQuickSelectPanel` available for importing from the `@elastic/eui` package ([elastic#9239](elastic/eui#9239)) - Updated `EuiAvatar` to support Emoji Sequence ("advanced") in the `initials` prop ([elastic#9227](elastic/eui#9227)) - Added `color` prop on `EuiPageHeader` to support `transparent` (default) and `plain` backgrounds. ([elastic#9220](elastic/eui#9220)) - Added `color` prop on `EuiPage` to support `transparent` (default) and `plain` backgrounds. ([elastic#9220](elastic/eui#9220)) - Updated `EuiPageTemplate` to ensure `panelled=true` renders a `EuiPageHeader` with a plain background by default ([elastic#9220](elastic/eui#9220)) - Removed the default background style on `EuiPageTemplate`'s outer wrapper ([elastic#9220](elastic/eui#9220)) **Bug fixes** - Fixed icon size in `EuiSuperDatePicker`'s time window buttons when `compressed={true}` ([elastic#9245](elastic/eui#9245)) - Fixed `EuiIcon` visibility issue with `logoElastic` when `color` is set to `text` or `ghost` in light mode ([elastic#9247](elastic/eui#9247)) - Fixed `EuiInMemoryTable` support for controlled search for plain text (when `searchFormat="text"`) by properly handling `search.query` and `search.defaulQuery` ([elastic#9142](elastic/eui#9142)) **Breaking changes** - Removed deprecated `message` prop from `EuiInMemoryTable`, use `noItemsMessage` instead ([elastic#9234](elastic/eui#9234)) **Accessibility** - Improved the accessibility of input fields in the popover of `EuiSuperDatePicker` by properly labeling them ([elastic#9239](elastic/eui#9239)) - Improved the accessibility of `EuiSelectable` by removing empty `aria-activedescendant` attribute when no option is active to ensure the search input is perceivable by screen readers ([elastic#9223](elastic/eui#9223)) --------- Co-authored-by: Weronika Olejniczak <[email protected]> Co-authored-by: Jorge Oliveira <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

acstll self-assigned this Oct 24, 2025

acstll added skip-changelog Use on PRs to skip changelog requirement (Don't delete - used for automation) and removed skip-changelog Use on PRs to skip changelog requirement (Don't delete - used for automation) labels Oct 24, 2025

acstll added 5 commits November 19, 2025 13:09

[EuiInMemoryTable] Improve searchFormat=text

f16010e

- don't throw when an invalid query like "or" is passed in search.query - ensure controlled behavior by ensuring search.query is passed down to the search bar

[EuiInMemoryTable] Fix search.defaultQuery not being rendered for pla…

6039e8d

…in text

Lint

bb5594f

Changelog

345be70

[EuiInMemoryTable] Improve unit test a bit

9967c96

acstll force-pushed the in-memory-table-plain-text-onchange-9019-2 branch from ebe0bf2 to 9967c96 Compare November 19, 2025 12:13

acstll marked this pull request as ready for review November 19, 2025 17:37

acstll requested a review from a team as a code owner November 19, 2025 17:37

rmyz approved these changes Nov 19, 2025

View reviewed changes

mgadewoll self-requested a review November 24, 2025 09:43

[REVERT] Add story for smoke testing

23d9e8b

mgadewoll reviewed Nov 24, 2025

View reviewed changes

packages/eui/src/components/basic_table/in_memory_table.tsx Outdated Show resolved Hide resolved

acstll added 2 commits November 25, 2025 14:14

[EuiInMemoryTable] Avoid passing an object as input value

8b1df72

Revert "[REVERT] Add story for smoke testing"

6e40d54

This reverts commit 23d9e8b.

acstll requested a review from mgadewoll November 25, 2025 13:59

mgadewoll reviewed Nov 26, 2025

View reviewed changes

packages/eui/src/components/basic_table/in_memory_table.tsx Outdated Show resolved Hide resolved

packages/eui/src/components/basic_table/in_memory_table.tsx Outdated Show resolved Hide resolved

acstll added 2 commits November 26, 2025 15:00

[EuiInMemoryTable] Avoid passing an object as input value, for real

8fac3e3

namely handling also defaultQuery, and also improve JSDoc

Lint (shrug)

74d05ec

acstll requested a review from mgadewoll November 26, 2025 15:45

mgadewoll approved these changes Nov 26, 2025

View reviewed changes

acstll merged commit 5a429b4 into elastic:main Nov 26, 2025
7 checks passed

mgadewoll mentioned this pull request Dec 2, 2025

Update EUI to 110.0.0 elastic/kibana#244866

Merged

acstll mentioned this pull request Dec 2, 2025

[EuiSearchBar] Make onChange args type simple, as before #9253

Closed

14 tasks

acstll added a commit that referenced this pull request Dec 12, 2025

[EuiInMemoryTable] Support controlled plain text search (#9142)

854502c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[EuiInMemoryTable] Support controlled plain text search #9142

[EuiInMemoryTable] Support controlled plain text search #9142

Uh oh!

acstll commented Oct 24, 2025 •

edited

Loading

Uh oh!

rmyz left a comment

Uh oh!

mgadewoll left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elasticmachine commented Nov 26, 2025

Uh oh!

elasticmachine commented Nov 26, 2025

Uh oh!

mgadewoll left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

[EuiInMemoryTable] Support controlled plain text search #9142

[EuiInMemoryTable] Support controlled plain text search #9142

Uh oh!

Conversation

acstll commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Why are we making this change?

Impact to users

QA

Suggestion

General checklist

Uh oh!

rmyz left a comment

Choose a reason for hiding this comment

Uh oh!

mgadewoll left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elasticmachine commented Nov 26, 2025

💚 Build Succeeded

History

Uh oh!

elasticmachine commented Nov 26, 2025

💚 Build Succeeded

History

Uh oh!

mgadewoll left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

acstll commented Oct 24, 2025 •

edited

Loading

mgadewoll left a comment •

edited

Loading