fix(search-algolia): pass custom transformItems function to SearchBar #8462

mturoci · 2022-12-19T09:39:17Z

Pre-flight checklist

I have read the Contributing Guidelines on pull requests.
If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
If this is a new API or substantial change: the PR has an accompanying issue (closes Pass transformItems to SearchBar #8461) and the maintainers have approved on my working plan.

Motivation

Closes #8462

Test Plan

Manual

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

Closes #8461

…nent. facebook#8461

netlify · 2022-12-19T09:42:49Z

✅ [V2]

Name	Link
🔨 Latest commit	`a3e4b1e`
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/63ad82b29d0f6b000894ba73
😎 Deploy Preview	https://deploy-preview-8462--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

github-actions · 2022-12-19T09:43:21Z

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🟠 78	🟢 97	🟢 100	🟢 100	🟢 90	Report
/docs/installation	🟠 74	🟢 100	🟢 100	🟢 100	🟢 90	Report

Josh-Cena · 2022-12-21T18:23:33Z

packages/docusaurus-theme-search-algolia/src/theme/SearchBar/index.tsx

+    props.transformItems
+      ? props.transformItems
+      : (items) =>
+          items.map((item) => {
+            // If Algolia contains a external domain, we should navigate without
+            // relative URL
+            if (isRegexpStringMatch(externalUrlRegex, item.url)) {
+              return item;
+            }
+
+            // We transform the absolute URL into a relative URL.
+            const url = new URL(item.url);
+            return {
+              ...item,
+              url: withBaseUrl(`${url.pathname}${url.hash}`),
+            };
+          }),


Extract the arrow to a new variable and write useRef(props.transformItems ?? defaultTransformItems).

slorber · 2022-12-22T16:51:13Z

This PR references itself (instead of an external issue) and does not really give much context into what you are trying to achieve (although I have an idea, I'd like you to explain)

This is also doing to conflict with #8428, which may already solve your use-case?

Note: make sure your use-case also works on the SearchPage? https://docusaurus.io/search

slorber · 2022-12-22T18:27:19Z

Found the original issue 🤪 #8461

Using a wrapper to provide a custom transformItems prop is exactly what I had in mind, so feel free to go ahead.

Still wonder if the newly introduced code does not solve your use-case? cf #8428

  const transformItems = useRef<DocSearchModalProps['transformItems']>(
    (items) =>
      items.map((item) => ({
        ...item,
        url: processSearchResultUrl(item.url),
      })),
  ).current;

Why do you want to transform those items?

# Conflicts: # packages/docusaurus-theme-search-algolia/src/theme/SearchBar/index.tsx

mturoci · 2023-01-09T07:19:24Z

Sorry @slorber @Josh-Cena. I was on a Christmas holiday but seems like you guys took care of this PR already.

This PR references itself

Oops, my bad.

Still wonder if the newly introduced code does not solve your use-case

Not really. I wanted to tweak the search results and reorder them the way I want. The linked issue allows only changing the results pathname if I could understand correctly.

…#8462) Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com> closes undefined Closes #8462 Closes #8461

feat: Allow passing custom transformItems function to Searchbar compo…

1bb3d1b

…nent. facebook#8461

mturoci requested review from slorber, lex111 and Josh-Cena as code owners December 19, 2022 09:39

facebook-github-bot added the CLA Signed Signed Facebook CLA label Dec 19, 2022

Josh-Cena changed the title ~~feat: Allow passing custom transformItems function to Searchbar component. #8461~~ feat(search-algolia): pass custom transformItems function to SearchBar Dec 21, 2022

Josh-Cena added the pr: new feature This PR adds a new API or behavior. label Dec 21, 2022

Josh-Cena reviewed Dec 21, 2022

View reviewed changes

Merge branch 'main' into feat/issue-8461

a3e4b1e

# Conflicts: # packages/docusaurus-theme-search-algolia/src/theme/SearchBar/index.tsx

slorber added the to backport This PR is planned to be backported to a stable version of Docusaurus label Dec 29, 2022

slorber changed the title ~~feat(search-algolia): pass custom transformItems function to SearchBar~~ fix(search-algolia): pass custom transformItems function to SearchBar Dec 29, 2022

slorber added pr: new feature This PR adds a new API or behavior. pr: bug fix This PR fixes a bug in a past release. and removed pr: new feature This PR adds a new API or behavior. labels Dec 29, 2022

slorber merged commit 0985fa0 into facebook:main Dec 29, 2022

mturoci deleted the feat/issue-8461 branch January 9, 2023 07:19

slorber pushed a commit that referenced this pull request Jan 26, 2023

fix(search-algolia): pass custom transformItems function to SearchBar (…

30573dd

…#8462) Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com> closes undefined Closes #8462 Closes #8461

slorber added backported This PR has been backported to a stable version of Docusaurus and removed to backport This PR is planned to be backported to a stable version of Docusaurus labels Jan 27, 2023

slorber mentioned this pull request Mar 15, 2023

Send search request to Algolia with some delay #5174

Closed

slorber mentioned this pull request Oct 19, 2023

chore: v3.0.0-rc.0 release #9418

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(search-algolia): pass custom transformItems function to SearchBar #8462

fix(search-algolia): pass custom transformItems function to SearchBar #8462

mturoci commented Dec 19, 2022 •

edited by Josh-Cena

netlify bot commented Dec 19, 2022 •

edited

github-actions bot commented Dec 19, 2022 •

edited

Josh-Cena Dec 21, 2022

slorber commented Dec 22, 2022 •

edited

slorber commented Dec 22, 2022

mturoci commented Jan 9, 2023

fix(search-algolia): pass custom transformItems function to SearchBar #8462

fix(search-algolia): pass custom transformItems function to SearchBar #8462

Conversation

mturoci commented Dec 19, 2022 • edited by Josh-Cena

Pre-flight checklist

Motivation

Test Plan

Test links

Related issues/PRs

netlify bot commented Dec 19, 2022 • edited

✅ [V2]

github-actions bot commented Dec 19, 2022 • edited

⚡️ Lighthouse report for the deploy preview of this PR

Josh-Cena Dec 21, 2022

Choose a reason for hiding this comment

slorber commented Dec 22, 2022 • edited

slorber commented Dec 22, 2022

mturoci commented Jan 9, 2023

mturoci commented Dec 19, 2022 •

edited by Josh-Cena

netlify bot commented Dec 19, 2022 •

edited

github-actions bot commented Dec 19, 2022 •

edited

slorber commented Dec 22, 2022 •

edited