Skip to content

feat: Split docsearch-react package exports #2764

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

Jump to bottom
Merged
8bittitan merged 5 commits into from
Sep 22, 2025
Merged

feat: Split docsearch-react package exports #2764

8bittitan merged 5 commits into from
Sep 22, 2025

Conversation

@8bittitan
Copy link
Contributor

@8bittitan 8bittitan commented Sep 16, 2025 •
edited
Loading

Explicitly exports DocSearchModal, DocSearchButton, useDocSearchKeyboardEvents, useTheme and version as their own standalone exports. This is to reduce overall bundle size if wanting to use these components on their own.

With this you could now import like the following:

import { DocSearchButton } from '@docsearch/react/button'
import { DocSearchModal } from '@docsearch/react/modal'
import { useDocSearchKeyboardEvents } from '@docsearch/react/useDocSearchKeyboardEvents'
import { useTheme } from '@docsearch/react/useTheme'
import { version } from '@docsearch/react/version'

The new @docsearch/react dist directory will look like the following:

.
├── esm
│   ├── DocSearchButton.d.ts
│   ├── DocSearchButton.js
│   ├── DocSearchModal.d.ts
│   ├── DocSearchModal.js
│   ├── index.d.ts
│   ├── index.js
│   ├── useDocSearchKeyboardEvents.d.ts
│   ├── useDocSearchKeyboardEvents.js
│   ├── useTheme.d.ts
│   ├── useTheme.js
│   ├── version.d.ts
│   └── version.js
└── umd
    ├── DocsearchButton.js
    ├── DocsearchButton.js.map
    ├── DocSearchModal.js
    ├── DocSearchModal.js.map
    ├── index.js
    ├── index.js.map
    ├── useDocSearchKeyboardEvents.js
    ├── useDocSearchKeyboardEvents.js.map
    ├── useTheme.js
    ├── useTheme.js.map
    ├── version.js
    └── version.js.map

@8bittitan 8bittitan self-assigned this Sep 16, 2025
@netlify
Copy link

netlify bot commented Sep 16, 2025 •
edited
Loading

✅ Deploy Preview for docsearch ready!

Name Link
🔨 Latest commit 36ed6e8
🔍 Latest deploy log https://app.netlify.com/projects/docsearch/deploys/68d18290a7afdb00089a108e
😎 Deploy Preview https://deploy-preview-2764--docsearch.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@8bittitan 8bittitan mentioned this pull request Sep 16, 2025
Merged
@8bittitan 8bittitan mentioned this pull request Sep 18, 2025
Closed
slorber
slorber reviewed Sep 19, 2025
View reviewed changes
@8bittitan 8bittitan merged commit b15f302 into main Sep 22, 2025
10 checks passed
@8bittitan 8bittitan deleted the feat/split-docsearch-react-exports-better branch September 22, 2025 17:46
@dylantientcheu dylantientcheu mentioned this pull request Sep 23, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dylantientcheu dylantientcheu dylantientcheu approved these changes

@shortcuts shortcuts Awaiting requested review from shortcuts shortcuts is a code owner

@NatanTechofNY NatanTechofNY Awaiting requested review from NatanTechofNY NatanTechofNY is a code owner

@vascobettencourt vascobettencourt Awaiting requested review from vascobettencourt vascobettencourt is a code owner

@pipeline1987 pipeline1987 Awaiting requested review from pipeline1987 pipeline1987 is a code owner

+1 more reviewer

@slorber slorber slorber left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@8bittitan 8bittitan

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@8bittitan @slorber @dylantientcheu