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(web): grant filter ui #17871

Merged
merged 1 commit into from
Feb 7, 2025
Merged

fix(web): grant filter ui #17871

merged 1 commit into from
Feb 7, 2025

Conversation

thorkellmani
Copy link
Member

@thorkellmani thorkellmani commented Feb 7, 2025

What

  • Mobile look updated to reflect starfatorg more

Screenshots / Gifs

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

  • Style
    • Revised the layout of the search results page for improved clarity by repositioning the search message and adjusting spacing.
    • Enhanced the mobile filter presentation with an updated display style.
    • Refined the clear filter text to offer a more concise and general message for resetting filters.

@thorkellmani thorkellmani requested a review from a team as a code owner February 7, 2025 10:11
Copy link
Contributor

coderabbitai bot commented Feb 7, 2025

Walkthrough

The updates adjust the visual layout of the Grants search results page. In the SearchResults.tsx file, an existing Box component displaying the hits message is removed and replaced with a new Box (with updated margin properties) placed below the search filter. Additionally, the variant prop of the GrantsSearchResultsFilter is changed from 'default' to 'dialog' for mobile layouts. In the SearchResultsFilter.tsx file, the label for clearing filters is updated from a category-specific message to a general one. No changes were made to functional logic or public APIs.

Changes

File(s) Change Summary
apps/web/screens/Grants/SearchResults/SearchResults.tsx Removed an existing Box component showing the hits message; added a new Box component (with marginY={3}) below the GrantsSearchResultsFilter; updated the variant prop for the GrantsSearchResultsFilter from 'default' to 'dialog' for mobile layouts.
apps/web/screens/Grants/SearchResults/SearchResultsFilter.tsx Updated the clear filter label from formatMessage(m.search.clearFilterCategory) to formatMessage(m.search.clearFilters) to display a more general clear filters message.

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • RunarVestmann
  • disaerna

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

nx-cloud bot commented Feb 7, 2025

View your CI Pipeline Execution ↗ for commit 263265d.

Command Status Duration Result
nx run-many --target=build --projects=web --par... ✅ Succeeded 17m 12s View ↗
nx run-many --target=lint --projects=web --para... ✅ Succeeded 1m 2s View ↗
nx run-many --projects web --target test --para... ✅ Succeeded 23s View ↗
nx run-many --target=codegen/frontend-client --... ✅ Succeeded 12s View ↗
nx run-many --target=codegen/backend-schema --a... ✅ Succeeded 22s View ↗

☁️ Nx Cloud last updated this comment at 2025-02-07 10:34:43 UTC

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

🧹 Nitpick comments (2)
apps/web/screens/Grants/SearchResults/SearchResults.tsx (2)

338-396: Consider extracting mobile view into a separate component.

The mobile view logic is quite large and could be extracted into a separate component to improve maintainability and readability.

Example refactor:

+ const MobileSearchResults = ({
+   query,
+   setQuery,
+   categories,
+   types,
+   organizations,
+   status,
+   onSearchFilterUpdate,
+   onResetFilter,
+   tags,
+   currentUrl,
+   totalHits,
+   hitsMessage,
+   grants,
+   locale,
+   totalPages,
+   setPage,
+ }) => (
+   <Box padding={[1, 1, 2]} margin={[1, 1, 2]} paddingBottom={3}>
+     {/* ... mobile view JSX ... */}
+   </Box>
+ )

  return (
    <GrantWrapper>
      {/* ... */}
      <Box background="blue100">
        {!isMobile && (
          <SidebarLayout>
            {/* ... desktop view ... */}
          </SidebarLayout>
        )}
-       {isMobile && (
-         <Box padding={[1, 1, 2]} margin={[1, 1, 2]} paddingBottom={3}>
-           {/* ... mobile view ... */}
-         </Box>
-       )}
+       {isMobile && (
+         <MobileSearchResults
+           query={query}
+           setQuery={setQuery}
+           categories={categories}
+           types={types}
+           organizations={organizations}
+           status={status}
+           onSearchFilterUpdate={onSearchFilterUpdate}
+           onResetFilter={onResetFilter}
+           tags={tags}
+           currentUrl={currentUrl}
+           totalHits={totalHits}
+           hitsMessage={hitsMessage}
+           grants={grants}
+           locale={locale}
+           totalPages={totalPages}
+           setPage={setPage}
+         />
+       )}
      </Box>
    </GrantWrapper>
  )

96-99: Consider using TypeScript's satisfies operator for better type safety.

The GraphQL query variables could benefit from using the satisfies operator to ensure type safety while maintaining type inference.

Example:

- getGrants({
-   variables: {
+ const variables = {
      input: {
        categories: categories ? [...categories] : null,
        lang: locale,
        organizations: organizations ? [...organizations] : null,
        page,
        search: searchString,
        size: PAGE_SIZE,
        types: types ? [...types] : null,
        status: status
          ? status === 'closed'
            ? GetGrantsInputAvailabilityStatusEnum.Closed
            : GetGrantsInputAvailabilityStatusEnum.Open
          : undefined,
      },
-   },
- })
+ } satisfies { input: QueryGetGrantsArgs['input'] }
+ getGrants({ variables })

Also applies to: 113-130

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cf2cea5 and 263265d.

📒 Files selected for processing (2)
  • apps/web/screens/Grants/SearchResults/SearchResults.tsx (2 hunks)
  • apps/web/screens/Grants/SearchResults/SearchResultsFilter.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • apps/web/screens/Grants/SearchResults/SearchResultsFilter.tsx
🧰 Additional context used
📓 Path-based instructions (1)
`apps/**/*`: "Confirm that the code adheres to the following...

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/screens/Grants/SearchResults/SearchResults.tsx
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: tests (web)
  • GitHub Check: linting (web)
  • GitHub Check: build (web)
  • GitHub Check: formatting
  • GitHub Check: linting-workspace
🔇 Additional comments (1)
apps/web/screens/Grants/SearchResults/SearchResults.tsx (1)

354-372: LGTM! Mobile UI improvements look good.

The changes improve the mobile layout by:

  • Adding consistent vertical spacing with marginY
  • Using dialog variant for better mobile interaction
  • Moving the hits message below the filter for better visual hierarchy

@thorkellmani thorkellmani added this pull request to the merge queue Feb 7, 2025
Merged via the queue into main with commit 9e684cb Feb 7, 2025
38 checks passed
@thorkellmani thorkellmani deleted the fix/weird-ui-on-filter branch February 7, 2025 10:59
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.

2 participants