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

fix: address search bar invisible issue in the navbar. #3452

Closed
wants to merge 1 commit into from

Conversation

souvikjs01
Copy link

@souvikjs01 souvikjs01 commented Dec 7, 2024

previously the search bar was missing:

Screenshot 2024-12-07 160742

now:
added proper search bar in the navbar and proper functionality.

Screenshot 2024-12-07 161347
Screenshot 2024-12-07 161614

Summary by CodeRabbit

  • New Features

    • Enhanced the SearchButton component to accept either a function or a React node as its children, improving customization options.
  • Improvements

    • Modified the onKeyDown event handling for better user interaction with the search button, ensuring it responds to alphanumeric key presses when focused.

Copy link

coderabbitai bot commented Dec 7, 2024

Walkthrough

The changes in this pull request focus on the SearchButton component within the AlgoliaSearch.tsx file. A new conditional branch is introduced in the useEffect hook to handle the children prop, allowing it to accept either a function or a React node. Additionally, the onKeyDown event listener is updated to trigger the onInput function for alphanumeric key presses when the button is focused. These modifications enhance the component's flexibility and interaction model without altering the overall control flow.

Changes

File Change Summary
components/AlgoliaSearch.tsx Modified SearchButton to handle children as a function or React node; updated onKeyDown event to call onInput for alphanumeric keys.

Suggested labels

ready-to-merge

Suggested reviewers

  • derberg
  • magicmatatjahu
  • akshatnema
  • asyncapi-bot-eve
  • Mayaleeeee
  • sambhavgupta0705

Poem

In the garden where buttons bloom,
A new function adds joy to the room.
With keys that dance and children that play,
The search now shines in a whimsical way! 🌼🐇


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2eaa65f and 4c74465.

📒 Files selected for processing (1)
  • components/AlgoliaSearch.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/AlgoliaSearch.tsx

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Copy link

netlify bot commented Dec 7, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 4c74465
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67542c18cfcfd4000834d39d
😎 Deploy Preview https://deploy-preview-3452--asyncapi-website.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 site configuration.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Dec 7, 2024

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 36
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3452--asyncapi-website.netlify.app/

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
components/AlgoliaSearch.tsx (1)

313-318: Consider simplifying the children rendering logic

The current implementation uses state to store derived data from props, which causes an extra render. Consider simplifying this by computing the children value directly:

-  const [Children, setChildren] = useState<string | React.ReactNode>('');
   const searchButtonRef = useRef<HTMLButtonElement>(null);
   const actionKey = getActionKey();

-  useEffect(() => {
-    if (typeof children === 'function') {
-      setChildren(children({ actionKey }));
-    }
-    else {
-      setChildren(children);
-    }
-  }, [children, actionKey]);

+  const renderedChildren = typeof children === 'function' 
+    ? children({ actionKey }) 
+    : children;

   return (
     <button
       type="button"
       ref={searchButtonRef}
       onClick={() => {
         onOpen(indexName);
       }}
       {...props}
       data-testid="Search-Button"
     >
-      {Children}
+      {renderedChildren}
     </button>
   );

This approach:

  1. Eliminates unnecessary state management
  2. Reduces component complexity
  3. Improves performance by avoiding an extra render
  4. Makes the code more maintainable
🧰 Tools
🪛 eslint

[error] 315-316: Delete ⏎···

(prettier/prettier)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 949f520 and 2eaa65f.

📒 Files selected for processing (1)
  • components/AlgoliaSearch.tsx (1 hunks)
🧰 Additional context used
📓 Learnings (1)
components/AlgoliaSearch.tsx (1)
Learnt from: amanbhoria
PR: asyncapi/website#3373
File: components/AlgoliaSearch.tsx:313-313
Timestamp: 2024-11-12T06:59:33.852Z
Learning: In the `SearchButton` component within `components/AlgoliaSearch.tsx`, if the component re-renders on every button click and the `useEffect` runs accordingly, adding dependencies to the dependency array might not be necessary.

Comment on lines +316 to +318
else {
setChildren(children);
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add missing dependency to useEffect hook

The empty dependency array prevents the effect from re-running when the children prop changes, which could cause the search bar to become invisible when the prop updates. This likely explains the issue mentioned in the PR description.

Apply this fix:

-  }, []);
+  }, [children, actionKey]);

This ensures that the search bar content updates properly when the children prop changes. The actionKey dependency is also needed since it's used within the effect.

Committable suggestion skipped: line range outside the PR's diff.

@anshgoyalevil
Copy link
Member

Thanks @souvikjs01 but the issue is resolved in another PR 🚀

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

Successfully merging this pull request may close these issues.

3 participants