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

feat(web): Organization search - different placeholder #17014

Merged
merged 4 commits into from
Nov 25, 2024

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Nov 25, 2024

Organization search - different placeholder

Show different placeholder on organization pages for the search at the top

Before

Screenshot 2024-11-25 at 15 25 47

After

Screenshot 2024-11-25 at 15 25 23

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features
    • Introduced a customizable searchPlaceholder property for the search input in the Header component, enhancing user experience by allowing personalized placeholder text based on context.
  • Bug Fixes
    • No bug fixes were included in this release.
  • Documentation
    • Updated documentation to reflect the new searchPlaceholder property in the Header component.

Copy link
Contributor

coderabbitai bot commented Nov 25, 2024

Walkthrough

The changes in this pull request introduce a new optional property, searchPlaceholder, to the HeaderProps interface of the Header component. This property allows for customizable placeholder text in the search input field. The Layout component is updated to conditionally set the searchPlaceholder based on the organizationSearchFilter. The overall control flow and existing functionalities remain unchanged.

Changes

File Path Change Summary
apps/web/components/Header/Header.tsx Added optional property searchPlaceholder?: string to HeaderProps interface; updated SearchInput placeholder logic.
apps/web/layouts/main.tsx Introduced searchPlaceholder to Header component call; set conditionally based on organizationSearchFilter.

Possibly related PRs

Suggested labels

automerge, high priority

Suggested reviewers

  • mannipje

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.

@RunarVestmann RunarVestmann marked this pull request as ready for review November 25, 2024 15:23
@RunarVestmann RunarVestmann requested review from a team as code owners November 25, 2024 15:23
@RunarVestmann RunarVestmann added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Nov 25, 2024
Copy link

codecov bot commented Nov 25, 2024

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 35.59%. Comparing base (eafbdd9) to head (b09230c).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
apps/web/layouts/main.tsx 0.00% 3 Missing ⚠️
apps/web/components/Header/Header.tsx 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##             main   #17014    +/-   ##
========================================
  Coverage   35.59%   35.59%            
========================================
  Files        6924     6923     -1     
  Lines      146382   146235   -147     
  Branches    41560    41539    -21     
========================================
- Hits        52100    52058    -42     
+ Misses      94282    94177   -105     
Flag Coverage Δ
web 1.74% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
apps/web/components/Header/Header.tsx 0.00% <0.00%> (ø)
apps/web/layouts/main.tsx 0.00% <0.00%> (ø)

... and 51 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eafbdd9...b09230c. Read the comment docs.

---- 🚨 Try these New Features:

Copy link
Contributor

@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: 0

🧹 Outside diff range and nitpick comments (2)
apps/web/components/Header/Header.tsx (1)

Line range hint 35-100: Consider documenting the new feature in component documentation

The implementation is clean and follows best practices. To improve maintainability, consider:

  1. Adding JSDoc comments for the new searchPlaceholder prop to document its purpose and usage
  2. Updating any relevant component documentation or storybook examples
apps/web/layouts/main.tsx (1)

408-415: LGTM! Consider simplifying the placeholder text assignment.

The implementation correctly handles localization and follows TypeScript best practices. However, the default placeholder text could be simplified.

Consider this more concise approach:

                searchPlaceholder={
                  organizationSearchFilter
-                    ? n(
-                        'organizationPageSearchPlaceholder',
-                        activeLocale === 'is' ? 'Leita' : 'Search',
-                      )
+                    ? n('organizationPageSearchPlaceholder', activeLocale === 'is' ? 'Leita' : 'Search')
                    : undefined
                }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ac1a80f and b94369c.

📒 Files selected for processing (2)
  • apps/web/components/Header/Header.tsx (3 hunks)
  • apps/web/layouts/main.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
apps/web/components/Header/Header.tsx (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
apps/web/layouts/main.tsx (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
🔇 Additional comments (3)
apps/web/components/Header/Header.tsx (3)

35-35: LGTM! Property addition follows TypeScript best practices

The new optional searchPlaceholder property is well-typed and follows the existing interface structure.


47-47: LGTM! Props destructuring is clean and consistent

The searchPlaceholder prop is correctly destructured and follows the component's existing patterns.


100-100: LGTM! Placeholder fallback logic is well implemented

The use of the nullish coalescing operator with translation fallback maintains proper internationalization support while allowing custom placeholders.

@datadog-island-is
Copy link

datadog-island-is bot commented Nov 25, 2024

Datadog Report

Branch report: feature/web-organization-search-different-placeholder
Commit report: 4de65bc
Test service: web

✅ 0 Failed, 84 Passed, 0 Skipped, 25.13s Total Time
➡️ Test Sessions change in coverage: 1 no change

@RunarVestmann RunarVestmann added the high priority VIP-Kodiak PR label Nov 25, 2024
@kodiakhq kodiakhq bot merged commit a61c6fb into main Nov 25, 2024
24 checks passed
@kodiakhq kodiakhq bot deleted the feature/web-organization-search-different-placeholder branch November 25, 2024 16:12
jonnigs pushed a commit that referenced this pull request Nov 26, 2024
* Add different placeholder

* Add namespace check

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated:automerge (Disabled) Merge this PR as soon as all checks pass high priority VIP-Kodiak PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants