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

FIxes the container width on Collapse of sidebar #3010

Closed

Conversation

CHIRANTH-24
Copy link
Contributor

@CHIRANTH-24 CHIRANTH-24 commented Dec 28, 2024

What kind of change does this PR introduce?

Bugfix

Issue Number:

Fixes #2994

Did you add tests for your changes?

Yes,
This is my first time writing Unit Test

Snapshots/Videos:

Solution.mp4

If relevant, did you update the documentation?

Summary

This PR improves the sidebar's interactivity by dynamically changing the container's className based on the hideDrawer state. It allows the sidebar to expand or collapse when the menu button is clicked, enhancing user experience.

Does this PR introduce a breaking change?

No

Other information

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • New Features
    • Enhanced chat interface with dynamic styling for drawer visibility.
  • Tests
    • Added comprehensive test cases for chat component's class name changes.
  • Style
    • Implemented conditional CSS classes for improved user interface responsiveness.

Copy link
Contributor

coderabbitai bot commented Dec 28, 2024

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits

Reviewing files that changed from the base of the PR and between 44e7efb and 3b0d17c.

📒 Files selected for processing (2)
  • src/screens/UserPortal/Chat/Chat.test.tsx (2 hunks)
  • src/screens/UserPortal/Chat/Chat.tsx (1 hunks)
 _____________________________________________________________________________________________________________________________________
< Prototype to learn. Prototyping is a learning experience. Its value lies not in the code you produce, but in the lessons you learn. >
 -------------------------------------------------------------------------------------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ

Walkthrough

The pull request introduces changes to the Chat component's styling and testing in the user portal. The modifications focus on dynamically adjusting the main chat container's classes based on the sidebar's visibility state. A new test case is added to verify the class name changes, ensuring that the chat interface responds correctly when the drawer is opened or closed.

Changes

File Change Summary
src/screens/UserPortal/Chat/Chat.tsx Added conditional class application for styles.expand and styles.contract based on hideDrawer state
src/screens/UserPortal/Chat/Chat.test.tsx Added import for CSS modules and new test case to verify dynamic class name changes

Sequence Diagram

sequenceDiagram
    participant User
    participant ChatComponent
    participant Sidebar
    User->>Sidebar: Click to collapse/expand
    Sidebar->>ChatComponent: Update hideDrawer state
    ChatComponent->>ChatComponent: Apply dynamic classes
    ChatComponent->>UI: Render with expanded/contracted layout
Loading

Assessment against linked issues

Objective Addressed Explanation
Main container expansion on sidebar collapse [#2994]

Suggested reviewers

  • palisadoes
  • AVtheking

Poem

🐰 A rabbit's tale of code so bright,
Expanding chat with pure delight!
Classes dance, the sidebar sways,
Responsive design wins the days!
Hop, hop, hooray for UI's might! 🎉

Tip

You can make CodeRabbit's review more strict using the `assertive` profile, if that's what you prefer.

Change the reviews.profile setting in your project's settings in CodeRabbit to assertive to make CodeRabbit's nitpick more issues in your PRs.


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

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

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 (3)
src/screens/UserPortal/Chat/Chat.tsx (1)

155-164: Consider refactoring the nested ternary expression and addressing indentation.

While the dynamic class application is correct, the nested ternary can reduce readability. Using a more descriptive helper function or separate conditional checks could make the code clearer. Additionally, static analysis warns about inconsistent indentation at line 162. Please ensure that indentation is consistent to satisfy style guidelines.

155     <div
156       className={`d-flex flex-row ${styles.containerHeight} ${
157         hideDrawer === null
158           ? ''
159           : hideDrawer
160             ? styles.expand
161             : styles.contract
162         }`}
163       data-testid="conditional-rendering"
164     >
+// Example alternative for readability:
+// const containerClass = () => {
+//   if (hideDrawer === null) return '';
+//   return hideDrawer ? styles.expand : styles.contract;
+// };
+//
+// <div
+//   className={`d-flex flex-row ${styles.containerHeight} ${containerClass()}`}
+//   data-testid="conditional-rendering"
+// >
🧰 Tools
🪛 eslint

[error] 162-162: Delete ··

(prettier/prettier)

src/screens/UserPortal/Chat/Chat.test.tsx (2)

1696-1696: Remove unnecessary whitespace.

Static analysis flags an unexpected indentation at line 1696. This extra spacing should be removed to maintain code consistency.

🧰 Tools
🪛 eslint

[error] 1696-1696: Delete ··

(prettier/prettier)


1754-1755: Remove trailing blank line.

Static analysis suggests removing the extra blank line to adhere to the project's style guidelines and keep the file tidy.

🧰 Tools
🪛 eslint

[error] 1754-1755: Delete

(prettier/prettier)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b465221 and 44e7efb.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (2)
  • src/screens/UserPortal/Chat/Chat.test.tsx (2 hunks)
  • src/screens/UserPortal/Chat/Chat.tsx (1 hunks)
🧰 Additional context used
🪛 eslint
src/screens/UserPortal/Chat/Chat.tsx

[error] 162-162: Delete ··

(prettier/prettier)

src/screens/UserPortal/Chat/Chat.test.tsx

[error] 1696-1696: Delete ··

(prettier/prettier)


[error] 1754-1755: Delete

(prettier/prettier)

🔇 Additional comments (1)
src/screens/UserPortal/Chat/Chat.test.tsx (1)

1697-1754: Good test coverage for class name changes.

This test verifies that the container's classes are updated as expected when the drawer is toggled. The step-by-step interactions ensure accurate validation of both styles.expand and styles.contract. The code is well-structured and easy to follow.

coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 28, 2024
@CHIRANTH-24
Copy link
Contributor Author

@palisadoes could you please let me know what changes should i make?

@palisadoes
Copy link
Contributor

Please submit your PRs against our develop-postgres branch. This is a temporary requirement as we prepare to migrate our API backend to Postgres.

Also if applicable, make sure your branch name is different from develop-postgres when resubmitting.

Closing.

@palisadoes palisadoes closed this Dec 28, 2024
@CHIRANTH-24 CHIRANTH-24 deleted the Chiranth2 branch December 29, 2024 06:52
@CHIRANTH-24 CHIRANTH-24 restored the Chiranth2 branch December 29, 2024 06:57
@CHIRANTH-24 CHIRANTH-24 deleted the Chiranth2 branch December 29, 2024 07:06
@CHIRANTH-24
Copy link
Contributor Author

@palisadoes im not able to "chat" in develop-postgres.
From which branch should i checkout my new branch?

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