Fix EUI+ search not indexing heading elements

elastic / eui

Elastic UI Framework 🙌

https://eui.elastic.co/

Other

56 stars 841 forks source link

Fix EUI+ search not indexing heading elements #8098

Closed tkajtoch closed 1 month ago

tkajtoch commented 1 month ago

Summary

This PR fixes EUI+ search by re-adding the necessary markdown class name to DocItemContent and setting the data-search-children attribute to a truthy value to allow proper heading recognition.

QA

[ ] Confirm the search bar shows results when searching by heading names such as Installation (Getting started page) or Basic button (Button page) - this PR's base is set to a commit with no components sidebar visible. This is expected

tkajtoch commented 1 month ago

@mgadewoll I switched it to overflow: hidden auto, and it seems to work perfectly fine with the search bar and SVGs now :)

mgadewoll commented 1 month ago

@mgadewoll I switched it to overflow: hidden auto, and it seems to work perfectly fine with the search bar and SVGs now :)

@tkajtoch This isn't working though it seems. I guess let's just remove it

tkajtoch commented 1 month ago

I don't know what happened but that was working locally in dev and when built locally. I replaced it with a safer solution, removing the overflow property from the wrapper element altogether. Sorry about that!

kibanamachine commented 1 month ago

Preview staging links for this PR:

Docs site: https://eui.elastic.co/pr_8098/
Storybook: https://eui.elastic.co/pr_8098/storybook
New docs: https://eui.elastic.co/pr_8098/new-docs

elasticmachine commented 1 month ago

:green_heart: Build Succeeded

Buildkite Build
Commit: b23bbf3292c22fa5a54f8bc0730c276adc804956

History

:green_heart: Build #2945 succeeded e8cc68e034c82abf56d5bc5330ee221ec3db331f
:green_heart: Build #2941 succeeded 88e40f64350e242cb3bd88ccc22b4d6e857032f1

cc @tkajtoch