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

Exam mode: Reduce width of sidebar #9171

Merged
merged 6 commits into from
Oct 5, 2024

Conversation

rabeatwork
Copy link
Contributor

@rabeatwork rabeatwork commented Aug 2, 2024

Checklist

General

Client

  • Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data.
  • I added multiple screenshots/screencasts of my UI changes.

Motivation and Context

We aim to provide students with more horizontal space, particularly when they use split-screen during an exam.

Description

This PR removes the padding and the extra background of the sidebar.

Exam Mode Testing

(There is already an exam on TS5 called 'Reduce Sidebar Width 2' and test users 1-5 are registered to the exam.)

Prerequisites:

  • 1 Students
  • 1 Instructor
  • 1 Exam with some Exercises
  • Verify that the sidebar is smaller and the grey background is gone

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.







Review Progress

Performance Review

  • I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance
  • I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Exam Mode Test

  • Test 1
  • Test 2

Screenshots

Sidebar open before
Screenshot 2024-08-02 at 15 31 38
Sidebar open after
Screenshot 2024-08-02 at 15 31 09
Sidebar collapsed before
Screenshot 2024-08-02 at 15 31 31
Sidebar collapsed after
Screenshot 2024-08-02 at 15 30 59

Summary by CodeRabbit

  • New Features

    • Enhanced the sidebar design for a more streamlined look and improved user experience through adjusted dimensions and smoother transitions.
  • Bug Fixes

    • Addressed layout inconsistencies by modifying padding and widths for better alignment and spacing in the sidebar.
  • Style

    • Updated CSS classes to refine the sidebar's visual hierarchy and usability, ensuring a more accessible and aesthetically pleasing interface.

@rabeatwork rabeatwork requested a review from a team as a code owner August 2, 2024 13:37
@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Aug 2, 2024
Copy link

coderabbitai bot commented Aug 2, 2024

Walkthrough

The recent updates to the sidebar component focus on enhancing the user interface through refined padding and width adjustments. By reducing the sizes of both open and closed sidebar states and improving transition effects, the design aims to create a more user-friendly experience. These modifications enhance visual hierarchy and accessibility, allowing for smoother interactions and improved aesthetics.

Changes

Files Change Summary
src/.../exam-navigation-sidebar.component.html
src/.../exam-navigation-sidebar.component.scss
CSS modifications in the HTML reduce padding, contributing to a more compact layout. SCSS updates include reduced widths for open/closed states and enhanced transition properties for smoother UI interactions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Sidebar
    participant Content

    User->>Sidebar: Click to expand/collapse
    Sidebar->>Sidebar: Adjust width and padding
    Sidebar->>Content: Update layout
    Content->>User: Show updated sidebar
Loading

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 or @coderabbitai title 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.

coderabbitai[bot]
coderabbitai bot previously approved these changes Aug 2, 2024
coderabbitai[bot]
coderabbitai bot previously approved these changes Aug 2, 2024
JohannesStoehr
JohannesStoehr previously approved these changes Aug 3, 2024
Copy link
Contributor

@JohannesStoehr JohannesStoehr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code and Screenshots look good to me

coolchock
coolchock previously approved these changes Aug 5, 2024
Copy link
Contributor

@coolchock coolchock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tested on ts5, looks good 👍

Copy link
Contributor

@edkaya edkaya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good to me. Tested on TS5. Extra padding and background in sidebar is removed as described. However, I found the following minor issues:

  • if we have more than 10 questions in an exam, overview icon can not be seen fully. Besides, is it intended to place the collapse icon on the right when the sidebar is collapsed? (See screenshot 1)
  • If we shrink the window to the left, there is a horizontal and vertical scrollbar. Vertical scrollbar also blocks the status icons of questions. I think we also need to remove the horizontal scrollbar and display question and status icon next to each other in this edge case. (See screen record)

Screenshot 2024-08-05 at 17 02 16

Screen.Recording.2024-08-05.at.17.04.39.mov

Copy link

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

@github-actions github-actions bot added the stale label Aug 13, 2024
@github-actions github-actions bot closed this Aug 28, 2024
@edkaya edkaya assigned edkaya and unassigned rabeatwork Oct 4, 2024
Copy link
Contributor Author

@rabeatwork rabeatwork left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking care of this PR. I have a small remark regarding the tooltip renaming.

@edkaya edkaya requested a review from BBesrour October 4, 2024 18:18
@edkaya edkaya self-requested a review October 4, 2024 18:18
Copy link
Contributor

@edkaya edkaya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes lgtm

Copy link
Member

@krusche krusche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) ready for review small
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

6 participants