Scope search across sections and variants #3640
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
**Components:** - Add `data-active` to `Button` to make styling easier - Improve active style for blank buttons in `contrast-more` mode - Add leading icon to `DropdownMenuItem`, to be further standardised in other places in follow-up PR - Create `SegmentedControl` component that styles buttons to look like one big selector. **Search**: - Rework `global` search parameter into two separate ones to determine search scope: - `scope: all | current`: how "wide" to search on the site. Determines section scope. - `depth: single | full`: how "deep" to search within the scope. This determines the variant scope within sections. - Change `SearchScopeToggle` to use new scope & depth params and segmented control to show a UI to switch between scopes.
🦋 Changeset detectedLatest commit: 1bf0682 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
zenoachtig
commented
Sep 11, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the search functionality to provide more granular control over search scope across site sections and variants. It replaces the simple boolean global parameter with two new parameters (scope and depth) and introduces a new segmented control UI component.
- Replaces boolean
globalsearch parameter withscope(all/current) anddepth(single/full) parameters - Creates new
SegmentedControlcomponent for improved search scope selection UI - Adds
leadingIconsupport toDropdownMenuItemanddata-activeattribute toButtoncomponents
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/gitbook/src/components/primitives/SegmentedControl.tsx | New component providing segmented control UI for search scope selection |
| packages/gitbook/src/components/primitives/DropdownMenu.tsx | Adds leading icon support and increases z-index |
| packages/gitbook/src/components/primitives/Button.tsx | Adds data-active attribute and improves styling |
| packages/gitbook/src/components/Search/useSearch.tsx | Replaces global boolean with scope/depth parameters |
| packages/gitbook/src/components/Search/server-actions.tsx | Refactors search functions to handle new scope parameters |
| packages/gitbook/src/components/Search/SearchScopeToggle.tsx | Complete rewrite using SegmentedControl component |
| packages/gitbook/src/components/Search/SearchResults.tsx | Updates to use new scope/depth parameters |
| packages/gitbook/src/components/Search/SearchContainer.tsx | Updates prop interface and search logic |
| packages/gitbook/src/components/SpaceLayout/SpaceLayout.tsx | Updates SearchContainer props |
| packages/gitbook/src/components/Header/Header.tsx | Updates SearchContainer props |
| packages/gitbook/src/components/AI/useAIChat.tsx | Updates to use new search parameters |
| packages/gitbook/src/components/AI/useAI.tsx | Updates to use new search parameters |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
taranvohra
reviewed
Sep 11, 2025
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 23 out of 23 changed files in this pull request and generated 4 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
taranvohra
approved these changes
Sep 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Components
data-activetoButtonto make styling easiercontrast-moremodeDropdownMenuItem, to be further standardised in other places in follow-up PRSegmentedControlcomponent that styles buttons to look like one big selector.Search
globalsearch parameter into two separate ones to determine search scope:scope: all | current: how "wide" to search on the site. Determines section scope.depth: single | full: how "deep" to search within the scope. This determines the variant scope within sections.SearchScopeToggleto use new scope & depth params and segmented control to show a UI to switch between scopes.Demo
CleanShot.2025-09-10.at.17.26.59.mp4