Proof of concept: Add in-page search to Project’s general settings
Proposal
Add a search box to the Projects’ general settings that allows finding content within the page’s sections. The search functionality behave in the following way:
- When the user types in the search box, the search component will hide the sections of the page that do not match the search query.
- The search component will expand the sections that match the search query.
- The elements that match the search query will be highlighted.
The goal of this deliverable is validating the solution for in-page search that we proposed in the technical discovery issue.
Feature flag
We will hide this iteration behind feature flag. Once we roll out this proof of concept to everyone, we will create implementation issues to integrate this search functionality to other settings’ pages.
Implementation proposal
We implemented a script that demonstrates how to build a client-side search index to search inside a Settings page. You can see the code in $2047915.
-
Create a search component and include in the Project’s general settings behind a feature flag. -
Create documentation Merge Request following the deployed feature flag documentation guidelines -
Create feature flag rollout issue — #294025 (closed)
Edited by Enrique Alcántara