Skip to content
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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ssi02014
Copy link

@ssi02014 ssi02014 commented Oct 23, 2023

Improved the type of Hit type in the Search component.

Instead of being of type any, it is now of type props of the actual hitComponent of DocSearchProps.
https://github.com/algolia/docsearch/blob/main/packages/docsearch-react/src/DocSearch.tsx#L26

export interface DocSearchProps {
    // ...
    hitComponent?(props: {
        hit: InternalDocSearchHit | StoredDocSearchHit;
        children: React.ReactNode;
    }): JSX.Element;
}

The type of url is string.
https://github.com/algolia/docsearch/blob/main/packages/docsearch-react/src/types/DocSearchHit.ts#L45

export declare type DocSearchHit = {
    // ...
    url: string;
};

hit.url.replace(), hit.url will return the same result. However, replace() throws a type error because it actually needs to take 2 arguments, so only hit.url is sufficient.

interface String {
  // ...
  replace(searchValue: { [Symbol.replace](string: string, replaceValue: string): string; }, replaceValue: string): string;
}
스크린샷 2023-10-23 오후 10 56 27

@facebook-github-bot
Copy link
Collaborator

Hi @ssi02014!

Thank you for your pull request and welcome to our community.

Action Required

In 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.

Process

In 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 CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@github-actions
Copy link

Size changes

📦 Next.js Bundle Analysis for react-dev

This analysis was generated by the Next.js Bundle Analysis action. 🤖

Three Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load
/404 77.29 KB (-3 B) 181.24 KB
/500 77.28 KB (-3 B) 181.23 KB
/[[...markdownPath]] 78.83 KB (-3 B) 182.78 KB
Details

Only 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 next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

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.

@ssi02014
Copy link
Author

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];
Copy link
Author

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;
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants