Skip to content

Fixed Search issue in Primitives doc search - Issue #854 #875

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fixed Search issue in Primitives doc search - Issue #854 #875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea7ac41
fixed search issue in primitives doc - fixed #854
Praneshxo Jun 21, 2025
a19e07c
fixed deployment issue
Praneshxo Jun 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .env.development
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
NEXT_PUBLIC_ALGOLIA_INDEX_NAME=development_docs
NEXT_PUBLIC_ALGOLIA_INDEX_NAME=radix_website_hf6d3bhd9_workos_vercel_app_co3q04we0u_pages
ALGOLIA_APP_ID=CO3Q04WE0U
ALGOLIA_PUBLIC_API_KEY=0715976de79c8c1bdb658b4189a605ff
2 changes: 1 addition & 1 deletion .env.production
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
NEXT_PUBLIC_ALGOLIA_INDEX_NAME=docs
NEXT_PUBLIC_ALGOLIA_INDEX_NAME=radix_website_hf6d3bhd9_workos_vercel_app_co3q04we0u_pages
5 changes: 3 additions & 2 deletions algolia/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
APPLICATION_ID=VXVOLU3YVQ
API_KEY=
APPLICATION_ID=CO3Q04WE0U
API_KEY=0715976de79c8c1bdb658b4189a605ff
NEXT_PUBLIC_ALGOLIA_INDEX_NAME=radix_website_hf6d3bhd9_workos_vercel_app_co3q04we0u_pages
6 changes: 3 additions & 3 deletions algolia/config.development.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"index_name": "development_docs",
"start_urls": ["https://24fe-92-28-230-172.eu.ngrok.io/primitives/docs"],
"index_name": "radix_website_hf6d3bhd9_workos_vercel_app_co3q04we0u_pages",
"start_urls": ["http://localhost:3000/primitives/docs"],
"stop_urls": [
"https://24fe-92-28-230-172.eu.ngrok.io/primitives/docs/overview/releases"
"http://localhost:3000/primitives/docs/overview/releases"
],
"selectors": {
"lvl0": {
Expand Down
35 changes: 18 additions & 17 deletions algolia/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
{
"index_name": "docs",
"start_urls": ["https://www.radix-ui.com/primitives/docs"],
"stop_urls": ["https://www.radix-ui.com/primitives/docs/overview/releases"],
"selectors": {
"lvl0": {
"selector": "[data-algolia-lvl0]",
"global": true
},
"lvl1": "[data-algolia-page-scope] h1",
"lvl2": "[data-algolia-page-scope] h2",
"lvl3": "[data-algolia-page-scope] h3",
"lvl4": "[data-algolia-page-scope] h4",
"text": "[data-algolia-page-scope] p, [data-algolia-page-scope] li"
},
"min_indexed_level": 1,
"selectors_exclude": ["[data-algolia-exclude]"],
"scrape_start_urls": false
"index_name": "radix_website_hf6d3bhd9_workos_vercel_app_co3q04we0u_pages",
"start_urls": ["https://www.radix-ui.com/primitives/docs"],
"stop_urls": ["https://www.radix-ui.com/primitives/docs/overview/releases"],
"selectors": {
"lvl0": {
"selector": "[data-algolia-lvl0], [data-algolia-page-scope] h1",
"global": true,
"default_value": "Documentation"
},
"lvl1": "[data-algolia-page-scope] h1",
"lvl2": "[data-algolia-page-scope] h2",
"lvl3": "[data-algolia-page-scope] h3",
"lvl4": "[data-algolia-page-scope] h4",
"text": "[data-algolia-page-scope] p, [data-algolia-page-scope] li"
},
"min_indexed_level": 1,
"selectors_exclude": ["[data-algolia-exclude]"],
"scrape_start_urls": false
}
100 changes: 57 additions & 43 deletions components/PrimitivesSearch.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ import type {
AutocompleteApi as InternalAutocompleteApi,
} from "@algolia/autocomplete-core";
import type { Hit, SearchResponse } from "@algolia/client-search";

const ALGOLIA_APP_ID = "VXVOLU3YVQ";
const ALGOLIA_PUBLIC_API_KEY = "9d44395c1b7b172ac84b7e5ab80bf8c5";
//Updated new search api key
const ALGOLIA_APP_ID = "CO3Q04WE0U";
const ALGOLIA_PUBLIC_API_KEY = "0715976de79c8c1bdb658b4189a605ff";

const searchClient = algoliasearch(ALGOLIA_APP_ID, ALGOLIA_PUBLIC_API_KEY);

Expand All @@ -40,6 +40,7 @@ type SearchItem = SnippetedHit<{
objectID: string;
type: ContentType;
url: string;
title: string;
hierarchy: {
lvl0: string;
lvl1: string;
Expand Down Expand Up @@ -115,6 +116,7 @@ function PrimitivesSearchRoot({
"hierarchy.lvl3",
"hierarchy.lvl4",
"content",
"title",
],
attributesToSnippet: [
`hierarchy.lvl0:${snippetLength}`,
Expand All @@ -139,19 +141,20 @@ function PrimitivesSearchRoot({
throw error;
})
.then(({ results }) => {
// we only have 1 query, so we grab the hits from the first result
// Uncategorized the hitquery
const { hits } = results[0] as SearchResponse<SearchItem>;
const sources = groupBy(hits, (hit) => hit.hierarchy.lvl0);
const sources = groupBy(hits, (hit) => hit.hierarchy?.lvl0 || "Uncategorized");
return Object.entries(sources)
.sort(sortSources)
.map(([lvl0, items]) => ({
onSelect: (params) => {
params.setIsOpen(false);
},
sourceId: lvl0,
getItemUrl: ({ item }) => item.url,
getItems: () => items,
}));
onSelect: (params) => {
params.setIsOpen(false);
},
sourceId: lvl0 || "Uncategorized",
getItemUrl: ({ item }) => item.url,
getItems: () => items,
}));

});
},
}),
Expand Down Expand Up @@ -433,39 +436,50 @@ function ItemTitle(props: ItemTitleProps) {
}

