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): Add search input to organization standalone theme mobile frontpage #17095

Merged

Conversation

mannipje
Copy link
Member

@mannipje mannipje commented Dec 2, 2024

Add search input to organization standalone theme mobile frontpage

Screenshots / Gifs

Before

image

After

image

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

    • Enhanced header with conditional search input visibility based on the front page.
    • Added support for organization-specific configurations with the new organizationSlug property.
  • Bug Fixes

    • Improved layout structure for better visual consistency in the header component.
  • Documentation

    • Updated interface declarations to reflect the addition of the organizationSlug property.

@mannipje mannipje added the automerge Merge this PR as soon as all checks pass label Dec 2, 2024
@mannipje mannipje requested review from a team as code owners December 2, 2024 10:27
Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Walkthrough

The changes in this pull request involve modifications to the Header component and the StandaloneLayout component. The Header component now includes a new optional property, organizationSlug, and utilizes layout components such as Stack and Hidden for improved structure and conditional rendering of the SearchInput. The StandaloneLayout component has been updated to pass the organizationSlug to the header and navigation properties, enhancing the header's configuration without altering existing logic.

Changes

File Path Change Summary
apps/web/layouts/organization/standalone/components/Header.tsx - Added organizationSlug?: string to HeaderProps interface.
- Replaced nested <div> with Stack for layout.
- Integrated SearchInput with conditional rendering using Hidden.
apps/web/layouts/organization/standalone/standalone.tsx - Added organizationSlug: string to headerProps and navigationProps in StandaloneLayout.

Possibly related PRs

Suggested labels

high priority


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

codecov bot commented Dec 2, 2024

Codecov Report

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

Project coverage is 35.66%. Comparing base (fc0d3a8) to head (3d63408).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...outs/organization/standalone/components/Header.tsx 0.00% 12 Missing ⚠️
...web/layouts/organization/standalone/standalone.tsx 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17095      +/-   ##
==========================================
- Coverage   35.66%   35.66%   -0.01%     
==========================================
  Files        6947     6947              
  Lines      147512   147517       +5     
  Branches    41938    41942       +4     
==========================================
  Hits        52615    52615              
- Misses      94897    94902       +5     
Flag Coverage Δ
api 3.34% <ø> (ø)
api-domains-auth-admin 48.49% <ø> (ø)
api-domains-communications 39.36% <ø> (ø)
application-template-api-modules 27.78% <ø> (+<0.01%) ⬆️
cms 0.40% <ø> (ø)
cms-translations 38.69% <ø> (ø)
contentful-apps 4.73% <ø> (ø)
judicial-system-api 19.99% <ø> (ø)
judicial-system-backend 55.53% <ø> (ø)
services-user-notification 46.57% <ø> (ø)
web 2.43% <0.00%> (-0.01%) ⬇️

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

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

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 fc0d3a8...3d63408. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Dec 2, 2024

Datadog Report

All test runs 9da4227 🔗

12 Total Test Services: 0 Failed, 11 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.14%), 1 increased (+0.01%), 32 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 2.39s 1 no change Link
api-domains-auth-admin 0 0 0 18 0 10.07s 1 no change Link
api-domains-communications 0 0 0 5 0 29.07s 1 no change Link
api-domains-license-service 0 0 0 0 0 478.94ms 1 no change Link
application-system-api 0 0 0 40 0 2m 9.64s 1 no change Link
application-template-api-modules 0 0 0 118 0 2m 2.75s 1 increased (+0.01%) Link
cms-translations 0 0 0 3 0 25.8s 1 no change Link
judicial-system-api 0 0 0 61 0 5.32s 1 no change Link
judicial-system-backend 0 0 0 21037 0 17m 21.05s 1 decreased (-0.14%) Link
portals-admin-ids-admin 0 0 0 2 0 7s 1 no change Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • judicial-system-backend - jest 59.16% (-0.14%) - Details

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/layouts/organization/standalone/components/Header.tsx (1)

61-106: Consider extracting image styles to a separate constant

The image styling logic contains multiple conditional properties that could be extracted to improve readability and maintainability.

const getImageStyles = (
  imagePadding: string,
  imageObjectFit: 'contain' | 'cover',
  imageObjectPosition: 'left' | 'center' | 'right',
  imageIsFullHeight: boolean,
) => ({
  padding: imagePadding,
  objectFit: imageObjectFit,
  objectPosition: imageObjectPosition,
  height: imageIsFullHeight ? '100%' : undefined,
})
apps/web/layouts/organization/standalone/standalone.tsx (1)

70-70: Consider consistent null handling between header and navigation props

While the header props use optional chaining with fallback (??), the navigation props directly access the slug. Consider using the same pattern for consistency.

- organizationSlug: organizationPage.organization?.slug,
+ organizationSlug: organizationPage.organization?.slug ?? '',
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 71774d0 and 2a3805c.

📒 Files selected for processing (2)
  • apps/web/layouts/organization/standalone/components/Header.tsx (4 hunks)
  • apps/web/layouts/organization/standalone/standalone.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
apps/web/layouts/organization/standalone/standalone.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/organization/standalone/components/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."
🔇 Additional comments (4)
apps/web/layouts/organization/standalone/components/Header.tsx (3)

5-15: LGTM: Clean import organization

The new imports are well-organized, grouped by their source packages, and follow NextJS best practices.


33-33: LGTM: Type-safe prop addition

The optional organizationSlug property is properly typed as string, maintaining type safety.


107-118: Verify mobile-only search input implementation

The search input is correctly implemented for mobile views using the Hidden component, but we should verify the behavior across different screen sizes.

✅ Verification successful

The search results show consistent usage of the Hidden above="md" component across the codebase for mobile-specific implementations. Let me verify the search input implementation further by checking for other instances and their screen size handling.


Based on the search results, I can verify that the search input implementation is consistent with the codebase's patterns. Let me check one final aspect to ensure the desktop view is properly handled.


Search input implementation is correctly handled for both mobile and desktop views

The implementation is properly structured with:

  • Mobile view: Search input wrapped in Hidden above="md" in Header.tsx
  • Desktop view: Search input implemented in Navigation.tsx without visibility restrictions
  • Consistent props and styling across both implementations
  • Proper localization handling for placeholders
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for consistent mobile-specific implementations across the codebase

# Look for other mobile-specific Hidden component usage patterns
rg -A 3 "Hidden above=\"md\"" 

# Check for any existing search input implementations that might conflict
ast-grep --pattern 'SearchInput organization={$_}'

Length of output: 12262


Script:

#!/bin/bash
# Check for other SearchInput implementations and their screen size handling
rg -A 5 "SearchInput" 

# Look for complementary desktop-only search implementations
rg -A 3 "Hidden below=\"(lg|md)\""

Length of output: 65822


Script:

#!/bin/bash
# Check for complementary desktop search implementation in the same file
rg -A 5 "Hidden below=\"lg\"" "apps/web/layouts/organization/standalone/components/Header.tsx"

# Check for other search input implementations in the navigation
rg -A 5 "SearchInput" "apps/web/layouts/organization/standalone/components/Navigation.tsx"

Length of output: 628

apps/web/layouts/organization/standalone/standalone.tsx (1)

70-70: Verify organization slug usage across the application

Let's ensure the organization slug is consistently handled across the application, especially in search-related components.

✅ Verification successful

Organization slug usage is consistent across the application

Based on the search results, the organization slug is consistently handled across the application:

  • It's properly used in URL generation and routing via linkResolver
  • It's correctly passed to search components and filters
  • The implementation in the standalone layout matches the pattern used in other components
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify consistent organization slug handling

# Check for other instances of organization slug usage in search components
rg -A 3 "organization={" --type=typescript --type=tsx

# Look for potential missing organization slug propagation
ast-grep --pattern 'SearchInput $$$'

Length of output: 186


Script:

#!/bin/bash
# Search for organization slug usage patterns
rg "organization[.:]slug" --type=typescript --type=tsx -A 2

# Search for SearchInput component usage
rg "SearchInput" --type=typescript --type=tsx -A 2

# Look for organization prop patterns in components
rg "organization: ?{" --type=typescript --type=tsx -A 2
rg "organization={" --type=typescript --type=tsx -A 2 --no-heading

Length of output: 497


Script:

#!/bin/bash
# Search for organization slug usage patterns with proper escaping
rg "organization\.slug" .

# Search for SearchInput component usage
rg "SearchInput" .

# Look for organization prop patterns in components with proper escaping
rg "organization\s*=" .

Length of output: 23722

@kodiakhq kodiakhq bot merged commit bebcf49 into main Dec 3, 2024
70 checks passed
@kodiakhq kodiakhq bot deleted the feature/web-standalone-layout-mobile-frontpage-search branch December 3, 2024 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants