Skip to content

Bump DocSearch to 5.0.1 - #48983

Open
code-infra-renovate[bot] wants to merge 6 commits into
masterfrom
renovate/major-docsearch
Open

Bump DocSearch to 5.0.1#48983
code-infra-renovate[bot] wants to merge 6 commits into
masterfrom
renovate/major-docsearch

Conversation

@code-infra-renovate

@code-infra-renovate code-infra-renovate Bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

The version bump alone does not build. DocSearch v5 changes the keyword search API, so fd68a76 adapts the docs. See the migration guide.

  • indexName + searchParameters -> indices array. Added hierarchy.lvl6 to attributesToRetrieve, because v5 builds the hit breadcrumbs from the full hierarchy.
  • Removed onAskAiToggle from <DocSearchModal>. The keyword-only modal no longer accepts it. useDocSearchKeyboardEvents still requires it.
  • Added @docsearch/react to transpilePackages. Next externalizes the ESM-only package for SSR, and its CJS @algolia/autocomplete-core dependency then breaks named-export interop, so every page falls back to client rendering.
  • Kept the hit title and the hit path on one line. v5 wraps them below 768px, which turns the compact rows into multi-line cards.
  • Reset the padding-inline-start v5 adds to the hit lists. It indented the result cards but not the section headings above them.
  • Set --docsearch-font-family: inherit. v5 added that variable and applies it to .DocSearch-Modal, so the modal switched from the docs typeface to a system font stack. The different metrics also pushed the underline under matched text past the overflow: hidden clip on .DocSearch-Hit-title, so highlights lost their underline.
  • Refreshed the override comments that named v4.

Checked in the dev server and against the current v4 production site: start screen, recent searches, results, no results, hit navigation, Cmd+K, /, Escape, type-ahead on the focused button, light and dark mode, desktop and mobile. next build --webpack passes.

Visual coverage for this lands separately in #49002.


This PR contains the following updates:

Package Change Age Confidence
@docsearch/css (source) 4.7.05.0.1 age confidence
@docsearch/react (source) ^4.7.0^5.0.1 age confidence

Release Notes

algolia/docsearch (@​docsearch/css)

v5.0.1

Compare Source

v5.0.0

Compare Source

Major Changes
  • ecd905d: # DocSearch v5-beta

    DocSearch v5 is a major release that introduces AI-powered answers via Agent
    Studio, a refreshed search UI, and a modernized package architecture.

algolia/docsearch (@​docsearch/react)

v5.0.1

Compare Source

Patch Changes

v5.0.0

Compare Source

Major Changes
  • ecd905d: # DocSearch v5-beta

    DocSearch v5 is a major release that introduces AI-powered answers via Agent
    Studio, a refreshed search UI, and a modernized package architecture.


Configuration

📅 Schedule: (in timezone UTC)

  • Branch creation
    • Between 12:00 AM and 04:59 AM, only on Sunday (* 0-4 * * 7)
  • Automerge
    • At any time (no schedule defined)

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by self-hosted Renovate.

@code-infra-renovate code-infra-renovate Bot added the dependencies Update of dependencies. label Aug 16, 2026
@github-actions github-actions Bot added the PR: out-of-date The pull request has merge conflicts and can't be merged. label Aug 17, 2026
@code-infra-renovate
code-infra-renovate Bot force-pushed the renovate/major-docsearch branch from a658274 to 69e214b Compare August 17, 2026 07:34
@github-actions github-actions Bot added PR: out-of-date The pull request has merge conflicts and can't be merged. and removed PR: out-of-date The pull request has merge conflicts and can't be merged. labels Aug 17, 2026
@code-infra-renovate
code-infra-renovate Bot force-pushed the renovate/major-docsearch branch from 69e214b to c98a808 Compare August 17, 2026 11:15
@github-actions github-actions Bot added PR: out-of-date The pull request has merge conflicts and can't be merged. and removed PR: out-of-date The pull request has merge conflicts and can't be merged. labels Aug 17, 2026
@code-infra-renovate
code-infra-renovate Bot force-pushed the renovate/major-docsearch branch from c98a808 to 2788f3b Compare August 17, 2026 13:26
@github-actions github-actions Bot added PR: out-of-date The pull request has merge conflicts and can't be merged. and removed PR: out-of-date The pull request has merge conflicts and can't be merged. labels Aug 17, 2026
@code-infra-renovate
code-infra-renovate Bot force-pushed the renovate/major-docsearch branch from 2788f3b to b4f4926 Compare August 18, 2026 09:19
@github-actions github-actions Bot added PR: out-of-date The pull request has merge conflicts and can't be merged. and removed PR: out-of-date The pull request has merge conflicts and can't be merged. labels Aug 18, 2026
@code-infra-renovate
code-infra-renovate Bot force-pushed the renovate/major-docsearch branch from b4f4926 to c2e94b2 Compare August 19, 2026 07:25
@github-actions github-actions Bot added PR: out-of-date The pull request has merge conflicts and can't be merged. and removed PR: out-of-date The pull request has merge conflicts and can't be merged. labels Aug 19, 2026
@code-infra-renovate
code-infra-renovate Bot force-pushed the renovate/major-docsearch branch from c2e94b2 to 61cfe0e Compare August 19, 2026 15:21
@github-actions github-actions Bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged. label Aug 19, 2026
@ZeeshanTamboli
ZeeshanTamboli requested a review from LukasTy August 20, 2026 05:13
@github-actions github-actions Bot added the PR: out-of-date The pull request has merge conflicts and can't be merged. label Aug 20, 2026
@code-infra-renovate
code-infra-renovate Bot force-pushed the renovate/major-docsearch branch from 61cfe0e to 5c7ba6e Compare August 20, 2026 06:18
@github-actions github-actions Bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged. label Aug 20, 2026
DocSearch v5 replaces `indexName` and `searchParameters` with an `indices`
array, drops `onAskAiToggle` from the keyword-only modal, and ships an ESM-only
entry point. See https://docsearch.algolia.com/docs/migrating-from-v4/.

- Move the index name and the search parameters into `indices`. Add
  `hierarchy.lvl6` to `attributesToRetrieve`, because v5 builds the hit
  breadcrumbs from the full hierarchy.
- Remove `onAskAiToggle` from `<DocSearchModal>`. The keyword-only modal no
  longer accepts it. `useDocSearchKeyboardEvents` still requires it.
- Add `@docsearch/react` to `transpilePackages`. Next externalizes the ESM
  package for SSR, and its CJS `@algolia/autocomplete-core` dependency then
  breaks named-export interop.
- Keep the hit title and the hit path on one line. v5 wraps them below 768px,
  which turns the compact rows into multi-line cards.
- Refresh the override comments that named v4.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@code-infra-dashboard

code-infra-dashboard Bot commented Aug 20, 2026

Copy link
Copy Markdown

Deploy preview

https://deploy-preview-48983--material-ui.netlify.app/
QR code for https://deploy-preview-48983--material-ui.netlify.app/

Bundle size

Bundle Parsed size Gzip size
@mui/material 0B(0.00%) 0B(0.00%)
@mui/lab 0B(0.00%) 0B(0.00%)
@mui/private-theming 0B(0.00%) 0B(0.00%)
@mui/system 0B(0.00%) 0B(0.00%)
@mui/utils 0B(0.00%) 0B(0.00%)

Details of bundle changes


Check out the code infra dashboard for more information about this PR.

@code-infra-renovate

Copy link
Copy Markdown
Contributor Author

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

v5 adds `.DocSearch-Dropdown-Container .DocSearch-Hits-padded
{ padding-inline-start: 1em }`, which indents the result cards but not the
section headings above them. Reset the padding to keep both flush, as in v4.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
v5 adds `--docsearch-font-family` and applies it to `.DocSearch-Modal`, so the
modal switched from the docs typeface to a system font stack. v4 had no such
variable and inherited the page font.

The metrics differ enough to matter: the underline the stylesheet draws under
matched text moved down past the `overflow: hidden` clip on `.DocSearch-Hit-title`,
so the highlight lost its underline. Setting the variable to `inherit` restores
both the typeface and the v4 geometry.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@github-actions github-actions Bot added the PR: out-of-date The pull request has merge conflicts and can't be merged. label Aug 24, 2026
LukasTy and others added 2 commits August 24, 2026 12:56
`.DocSearch-Hit-title` clips its overflow so the row stays one line, and
DocSearch underlines matched text 0.3em below the baseline. At the 14px title
that lands 0.5px inside the clip, so whether the browser paints it comes down to
how a half pixel rounds, which changes with zoom and device pixel ratio. The
12px path has roughly three times the room and never lost it.

Pull the underline closer: 4.2px to 1.96px of offset, 0.5px to 2.74px of room,
with no layout change. The typeface fix before this restored the v4 geometry;
this removes the sub-pixel margin that made it fragile in v4 too.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Only `pnpm-lock.yaml` conflicted. Resolved by keeping this branch's lockfile,
reinstalling against the merged manifests and deduping, which keeps
`@docsearch/react` pinned at 5.0.1 to match the `@docsearch/css` CDN URL that
`AppSearch` loads. A plain reinstall from master's lockfile floated it to 5.0.3
and broke that pairing.

The only entries left differing from master are `marked@16.4.2` and
`undici@5.29.0`, both pulled in by DocSearch v5 through `@ai-sdk`.
@github-actions github-actions Bot added PR: out-of-date The pull request has merge conflicts and can't be merged. and removed PR: out-of-date The pull request has merge conflicts and can't be merged. labels Aug 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Update of dependencies. PR: out-of-date The pull request has merge conflicts and can't be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant