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): Generic List - Visual Changes #15195

Merged
merged 3 commits into from
Jun 11, 2024

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Jun 11, 2024

Generic List - Visual Changes

What

  • 2 column view
  • Scroll to top of list on page change
  • Show what page is active at the top of the list

Screenshots / Gifs

Before

Screen.Recording.2024-06-11.at.15.38.32.mov

After

Screen.Recording.2024-06-11.at.15.39.10.mov

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 new components: GridColumn, GridRow, and Inline for enhanced layout options.
    • Added a scrolling functionality with a new ref for smoother navigation.
  • Improvements

    • Updated pagination logic for better user experience.
    • Adjusted spacing within elements for improved visual layout.

@RunarVestmann RunarVestmann added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Jun 11, 2024
@RunarVestmann RunarVestmann requested review from a team as code owners June 11, 2024 15:39
Copy link
Contributor

coderabbitai bot commented Jun 11, 2024

Walkthrough

The recent updates to the GenericList and GenericListItem components introduce new layout components (GridColumn, GridRow, Inline), enhance scrolling functionality with a reference (ref), refine pagination logic, and adjust spacing within stack elements. These changes aim to improve the visual structure and interactivity of the list and its items.

Changes

File Path Change Summary
.../components/GenericList/GenericList.tsx Added GridColumn, GridRow, Inline components; introduced ref for scrolling; updated pagination logic.
.../screens/GenericList/GenericListItem.tsx Adjusted Stack component spacing from 0 to 1.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@datadog-island-is
Copy link

datadog-island-is bot commented Jun 11, 2024

Datadog Report

Branch report: feature/web-generic-list-item-ui-changes
Commit report: 1289b2c
Test service: api

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

Copy link

codecov bot commented Jun 11, 2024

Codecov Report

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

Project coverage is 37.01%. Comparing base (6b940d9) to head (7e40172).
Report is 3 commits behind head on main.

Current head 7e40172 differs from pull request most recent head 7c5ef7c

Please upload reports for the commit 7c5ef7c to get more accurate results.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #15195      +/-   ##
==========================================
- Coverage   37.02%   37.01%   -0.01%     
==========================================
  Files        6423     6423              
  Lines      131032   131041       +9     
  Branches    37518    37523       +5     
==========================================
  Hits        48511    48511              
- Misses      82521    82530       +9     
Flag Coverage Δ
web 1.93% <0.00%> (-0.01%) ⬇️

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

Files Coverage Δ
apps/web/screens/GenericList/GenericListItem.tsx 0.00% <ø> (ø)
apps/web/components/GenericList/GenericList.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 25f0bfb...7c5ef7c. Read the comment docs.

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: 2

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b589b1a and 7e40172.

Files selected for processing (2)
  • apps/web/components/GenericList/GenericList.tsx (7 hunks)
  • apps/web/screens/GenericList/GenericListItem.tsx (1 hunks)
Files skipped from review due to trivial changes (1)
  • apps/web/screens/GenericList/GenericListItem.tsx
Additional context used
Path-based instructions (1)
apps/web/components/GenericList/GenericList.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."
Biome
apps/web/components/GenericList/GenericList.tsx

[error] 272-287: Provide an explicit type prop for the button element. (lint/a11y/useButtonType)

The default type of a button is submit, which causes the submission of a form when placed inside a form element. This is likely not the behaviour that you want inside a React application.
Allowed button types are: submit, button or reset

Additional comments not posted (5)
apps/web/components/GenericList/GenericList.tsx (5)

12-15: Added new components GridColumn, GridRow, and Inline to support the 2-column view.

These additions align with the PR's objective to implement a 2-column view and enhance the visual layout of the Generic List component.


135-135: Introduced a ref for automatic scrolling functionality.

This change supports the PR's objective to automatically scroll to the top of the list when the page changes, enhancing user experience.


65-65: Standardized the height of list items.

Setting a consistent height for both clickable and non-clickable items improves the visual consistency of the list.

Also applies to: 96-96


200-213: Enhanced search functionality with debounced input handling.

The use of useDebounce for handling search input is a good practice in React applications, as it improves performance by limiting the rate at which a function is executed.


229-260: Implemented dynamic rendering of list items based on their type (clickable or non-clickable).

This flexible rendering approach allows the component to handle different types of list items appropriately, which is crucial for a generic list component.

@kodiakhq kodiakhq bot merged commit 2d6481c into main Jun 11, 2024
23 checks passed
@kodiakhq kodiakhq bot deleted the feature/web-generic-list-item-ui-changes branch June 11, 2024 16:05
sigruntg pushed a commit that referenced this pull request Jun 12, 2024
* 2 column view added

* Full height boc

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
lodmfjord pushed a commit that referenced this pull request Jun 14, 2024
* 2 column view added

* Full height boc

---------

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants