-
Notifications
You must be signed in to change notification settings - Fork 7.6k
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
refac: Search component type improvements #6370
base: main
Are you sure you want to change the base?
Conversation
Hi @ssi02014! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
Size changes📦 Next.js Bundle Analysis for react-devThis analysis was generated by the Next.js Bundle Analysis action. 🤖 Three Pages Changed SizeThe following pages changed size from the code in this PR compared to its base branch:
DetailsOnly the gzipped size is provided here based on an expert tip. First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If Any third party scripts you have added directly to your app using the Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 10% or more, there will be a red status indicator applied, indicating that special attention should be given to this. |
I did sign the CLA 🙏 |
@@ -20,8 +21,10 @@ export interface SearchProps { | |||
onClose: () => void; | |||
} | |||
|
|||
function Hit({hit, children}: any) { | |||
return <Link href={hit.url.replace()}>{children}</Link>; | |||
type HitProps = Parameters<NonNullable<DocSearchProps['hitComponent']>>[0]; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
type HitProps = {
hit: InternalDocSearchHit | StoredDocSearchHit;
children: React.ReactNode;
}
Improved the type of
Hit
type in the Search component.Instead of being of type
any
, it is now of typeprops
of the actualhitComponent
ofDocSearchProps
.https://github.com/algolia/docsearch/blob/main/packages/docsearch-react/src/DocSearch.tsx#L26
The type of
url
isstring
.https://github.com/algolia/docsearch/blob/main/packages/docsearch-react/src/types/DocSearchHit.ts#L45
hit.url.replace()
,hit.url
will return the same result. However,replace()
throws a type error because it actually needs to take2 arguments
, so only hit.url is sufficient.