function ItemBreadcrumb({
item,
levels,
item,
levels,
}: {
item: SearchItem;
levels: typeof SUPPORTED_LEVELS;
item: SearchItem;
levels: typeof SUPPORTED_LEVELS;
}) {
const itemLevelIndex =
item.type === "content" ? levels.length - 1 : levels.indexOf(item.type);
const breadcrumbLevels = levels.slice(0, itemLevelIndex);

return (
<Text size="2" color="gray" as="p">
{breadcrumbLevels.map((level, index) => {
const heading = item.hierarchy[level];
return heading ? (
<React.Fragment key={index}>
{index > 0 ? (
<Box
as="span"
display="inline"
style={{ color: "var(--gray-a11)" }}
>
<CaretRightIcon style={{ display: "inline-block" }} />
{/* Adding a comma to insert a natural break in the speech flow */}
<VisuallyHidden.Root>, </VisuallyHidden.Root>
</Box>
) : null}
<Highlight hit={item} attribute={["hierarchy", level]} />
</React.Fragment>
) : null;
})}
</Text>
);
if (!item.hierarchy || typeof item.hierarchy !== "object") {

const fallbackText = item.title || item.content || "No title available";
return (
<Text size="2" color="gray" as="p">
{fallbackText}
</Text>
);
}

const itemLevelIndex =
item.type === "content" ? levels.length - 1 : levels.indexOf(item.type);
const breadcrumbLevels = levels.slice(0, itemLevelIndex);

return (
<Text size="2" color="gray" as="p">
{breadcrumbLevels.map((level, index) => {
const heading = item.hierarchy[level];
if (!heading) return null;

return (
<React.Fragment key={index}>
{index > 0 && (
<Box
as="span"
display="inline"
style={{ color: "var(--gray-a11)" }}
>
<CaretRightIcon style={{ display: "inline-block" }} />
<VisuallyHidden.Root>, </VisuallyHidden.Root>
</Box>
)}
<Highlight hit={item} attribute={["hierarchy", level]} />
</React.Fragment>
);
})}
</Text>
);
}

function Highlight<THit extends SnippetedHit<unknown>>({
Expand Down
3 changes: 1 addition & 2 deletions next-env.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/// <reference types="next" />
/// <reference types="next/image-types/global" />
/// <reference types="next/navigation-types/compat/navigation" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.
// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
Loading