feat: doc search block #738

fkakatie · 2025-01-09T18:36:04Z

Description

documentation search box block.

search field is as wide as the full column
index is pre-fetched with an intersection observer
ability to author pre-formulated questions that will show up as placeholder values, rotating ~~every 10 seconds~~ based on question character length
displays the top hit as an drop-down overlay
- OR a "no results found" message that redirects to the docs landing page

⚠️ Questions/Concerns

would love some more guidance on placement. specifically spacing, and wording for a label so it's not just floating in space
is it worth having the "index source" authorable? it's not in the nav, but i'm not 100% sure that's the course source (99% currently)
currently 2 (~3) hard-coded strings (below), i'd love someone else to contribute to or validate wording before they're moved into placeholders
- Search the documentation
- We didn\'t find a good match. <a href="/docs/">Visit our documentation page</a> for more.
really went for it with animation, keyboard support, intervals... is any of this useful and worth keeping? or distracting and should be removed?

Links

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have signed the Adobe Open Source CLA.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed. (this is not due to my PR! will fix separately)

aem-code-sync · 2025-01-09T18:36:09Z

Hello, I'm the AEM Code Sync Bot and I will run some actions to deploy your branch and validate page speed.
In case there are problems, just click a checkbox below to rerun the respective action.