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

Communication: Correctly aligned manage button in communications menu #9636

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

badkeyy
Copy link

@badkeyy badkeyy commented Oct 29, 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 (e.g. using paging).
  • I strictly followed the principle of data economy for all client-server REST calls.
  • I strictly followed the client coding and design guidelines.
  • Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
  • I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
  • I added authorities to all new routes and checked the course groups for displaying navigation elements (links, buttons).
  • I documented the TypeScript code using JSDoc style.
  • I added multiple screenshots/screencasts of my UI changes.
  • I translated all newly inserted strings into English and German.

Motivation and Context

There was a alignment issue with the manage button on the course communication page.
See #9633

Description

I changed the button class d-sm-inline to d-sm-block in order to apply the display: block attribute instead of the display: inline attribute for screen sizes > 576px. This fixes the issue.

Steps for Testing

Prerequisites:

  • 1 Instructor
  • 1 Course
  1. Log in to Artemis
  2. Navigate to the Course page of your example course
  3. Open up the "Communication" tab
  4. Find the "Manage" button to be correctly aligned

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 even for very large courses with more than 2000 students.
  • I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Exam Mode Test

  • Test 1
  • Test 2

Performance Tests

  • Test 1
  • Test 2

Screenshots

image

Summary by CodeRabbit

  • New Features

    • Enhanced sidebar functionality with conditional rendering based on course state.
    • Improved visibility and styling of course action buttons based on screen size.
    • Simplified layout for LTI users without the sidebar while maintaining core functionality.
  • Bug Fixes

    • Adjusted rendering logic for course images and navigation items to ensure proper display.

@badkeyy badkeyy requested a review from a team as a code owner October 29, 2024 22:03
@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Oct 29, 2024
@badkeyy badkeyy changed the title Correctly aligned manage button in communications menu Communication: Correctly aligned manage button in communications menu Oct 29, 2024
Copy link

coderabbitai bot commented Oct 29, 2024

Walkthrough

The pull request modifies the HTML template of the course-overview.component.html file, focusing on conditional rendering based on the isLti variable. When isLti is false, a sidebar is displayed with various elements, and its visibility is controlled by several boolean flags. Adjustments have been made to the button visibility classes and the rendering logic for course action items. When isLti is true, a simplified layout is shown without the sidebar. Overall, the changes enhance the component's UI adaptability based on application state.

Changes

File Path Change Summary
src/main/webapp/app/overview/course-overview.component.html Modifications for conditional rendering based on isLti, adjustments to sidebar visibility and button classes, and updates to course action item rendering.

Possibly related PRs

Suggested labels

client, user interface, small, bugfix, ready to merge, component:Communication

Suggested reviewers

  • florian-glombik
  • JohannesStoehr
  • Jan-Thurner
  • rabeatwork
  • edkaya

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7503f9c and 2328f29.

📒 Files selected for processing (1)
  • src/main/webapp/app/overview/course-overview.component.html (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
src/main/webapp/app/overview/course-overview.component.html (1)

Pattern src/main/webapp/**/*.html: @if and @for are new and valid Angular syntax replacing *ngIf and *ngFor. They should always be used over the old style.

🔇 Additional comments (2)
src/main/webapp/app/overview/course-overview.component.html (2)

171-171: LGTM: Button alignment fix looks correct.

The change from d-sm-inline to d-sm-block for the manage button when pageTitle === 'communication' will correctly align the button by making it a block-level element on small screens and above (≥576px). This addresses the alignment issue mentioned in issue #9633.


Line range hint 1-1: Great job using the new Angular syntax.

The template consistently uses the new @if and @for syntax instead of the older *ngIf and *ngFor directives, which aligns with the coding guidelines.

Also applies to: 32-32, 171-171, 234-234, 267-267


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.

@badkeyy badkeyy changed the title Communication: Correctly aligned manage button in communications menu Communication: Correctly aligned manage button in communications menu Oct 29, 2024
Copy link
Contributor

@JohannesWt JohannesWt left a comment

Choose a reason for hiding this comment

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

Code

Copy link
Contributor

@pzdr7 pzdr7 left a comment

Choose a reason for hiding this comment

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

Code

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!)
Projects
Status: Work In Progress
Development

Successfully merging this pull request may close these issues.

UI: (minor issue) Manage button in Communication tab is slightly misplaced
5 participants