-
Notifications
You must be signed in to change notification settings - Fork 4k
Scope search across sections and variants #3640
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
zenoachtig
merged 8 commits into
main
from
zeno/rnd-5788-scope-search-across-sections-and-variants-in-gbo
Sep 16, 2025
Merged
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
f8138da
Scope search across sections and variants
zenoachtig 5c071e9
Update SearchContainer.tsx
zenoachtig 9900e8a
Update useSearch.tsx
zenoachtig 0a3d770
Update SearchResults.tsx
zenoachtig ecdd840
Translations
zenoachtig e196d19
Update translations and layout
zenoachtig d606fe8
Rework to single scope param
zenoachtig 1bf0682
Update packages/gitbook/src/components/primitives/DropdownMenu.tsx
zenoachtig File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "gitbook": minor | ||
| --- | ||
|
|
||
| Scope search across sections and variants |
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
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
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
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
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
99 changes: 62 additions & 37 deletions
99
packages/gitbook/src/components/Search/SearchScopeToggle.tsx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,52 +1,77 @@ | ||
| import { tString, useLanguage } from '@/intl/client'; | ||
| import { Button } from '../primitives'; | ||
| 'use client'; | ||
|
|
||
| import type { SiteSection } from '@gitbook/api'; | ||
| import { SegmentedControl, SegmentedControlItem } from '../primitives/SegmentedControl'; | ||
| import { useSearch } from './useSearch'; | ||
|
|
||
| /** | ||
| * Toolbar to toggle between search modes (global or scoped to a space). | ||
| * Only visible when the space is in a collection. | ||
| */ | ||
| export function SearchScopeToggle(props: { spaceTitle: string }) { | ||
| const { spaceTitle } = props; | ||
| export function SearchScopeToggle(props: { | ||
| spaceTitle: string; | ||
| section?: Pick<SiteSection, 'title' | 'icon'>; | ||
| withVariants: boolean; | ||
| withSiteVariants: boolean; | ||
| withSections: boolean; | ||
| }) { | ||
| const { spaceTitle, section, withVariants, withSections, withSiteVariants } = props; | ||
| const [state, setSearchState] = useSearch(); | ||
| const language = useLanguage(); | ||
|
|
||
| if (!state) { | ||
| return null; | ||
| } | ||
|
|
||
| return ( | ||
| <div | ||
| role="toolbar" | ||
| aria-orientation="horizontal" | ||
| className="mb-2 flex flex-row flex-wrap gap-1 circular-corners:rounded-3xl rounded-corners:rounded-lg bg-tint-subtle p-1" | ||
| > | ||
| <Button | ||
| variant="blank" | ||
| size="medium" | ||
| className="shrink grow justify-center whitespace-normal" | ||
| active={!state.global} | ||
| label={tString(language, 'search_scope_space', spaceTitle)} | ||
| onClick={() => { | ||
| setSearchState({ | ||
| ...state, | ||
| global: false, | ||
| }); | ||
| }} | ||
| /> | ||
| <Button | ||
| variant="blank" | ||
| size="medium" | ||
| className="shrink grow justify-center whitespace-normal" | ||
| active={state.global} | ||
| label={tString(language, 'search_scope_all')} | ||
| onClick={() => { | ||
| setSearchState({ | ||
| ...state, | ||
| global: true, | ||
| }); | ||
| }} | ||
| /> | ||
| </div> | ||
| <> | ||
| {withSections ? ( | ||
| <SegmentedControl className="animate-scale-in @max-md:flex-col"> | ||
| <SegmentedControlItem | ||
| active={state.scope === 'current'} | ||
| icon={section?.icon} | ||
| label={section?.title} | ||
| onClick={() => | ||
| setSearchState({ ...state, scope: 'current', depth: 'single' }) | ||
| } | ||
| /> | ||
| <SegmentedControlItem | ||
| active={state.scope === 'all' && state.depth === 'single'} | ||
| label={withSiteVariants ? 'Most relevant' : 'Entire site'} | ||
| icon={withSiteVariants ? 'bullseye-arrow' : 'infinity'} | ||
| onClick={() => setSearchState({ ...state, scope: 'all', depth: 'single' })} | ||
| /> | ||
| {withSiteVariants ? ( | ||
| <SegmentedControlItem | ||
| active={state.scope === 'all' && state.depth === 'full'} | ||
| label="Entire site" | ||
| icon="infinity" | ||
| onClick={() => | ||
| setSearchState({ ...state, scope: 'all', depth: 'full' }) | ||
| } | ||
| /> | ||
| ) : null} | ||
| </SegmentedControl> | ||
| ) : null} | ||
| {withVariants && (!withSections || state.scope === 'current') ? ( | ||
| <SegmentedControl className="animate-scale-in"> | ||
| <SegmentedControlItem | ||
| size={state.scope === 'current' ? 'small' : 'medium'} | ||
| active={state.depth === 'single'} | ||
| className="py-1" | ||
zenoachtig marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| label={spaceTitle} | ||
| icon="crosshairs" | ||
| onClick={() => setSearchState({ ...state, depth: 'single' })} | ||
| /> | ||
| <SegmentedControlItem | ||
| size={state.scope === 'current' ? 'small' : 'medium'} | ||
| active={state.depth === 'full'} | ||
| className="py-1" | ||
| label="All content" | ||
| icon="rectangle-vertical-history" | ||
| onClick={() => setSearchState({ ...state, depth: 'full' })} | ||
| /> | ||
| </SegmentedControl> | ||
| ) : null} | ||
| </> | ||
| ); | ||
| } | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.